品牌与模板 · API

Listing

GET/v1/brands

需要 API Key成功 200

参数

名称	类型	说明
`limit`query	integer	默认 `50`; 范围 1–200
`cursor`query	string	长度 ≤ 256; 可为 null
`after`query	string	长度 ≤ 256; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`data`必填	array<object>
`data[].id`必填	string
`data[].project_id`必填	string	可为 null
`data[].kind`必填	string
`data[].name`必填	string
`data[].version`必填	integer
`data[].created_at`必填	number
`data[].updated_at`必填	number
`data[].data`必填	object
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; 可为 null
`has_more`	boolean	默认 `false`

示例

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

Create

POST/v1/brands

需要 API Key成功 201

参数

名称	类型	说明
`Idempotency-Key`header	string	调用方生成并保存的唯一值；超时重试时复用它，同一请求不会被执行两次; 长度 1–128; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

请求体 application/json

名称	类型	说明
`name`必填	string	长度 1–120
`slogan`	string	长度 ≤ 500
`primary_color`	string	默认 `#0F4C81`
`theme`	string	可选值：`light` `dark`; 默认 `dark`
`assets`	array<string>	最多 30 项
`notes`	string	长度 ≤ 2000

返回 201 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

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

Get

GET/v1/brands/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`version`query	integer	范围 ≥ 1; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

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

Revise

PUT/v1/brands/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`expected_version`必填query	integer	范围 ≥ 1
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

请求体 application/json

名称	类型	说明
`name`必填	string	长度 1–120
`slogan`	string	长度 ≤ 500
`primary_color`	string	默认 `#0F4C81`
`theme`	string	可选值：`light` `dark`; 默认 `dark`
`assets`	array<string>	最多 30 项
`notes`	string	长度 ≤ 2000

返回 200 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

curl -X PUT "https://axiomlab.online/v1/brands/<resource_id>?expected_version=<expected_version>" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "<name>"}'

Remove

DELETE/v1/brands/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`id`必填	string
`deleted`	boolean	默认 `true`

示例

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

Listing

GET/v1/templates

需要 API Key成功 200

参数

名称	类型	说明
`limit`query	integer	默认 `50`; 范围 1–200
`cursor`query	string	长度 ≤ 256; 可为 null
`after`query	string	长度 ≤ 256; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`data`必填	array<object>
`data[].id`必填	string
`data[].project_id`必填	string	可为 null
`data[].kind`必填	string
`data[].name`必填	string
`data[].version`必填	integer
`data[].created_at`必填	number
`data[].updated_at`必填	number
`data[].data`必填	object
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; 可为 null
`has_more`	boolean	默认 `false`

示例

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

Create

POST/v1/templates

需要 API Key成功 201

参数

名称	类型	说明
`Idempotency-Key`header	string	调用方生成并保存的唯一值；超时重试时复用它，同一请求不会被执行两次; 长度 1–128; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

请求体 application/json

名称	类型	说明
`name`必填	string	长度 1–160
`prompt`必填	string	Use $variable or ${variable} placeholders; 长度 10–4000
`options`	object
`options.workflow`	string	可选值：`auto` `explainer` `short_drama` `creative_video` `motion_explainer` `profile_card` `product_pitch`; 默认 `explainer`
`options.goal`	string	长度 ≤ 2000
`options.audience`	string	长度 ≤ 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`); 默认 `60`; 范围 5–180
`options.width`	integer	With `height`, the aspect ratio: 1920×1080 (16:9); profile_card 1080×1920 (9:16); 默认 `1920`; 范围 640–3840
`options.height`	integer	默认 `1080`; 范围 360–2160
`options.fps`	integer	默认 `30`; 范围 24–60
`options.subtitles`	boolean	Subtitle preference, applied by profile_card only; other films usually come with subtitles burned in; 默认 `false`
`options.music`	boolean	Background music preference, applied by profile_card only; 默认 `true`
`options.skill_id`	string	长度 ≤ 200; 可为 null
`options.credit_budget`	integer	范围 1–1000000; 可为 null
`options.video_type`	string	可选值：`project` `product` `personal` `corporate` `name_card`; 可为 null
`options.content_data`	map<string, string>
`options.style_preset`	string	可选值：`cinematic_realism` `clean_3d` `product_studio`; 默认 `cinematic_realism`
`options.brand`	object
`options.profile`	object
`options.motion_style`	string	可选值：`mono` `photo`; 默认 `mono`
`options.photo_subject`	string	长度 ≤ 120
`options.photo_license`	string	可选值：`strict` `sharealike`; 默认 `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; 可为 null
`options.language`	string	The film's language when the request has no text of its own; unset: Chinese; 可选值：`zh` `en`; 可为 null
`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; 可为 null
`options.founder.name`必填	string	长度 2–12
`options.founder.company`必填	string	长度 2–40
`options.founder.titles`必填	array<string>	最多 3 项
`options.founder.facts`	array<object>	最多 12 项
`options.founder.photos`必填	array<object>	最多 12 项
`options.founder.template`	string	可选值：`ink` `grid` `renwu`; 默认 `ink`
`options.founder.education`	array<string>	最多 3 项
`options.founder.honors`	array<string>	最多 6 项
`options.founder.motto`	string	the closing line; the customer's own words; 长度 ≤ 40
`options.founder.contact`	string	shown on the end card only when given; 长度 ≤ 60
`options.founder.industry`	string	行业 / 主营，如智慧农业；framing lines and illustrative scenes may rest on it; 长度 ≤ 20
`options.founder.name_pinyin`	string	optional pronunciation, e.g. shěn jì bái; written into the narration prompt; 长度 ≤ 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; 默认 `false`
`assets`	array<string>	最多 30 项
`brand_id`	string	可为 null

返回 201 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

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

Get

GET/v1/templates/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`version`query	integer	范围 ≥ 1; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

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

Revise

PUT/v1/templates/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`expected_version`必填query	integer	范围 ≥ 1
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

请求体 application/json

名称	类型	说明
`name`必填	string	长度 1–160
`prompt`必填	string	Use $variable or ${variable} placeholders; 长度 10–4000
`options`	object
`options.workflow`	string	可选值：`auto` `explainer` `short_drama` `creative_video` `motion_explainer` `profile_card` `product_pitch`; 默认 `explainer`
`options.goal`	string	长度 ≤ 2000
`options.audience`	string	长度 ≤ 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`); 默认 `60`; 范围 5–180
`options.width`	integer	With `height`, the aspect ratio: 1920×1080 (16:9); profile_card 1080×1920 (9:16); 默认 `1920`; 范围 640–3840
`options.height`	integer	默认 `1080`; 范围 360–2160
`options.fps`	integer	默认 `30`; 范围 24–60
`options.subtitles`	boolean	Subtitle preference, applied by profile_card only; other films usually come with subtitles burned in; 默认 `false`
`options.music`	boolean	Background music preference, applied by profile_card only; 默认 `true`
`options.skill_id`	string	长度 ≤ 200; 可为 null
`options.credit_budget`	integer	范围 1–1000000; 可为 null
`options.video_type`	string	可选值：`project` `product` `personal` `corporate` `name_card`; 可为 null
`options.content_data`	map<string, string>
`options.style_preset`	string	可选值：`cinematic_realism` `clean_3d` `product_studio`; 默认 `cinematic_realism`
`options.brand`	object
`options.profile`	object
`options.motion_style`	string	可选值：`mono` `photo`; 默认 `mono`
`options.photo_subject`	string	长度 ≤ 120
`options.photo_license`	string	可选值：`strict` `sharealike`; 默认 `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; 可为 null
`options.language`	string	The film's language when the request has no text of its own; unset: Chinese; 可选值：`zh` `en`; 可为 null
`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; 可为 null
`options.founder.name`必填	string	长度 2–12
`options.founder.company`必填	string	长度 2–40
`options.founder.titles`必填	array<string>	最多 3 项
`options.founder.facts`	array<object>	最多 12 项
`options.founder.photos`必填	array<object>	最多 12 项
`options.founder.template`	string	可选值：`ink` `grid` `renwu`; 默认 `ink`
`options.founder.education`	array<string>	最多 3 项
`options.founder.honors`	array<string>	最多 6 项
`options.founder.motto`	string	the closing line; the customer's own words; 长度 ≤ 40
`options.founder.contact`	string	shown on the end card only when given; 长度 ≤ 60
`options.founder.industry`	string	行业 / 主营，如智慧农业；framing lines and illustrative scenes may rest on it; 长度 ≤ 20
`options.founder.name_pinyin`	string	optional pronunciation, e.g. shěn jì bái; written into the narration prompt; 长度 ≤ 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; 默认 `false`
`assets`	array<string>	最多 30 项
`brand_id`	string	可为 null

返回 200 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object

示例

curl -X PUT "https://axiomlab.online/v1/templates/<resource_id>?expected_version=<expected_version>" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "<name>", "prompt": "<prompt>"}'

Remove

DELETE/v1/templates/{resource_id}

需要 API Key成功 200

参数

名称	类型	说明
`resource_id`必填path	string
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null

返回 200 application/json

名称	类型	说明
`id`必填	string
`deleted`	boolean	默认 `true`

示例

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