Queue a distribution run
/distribution/queueQueues a distribution run for the linked user. Provide exactly one
of collectionRef or resourceRefs:
collectionRef— distribute an existing collection (project). The collection must be visible to the linked user.resourceRefs— distribute an ad-hoc set of resources. A collection is created to hold them (the queue distributes collections), then queued. Resources the linked user cannot see are dropped; if none remain, the call returns 404.
Not-found and no-access both collapse to 404 so the surface can't
be used to probe refs in other usergroups. Requires the write scope
and the linked user's dm (distribution management) permission.
Idempotency
Pass an Idempotency-Key header (a unique random string per logical
queue, e.g. a UUID) to make retries safe. The first successful response
with a given key is cached for 24 hours; replays return the same body
byte-for-byte with Idempotent-Replayed: true. Reusing the key with a
different request body returns 422 IDEMPOTENCY_KEY_CONFLICT.
Authorization
apiKey Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.
In: header
Header Parameters
Optional client-supplied retry key. 1–255 printable-ASCII characters. Use a UUID or other high-entropy random string.
^[\x21-\x7E]+$length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/distribution/queue" \ -H "Content-Type: application/json" \ -d '{ "destinationRef": 7, "collectionRef": 300 }'{ "success": true, "status": "success", "message": "Distribution run queued", "data": { "queueRef": 555, "status": 0, "statusLabel": "pending", "destinationRef": 7 }}{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}{ "success": false, "status": "fail", "message": "API key is required", "error": { "code": "NO_API_KEY", "message": "API key is required" }}{ "success": false, "status": "fail", "message": "This API key does not have the 'write' scope", "error": { "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the 'write' scope" }}{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}List recent distribution runs GET
The linked user's recent distribution runs, most recent first, scoped to their usergroup (a run is visible when the user can read the collection it distributes). Requires the `read` scope and distribution access (`dm` or `dv`).
Download the resource's original file GET
Streams the resource's original file as raw bytes with the correct `Content-Type` and a `Content-Disposition: attachment` filename taken from the resource's stored filename. Requires the **read** scope. Supports HTTP `Range` requests for resumable downloads (responds `206 Partial Content`). Access follows the internal download rules: confidential resources are denied, and restricted-access users cannot download originals (`403 DOWNLOAD_NOT_ALLOWED`).