POST /api/v1/runs

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Launch Run

validate, create a queued run, stage the fixture, enqueue the job.

Auth: Authorization: Bearer <token> required

Request

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/runs" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"allow_regenerate":false,"entity":"generated_articles","guid":31567,"mode":"live","params":{},"pipeline_id":"generate"}'

Response `201`

{
  "createtime": "2026-09-03T02:14:04Z",
  "current_step": "make_article_structure",
  "entity_guid": 31567,
  "entity_name": "generated_articles",
  "guid": 1842,
  "metrics": {
    "llm_calls": 11
  },
  "mode": "live",
  "pipeline_id": "generate",
  "started_at": "2026-09-03T02:14:05Z",
  "started_by": "agent@entherium.dev",
  "status": "running",
  "steps_done": 7,
  "steps_total": 18,
  "trigger": "api",
  "updatetime": "2026-09-03T02:19:40Z"
}

Returns

PipelineRunRead — Successful Response

Field	Type	Description
`createtime`	`string`
`current_step`	`string \| null` (opt.)
`entity_guid`	`integer`
`entity_name`	`string`
`error`	`string \| null` (opt.)
`error_step`	`string \| null` (opt.)
`finished_at`	`string \| null` (opt.)
`guid`	`integer`
`metrics`	`object` (opt.)
`mode`	`string`
`pipeline_id`	`string`
`started_at`	`string \| null` (opt.)
`started_by`	`string \| null` (opt.)
`status`	`string`
`steps_done`	`integer`
`steps_total`	`integer`
`trigger`	`string`
`updatetime`	`string`

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
`Idempotency-Key`	header	no	`string`	—	uuid	Optional.

Request body

Field	Type	Required
`allow_regenerate`	`boolean`	no
`entity`	`string`	yes
`guid`	`integer`	yes
`mode`	`"live" \| "mock" \| "replay"`	no
`params`	`object`	no
`pipeline_id`	`string`	yes
`pipeline_variant`	`string \| null`	no
`pipeline_version`	`string \| null`	no
`steps`	`array of string \| null`	no

Example:

{
  "allow_regenerate": false,
  "entity": "generated_articles",
  "guid": 31567,
  "mode": "live",
  "params": {},
  "pipeline_id": "generate"
}

Errors

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`409`	The record already generated successfully and allow_regenerate is false, or the entity is locked	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`
`429`	Agent token: the concurrent-run cap for this token is reached	`ErrorResponse`

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.