FruxonDocs
ApiCollection pipelines

Starts a run of the pipeline.

Fans out one isolated agent run per source item and returns the created run (its per-item runs then execute asynchronously). A dry-run preview (`origin = TEST`) processes only the first N items so the per-item agent can be tuned before committing to the full set.

POST
/v1/tenants/{tenant}/collectionPipelines/{collectionPipeline}:run

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

collectionPipeline*string

The unique identifier of the pipeline to run.

Formatuuid
tenant*string

The tenant identifier

Request Body

Run options (origin, optional item limit).

origin?string

Whether a run is a real production run or a dry-run preview over the first N items (the §8.1 authoring loop). Test runs may still surface results in the monitor but are marked a preview.

Value in"UNSPECIFIED" | "PRODUCTION" | "TEST" | "SCHEDULE"
itemLimit?integer|null

Optional cap on items for this run, combined with the policy's max-items. For a dry-run with no explicit limit the preview default applies.

Formatint32
sourceId?string|null

Optional reusable source to run. Must be present in the pipeline's source refs. Omit to use the pipeline's default source, or the legacy embedded source when no reusable refs are configured.

Formatuuid
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/collectionPipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08:run" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "createdAt": 0,
  "modifiedAt": 0,
  "pipelineId": "00000000-0000-0000-0000-000000000000",
  "networkId": "00000000-0000-0000-0000-000000000000",
  "sourceId": "00000000-0000-0000-0000-000000000000",
  "pipelineRevisionId": "00000000-0000-0000-0000-000000000000",
  "status": "FETCHING",
  "origin": "PRODUCTION",
  "itemsTotal": 0,
  "itemsSucceeded": 0,
  "itemsFailed": 0,
  "itemsSkipped": 0,
  "startedAt": 0,
  "endedAt": 0,
  "budgetSpent": 0,
  "rootExecutionId": "00000000-0000-0000-0000-000000000000",
  "completionAsyncOperationId": "00000000-0000-0000-0000-000000000000",
  "completionCallbackDispatchedAt": 0,
  "effectivePolicy": {
    "maxItems": 0,
    "maxConcurrency": 0,
    "perRunBudgetCap": 0,
    "dedupKeyPath": "string",
    "onItemError": "CONTINUE",
    "actionTypeCeiling": "READ_ONLY"
  },
  "sinkDestinationOverride": {
    "indexAssetId": "string",
    "tabularTarget": null,
    "hasAny": true
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}