Videos · API · Axiom Lab

List Videos

GET/v1/videos

API key requiredSuccess 200

Parameters

Name	Type	Description
`limit`query	integer	Default `50`; range 1–200
`cursor`query	string	length ≤ 256; nullable
`after`query	string	length ≤ 256; nullable
`status`query	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`; nullable
`batch_id`query	string	length ≤ 32; nullable
`created_after`query	number	range ≥ 0; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`data`required	array<object>
`data[].id`required	string
`data[].project_id`required	string	nullable
`data[].batch_id`	string	nullable
`data[].parent_id`	string	nullable
`data[].status`required	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`
`data[].stage`required	string	nullable
`data[].progress`required	integer	nullable
`data[].error`	string	nullable
`data[].created_at`required	number	nullable
`data[].updated_at`	number	nullable
`data[].started_at`	number	nullable
`data[].finished_at`	number	nullable
`data[].deleted_at`	number	nullable
`data[].waited_s`	number	`GET /v1/videos/{id}` only: seconds the video waited for its length to be confirmed, null until it is confirmed; its working time is `(finished_at or now) - created_at - waited_s`; nullable
`data[].recovery`required	object
`data[].recovery.attempt`required	integer
`data[].recovery.max_attempts`required	integer
`data[].recovery.retry_at`	number	nullable
`data[].result`	object	nullable
`data[].result.files`	map<string, string>	Signed download links; present on GET once complete/rejected; nullable
`data[].result.duration`	number	nullable
`data[].result.shot_count`	integer	nullable
`data[].result.visual_mix`	any
`data[].result.qa`	any
`data[].result.brief`	any
`data[].result.workflow`	string	nullable
`data[].result.routing`	any
`data[].result.input_required`	object	Why the job is `needs_input`: `code`, `actor`, `message` and what to send to /resume. A spending stop has `code: budget_approval` and carries no amounts. With `approvable: true` answer it with `POST /v1/videos/{id}/resume {"approve_budget": true}`; with `approvable: false` (`actor: operator`, prepaid flat-priced jobs) it is an internal review: nothing to approve, the price does not change; nullable
`data[].result.native_project`	any
`data[].requested_workflow`required	string
`data[].video_type`	string	The video type within the workflow, e.g. `project`, when the request set one; nullable
`data[].style`	string	The style the request chose (`options.style`, see `GET /v1/styles`); null: the default style; nullable
`data[].title`	string	A short name for lists: the subject named in the brief (e.g. the project name) or the start of the prompt; nullable
`data[].profile_draft`	string	profile_card: the confirmed 行家访谈 draft this film was made from (the web app offers a retry); nullable
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; nullable
`has_more`	boolean	Default `false`

Example

curl "https://axiomlab.online/v1/videos" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Create Video

POST/v1/videos

API key requiredSuccess 202

Parameters

Name	Type	Description
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`prompt`	string	length ≤ 4000
`assets`	array<string>	up to 30 items
`options`	object
`options.workflow`	string	One of: `auto` `explainer` `short_drama` `creative_video` `motion_explainer` `profile_card` `product_pitch`; Default `explainer`
`options.goal`	string	length ≤ 2000
`options.audience`	string	length ≤ 1000
`options.duration_max`	integer	Planned length in seconds, checked against the workflow's range, whose lower bound depends on the workflow (`GET /v1/workflows`: 30–180 for most, profile_card 30–90). It does not cap the film: its length is confirmed after the materials are analysed (`needs_input` with `confirm_duration`); Default `60`; range 5–180
`options.width`	integer	With `height`, the aspect ratio: 1920×1080 (16:9); profile_card 1080×1920 (9:16); Default `1920`; range 640–3840
`options.height`	integer	Default `1080`; range 360–2160
`options.fps`	integer	Default `30`; range 24–60
`options.subtitles`	boolean	Subtitle preference, applied by profile_card only; other films usually come with subtitles burned in; Default `false`
`options.music`	boolean	Background music preference, applied by profile_card only; Default `true`
`options.skill_id`	string	length ≤ 200; nullable
`options.credit_budget`	integer	range 1–1000000; nullable
`options.video_type`	string	One of: `project` `product` `personal` `corporate` `name_card`; nullable
`options.content_data`	map<string, string>
`options.style_preset`	string	One of: `cinematic_realism` `clean_3d` `product_studio`; Default `cinematic_realism`
`options.brand`	object
`options.profile`	object
`options.motion_style`	string	One of: `mono` `photo`; Default `mono`
`options.photo_subject`	string	length ≤ 120
`options.photo_license`	string	One of: `strict` `sharealike`; Default `strict`
`options.style`	string	A style id from `GET /v1/styles`; for `video_type` product one of the 15-second TVC looks `cinematic`, `tech`, `lifestyle`; unset uses the default style; nullable
`options.language`	string	The film's language when the request has no text of its own; unset: Chinese; One of: `zh` `en`; nullable
`options.founder`	object	企业家名片: name, company, titles, facts (0–12; a card counts as two), photos[{asset, role, caption}], template (ink \| grid \| renwu), consent, optional industry and name_pinyin; required with video_type name_card. Length is 30–90 seconds, set from the material; nullable
`options.founder.name`required	string	length 2–12
`options.founder.company`required	string	length 2–40
`options.founder.titles`required	array<string>	up to 3 items
`options.founder.facts`	array<object>	up to 12 items
`options.founder.photos`required	array<object>	up to 12 items
`options.founder.template`	string	One of: `ink` `grid` `renwu`; Default `ink`
`options.founder.education`	array<string>	up to 3 items
`options.founder.honors`	array<string>	up to 6 items
`options.founder.motto`	string	the closing line; the customer's own words; length ≤ 40
`options.founder.contact`	string	shown on the end card only when given; length ≤ 60
`options.founder.industry`	string	行业 / 主营，如智慧农业；framing lines and illustrative scenes may rest on it; length ≤ 20
`options.founder.name_pinyin`	string	optional pronunciation, e.g. shěn jì bái; written into the narration prompt; length ≤ 48
`options.founder.brand_color`	string	#RRGGBB accent for the grid template
`options.founder.consent`	boolean	the customer holds the rights to these photos and the facts are true; Default `false`
`webhook_url`	string	length ≤ 2000; nullable
`plan_id`	string	nullable
`template_id`	string	nullable
`brand_id`	string	nullable
`variables`	map<string, string>

Response 202 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`batch_id`	string	nullable
`parent_id`	string	nullable
`status`required	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`
`stage`required	string	nullable
`progress`required	integer	nullable
`error`	string	nullable
`created_at`required	number	nullable
`updated_at`	number	nullable
`started_at`	number	nullable
`finished_at`	number	nullable
`deleted_at`	number	nullable
`waited_s`	number	`GET /v1/videos/{id}` only: seconds the video waited for its length to be confirmed, null until it is confirmed; its working time is `(finished_at or now) - created_at - waited_s`; nullable
`recovery`required	object
`recovery.attempt`required	integer
`recovery.max_attempts`required	integer
`recovery.retry_at`	number	nullable
`result`	object	nullable
`result.files`	map<string, string>	Signed download links; present on GET once complete/rejected; nullable
`result.duration`	number	nullable
`result.shot_count`	integer	nullable
`result.visual_mix`	any
`result.qa`	any
`result.brief`	any
`result.workflow`	string	nullable
`result.routing`	any
`result.input_required`	object	Why the job is `needs_input`: `code`, `actor`, `message` and what to send to /resume. A spending stop has `code: budget_approval` and carries no amounts. With `approvable: true` answer it with `POST /v1/videos/{id}/resume {"approve_budget": true}`; with `approvable: false` (`actor: operator`, prepaid flat-priced jobs) it is an internal review: nothing to approve, the price does not change; nullable
`result.native_project`	any
`requested_workflow`required	string
`video_type`	string	The video type within the workflow, e.g. `project`, when the request set one; nullable
`style`	string	The style the request chose (`options.style`, see `GET /v1/styles`); null: the default style; nullable
`title`	string	A short name for lists: the subject named in the brief (e.g. the project name) or the start of the prompt; nullable
`profile_draft`	string	profile_card: the confirmed 行家访谈 draft this film was made from (the web app offers a retry); nullable
`webhook_signing_secret`	string	Only present when the request set `webhook_url`: the project secret that signs that per-job callback (`Vidgen-Signature`). Store it; verify deliveries with it; nullable

Example

curl -X POST "https://axiomlab.online/v1/videos" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "<prompt>", "assets": ["<asset id>"]}'

Resume

POST/v1/videos/{job_id}/resume

API key requiredSuccess 202

Parameters

Name	Type	Description
`job_id`requiredpath	string
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`message`	string	Not accepted (422): use `POST /v1/videos/{id}/revisions` or a new plan for changed requirements or materials; length ≤ 4000
`questionnaire_id`	string	Not accepted (422): use `POST /v1/videos/{id}/revisions` or a new plan for changed requirements or materials; length ≤ 200; nullable
`answers`	array<object>	Not accepted (422): use `POST /v1/videos/{id}/revisions` or a new plan for changed requirements or materials; up to 30 items
`assets`	array<string>	Not accepted (422): use `POST /v1/videos/{id}/revisions` or a new plan for changed requirements or materials; up to 9 items
`approve_budget`	boolean	Approve a pending budget stop that has `approvable: true`; the server computes the new limit; Default `false`
`credit_budget`	integer	Legacy, no longer used: no job stops for a credit budget (sending it answers 422); range 1–1000000; nullable
`budget_usd`	number	Legacy: explicit new total USD limit for a budget stop; range 0–100000; nullable
`duration_sec`	integer	Answer to a `confirm_duration` stop: the film length in seconds, within the stop's `min_duration_sec`–`max_duration_sec` (its `suggested_duration_sec` unless the customer changes it); nullable

Response 202 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`batch_id`	string	nullable
`parent_id`	string	nullable
`status`required	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`
`stage`required	string	nullable
`progress`required	integer	nullable
`error`	string	nullable
`created_at`required	number	nullable
`updated_at`	number	nullable
`started_at`	number	nullable
`finished_at`	number	nullable
`deleted_at`	number	nullable
`waited_s`	number	`GET /v1/videos/{id}` only: seconds the video waited for its length to be confirmed, null until it is confirmed; its working time is `(finished_at or now) - created_at - waited_s`; nullable
`recovery`required	object
`recovery.attempt`required	integer
`recovery.max_attempts`required	integer
`recovery.retry_at`	number	nullable
`result`	object	nullable
`result.files`	map<string, string>	Signed download links; present on GET once complete/rejected; nullable
`result.duration`	number	nullable
`result.shot_count`	integer	nullable
`result.visual_mix`	any
`result.qa`	any
`result.brief`	any
`result.workflow`	string	nullable
`result.routing`	any
`result.input_required`	object	Why the job is `needs_input`: `code`, `actor`, `message` and what to send to /resume. A spending stop has `code: budget_approval` and carries no amounts. With `approvable: true` answer it with `POST /v1/videos/{id}/resume {"approve_budget": true}`; with `approvable: false` (`actor: operator`, prepaid flat-priced jobs) it is an internal review: nothing to approve, the price does not change; nullable
`result.native_project`	any
`requested_workflow`required	string
`video_type`	string	The video type within the workflow, e.g. `project`, when the request set one; nullable
`style`	string	The style the request chose (`options.style`, see `GET /v1/styles`); null: the default style; nullable
`title`	string	A short name for lists: the subject named in the brief (e.g. the project name) or the start of the prompt; nullable
`profile_draft`	string	profile_card: the confirmed 行家访谈 draft this film was made from (the web app offers a retry); nullable

Example

curl -X POST "https://axiomlab.online/v1/videos/<job_id>/resume" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"duration_sec": 60}'

Revise Video

POST/v1/videos/{job_id}/revisions

API key requiredSuccess 202

Parameters

Name	Type	Description
`job_id`requiredpath	string
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`prompt`	string	length 10–4000; nullable
`assets`	array<string>	up to 30 items; nullable
`options`	object
`options.workflow`	string	One of: `auto` `explainer` `short_drama` `creative_video` `motion_explainer` `profile_card` `product_pitch`; Default `explainer`
`options.goal`	string	length ≤ 2000
`options.audience`	string	length ≤ 1000
`options.duration_max`	integer	Planned length in seconds, checked against the workflow's range, whose lower bound depends on the workflow (`GET /v1/workflows`: 30–180 for most, profile_card 30–90). It does not cap the film: its length is confirmed after the materials are analysed (`needs_input` with `confirm_duration`); Default `60`; range 5–180
`options.width`	integer	With `height`, the aspect ratio: 1920×1080 (16:9); profile_card 1080×1920 (9:16); Default `1920`; range 640–3840
`options.height`	integer	Default `1080`; range 360–2160
`options.fps`	integer	Default `30`; range 24–60
`options.subtitles`	boolean	Subtitle preference, applied by profile_card only; other films usually come with subtitles burned in; Default `false`
`options.music`	boolean	Background music preference, applied by profile_card only; Default `true`
`options.skill_id`	string	length ≤ 200; nullable
`options.credit_budget`	integer	range 1–1000000; nullable
`options.video_type`	string	One of: `project` `product` `personal` `corporate` `name_card`; nullable
`options.content_data`	map<string, string>
`options.style_preset`	string	One of: `cinematic_realism` `clean_3d` `product_studio`; Default `cinematic_realism`
`options.brand`	object
`options.profile`	object
`options.motion_style`	string	One of: `mono` `photo`; Default `mono`
`options.photo_subject`	string	length ≤ 120
`options.photo_license`	string	One of: `strict` `sharealike`; Default `strict`
`options.style`	string	A style id from `GET /v1/styles`; for `video_type` product one of the 15-second TVC looks `cinematic`, `tech`, `lifestyle`; unset uses the default style; nullable
`options.language`	string	The film's language when the request has no text of its own; unset: Chinese; One of: `zh` `en`; nullable
`options.founder`	object	企业家名片: name, company, titles, facts (0–12; a card counts as two), photos[{asset, role, caption}], template (ink \| grid \| renwu), consent, optional industry and name_pinyin; required with video_type name_card. Length is 30–90 seconds, set from the material; nullable
`options.founder.name`required	string	length 2–12
`options.founder.company`required	string	length 2–40
`options.founder.titles`required	array<string>	up to 3 items
`options.founder.facts`	array<object>	up to 12 items
`options.founder.photos`required	array<object>	up to 12 items
`options.founder.template`	string	One of: `ink` `grid` `renwu`; Default `ink`
`options.founder.education`	array<string>	up to 3 items
`options.founder.honors`	array<string>	up to 6 items
`options.founder.motto`	string	the closing line; the customer's own words; length ≤ 40
`options.founder.contact`	string	shown on the end card only when given; length ≤ 60
`options.founder.industry`	string	行业 / 主营，如智慧农业；framing lines and illustrative scenes may rest on it; length ≤ 20
`options.founder.name_pinyin`	string	optional pronunciation, e.g. shěn jì bái; written into the narration prompt; length ≤ 48
`options.founder.brand_color`	string	#RRGGBB accent for the grid template
`options.founder.consent`	boolean	the customer holds the rights to these photos and the facts are true; Default `false`

Response 202 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`batch_id`	string	nullable
`parent_id`	string	nullable
`status`required	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`
`stage`required	string	nullable
`progress`required	integer	nullable
`error`	string	nullable
`created_at`required	number	nullable
`updated_at`	number	nullable
`started_at`	number	nullable
`finished_at`	number	nullable
`deleted_at`	number	nullable
`waited_s`	number	`GET /v1/videos/{id}` only: seconds the video waited for its length to be confirmed, null until it is confirmed; its working time is `(finished_at or now) - created_at - waited_s`; nullable
`recovery`required	object
`recovery.attempt`required	integer
`recovery.max_attempts`required	integer
`recovery.retry_at`	number	nullable
`result`	object	nullable
`result.files`	map<string, string>	Signed download links; present on GET once complete/rejected; nullable
`result.duration`	number	nullable
`result.shot_count`	integer	nullable
`result.visual_mix`	any
`result.qa`	any
`result.brief`	any
`result.workflow`	string	nullable
`result.routing`	any
`result.input_required`	object	Why the job is `needs_input`: `code`, `actor`, `message` and what to send to /resume. A spending stop has `code: budget_approval` and carries no amounts. With `approvable: true` answer it with `POST /v1/videos/{id}/resume {"approve_budget": true}`; with `approvable: false` (`actor: operator`, prepaid flat-priced jobs) it is an internal review: nothing to approve, the price does not change; nullable
`result.native_project`	any
`requested_workflow`required	string
`video_type`	string	The video type within the workflow, e.g. `project`, when the request set one; nullable
`style`	string	The style the request chose (`options.style`, see `GET /v1/styles`); null: the default style; nullable
`title`	string	A short name for lists: the subject named in the brief (e.g. the project name) or the start of the prompt; nullable
`profile_draft`	string	profile_card: the confirmed 行家访谈 draft this film was made from (the web app offers a retry); nullable
`webhook_signing_secret`	string	Only present when the request set `webhook_url`: the project secret that signs that per-job callback (`Vidgen-Signature`). Store it; verify deliveries with it; nullable

Example

curl -X POST "https://axiomlab.online/v1/videos/<job_id>/revisions" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "<prompt>", "assets": ["<asset id>"]}'

Get Video

GET/v1/videos/{job_id}

API key requiredSuccess 200

Parameters

Name	Type	Description
`job_id`requiredpath	string
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`batch_id`	string	nullable
`parent_id`	string	nullable
`status`required	string	One of: `queued` `running` `needs_input` `complete` `rejected` `failed` `cancelled`
`stage`required	string	nullable
`progress`required	integer	nullable
`error`	string	nullable
`created_at`required	number	nullable
`updated_at`	number	nullable
`started_at`	number	nullable
`finished_at`	number	nullable
`deleted_at`	number	nullable
`waited_s`	number	`GET /v1/videos/{id}` only: seconds the video waited for its length to be confirmed, null until it is confirmed; its working time is `(finished_at or now) - created_at - waited_s`; nullable
`recovery`required	object
`recovery.attempt`required	integer
`recovery.max_attempts`required	integer
`recovery.retry_at`	number	nullable
`result`	object	nullable
`result.files`	map<string, string>	Signed download links; present on GET once complete/rejected; nullable
`result.duration`	number	nullable
`result.shot_count`	integer	nullable
`result.visual_mix`	any
`result.qa`	any
`result.brief`	any
`result.workflow`	string	nullable
`result.routing`	any
`result.input_required`	object	Why the job is `needs_input`: `code`, `actor`, `message` and what to send to /resume. A spending stop has `code: budget_approval` and carries no amounts. With `approvable: true` answer it with `POST /v1/videos/{id}/resume {"approve_budget": true}`; with `approvable: false` (`actor: operator`, prepaid flat-priced jobs) it is an internal review: nothing to approve, the price does not change; nullable
`result.native_project`	any
`requested_workflow`required	string
`video_type`	string	The video type within the workflow, e.g. `project`, when the request set one; nullable
`style`	string	The style the request chose (`options.style`, see `GET /v1/styles`); null: the default style; nullable
`title`	string	A short name for lists: the subject named in the brief (e.g. the project name) or the start of the prompt; nullable
`profile_draft`	string	profile_card: the confirmed 行家访谈 draft this film was made from (the web app offers a retry); nullable

Example

curl "https://axiomlab.online/v1/videos/<job_id>" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Delete Video

DELETE/v1/videos/{job_id}

API key requiredSuccess 200

Purge a finished job's films, uploads copies and diagnostics; the job record stays for usage history.

Parameters

Name	Type	Description
`job_id`requiredpath	string
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`id`required	string
`deleted`	boolean	Default `true`

Example

curl -X DELETE "https://axiomlab.online/v1/videos/<job_id>" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Cancel Video

POST/v1/videos/{job_id}/cancel

API key requiredSuccess 200

queued / needs_input jobs cancel at once; a running job stops before its next paid step (cancelling).

Parameters

Name	Type	Description
`job_id`requiredpath	string
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`id`required	string
`status`required	string	One of: `cancelled` `cancelling`

Example

curl -X POST "https://axiomlab.online/v1/videos/<job_id>/cancel" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Get File

GET/v1/videos/{job_id}/files/{name}

Signed link, no keySuccess 200

Parameters

Name	Type	Description
`job_id`requiredpath	string
`name`requiredpath	string
`expires`requiredquery	integer
`sig`requiredquery	string

Response 200 application/octet-stream

Returns the file bytes.

Example

curl "https://axiomlab.online/v1/videos/<job_id>/files/<name>?expires=<expires>&sig=<sig>"