Plans · API · Axiom Lab

List Plans

GET/v1/plans

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
`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[].kind`required	string
`data[].name`required	string
`data[].version`required	integer
`data[].created_at`required	number
`data[].updated_at`required	number
`data[].data`required	object
`data[].data.status`required	string	One of: `planning` `ready` `needs_input` `unavailable`
`data[].data.request`required	object
`data[].data.assets`	array<object>
`data[].data.routing`	object	nullable
`data[].data.requirements`	array<object>
`data[].data.reason`	string	nullable
`data[].data.job_id`	string	The production this plan started; a plan starts at most one; 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/plans" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Create Plan

POST/v1/plans

API key requiredSuccess 201

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 201 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`kind`required	string
`name`required	string
`version`required	integer
`created_at`required	number
`updated_at`required	number
`data`required	object
`data.status`required	string	One of: `planning` `ready` `needs_input` `unavailable`
`data.request`required	object
`data.assets`	array<object>
`data.routing`	object	nullable
`data.requirements`	array<object>
`data.reason`	string	nullable
`data.job_id`	string	The production this plan started; a plan starts at most one; nullable

Example

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

Get Plan

GET/v1/plans/{plan_id}

API key requiredSuccess 200

Parameters

Name	Type	Description
`plan_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
`kind`required	string
`name`required	string
`version`required	integer
`created_at`required	number
`updated_at`required	number
`data`required	object
`data.status`required	string	One of: `planning` `ready` `needs_input` `unavailable`
`data.request`required	object
`data.assets`	array<object>
`data.routing`	object	nullable
`data.requirements`	array<object>
`data.reason`	string	nullable
`data.job_id`	string	The production this plan started; a plan starts at most one; nullable

Example

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

Preview Route

POST/v1/route

API key requiredSuccess 200

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 200 application/json

Name	Type	Description
`plan_id`required	string
`workflow`	string	nullable
`requirements`	array<object>

Example

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