账户与能力 · API

Me

GET/v1/me

需要 API Key成功 200

参数

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

返回 200 application/json

名称	类型	说明
`id`必填	string
`key_id`必填	string	Same as `id`
`organization_id`必填	string
`project_id`必填	string
`role`必填	string	可选值：`owner` `editor` `viewer`
`billing_mode`必填	string	可选值：`budget` `prepaid`
`wallet`必填	object
`permissions`必填	map<string, boolean>

示例

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

Workflows

GET/v1/workflows

需要 API Key成功 200

参数

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

返回 200 application/json

名称	类型	说明
`router`必填	object
`workflows`必填	map<string, object>

示例

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

Video Skills

GET/v1/workflows/creative_video/skills

需要 API Key成功 200

Kept for client compatibility: the production service chooses its own techniques, so no skill catalogue is offered.

参数

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

返回 200 application/json

名称	类型	说明
`data`必填	array<any>

示例

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

Video Types

GET/v1/video-types

需要 API Key成功 200

参数

名称	类型	说明
`lang`query	string	Display language, `zh` (default) or `en`; when absent the first `zh`/`en` entry of `Accept-Language` is used; 长度 ≤ 16; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null
`accept-language`header	string	可为 null

返回 200 application/json

名称	类型	说明
`data`必填	array<object>
`data[].id`必填	string
`data[].version`必填	any
`data[].template`	any
`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/video-types" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Playground

GET/v1/playground

需要 API Key成功 200

The workflow gallery: eight fixed entries, each with routing values, whether this account can start it now, and a runnable example.

参数

名称	类型	说明
`lang`query	string	Display language, `zh` (default) or `en`; when absent the first `zh`/`en` entry of `Accept-Language` is used; 长度 ≤ 16; 可为 null
`X-Project-ID`header	string	要操作的项目；省略时使用默认项目; 可为 null
`accept-language`header	string	可为 null

返回 200 application/json

名称	类型	说明
`data`必填	array<object>
`data[].id`必填	string	Stable catalogue id
`data[].name`必填	string
`data[].summary`必填	string	One benefit-oriented sentence
`data[].workflow`必填	string	Backend routing value for `options.workflow`; null for an entry that has no workflow yet (`custom`); 可为 null
`data[].video_type`必填	string	`options.video_type` for structured explainers, otherwise null; 可为 null
`data[].aspect`必填	string	可选值：`16:9` `9:16` `1:1`
`data[].duration`必填	integer	Default `options.duration_max` in seconds
`data[].duration_range`必填	array<integer>	[minimum, maximum] seconds the workflow accepts
`data[].needs_assets`必填	boolean	At least one material file is required: a plan without one is `needs_input` with `materials_required`
`data[].available`必填	boolean	The entry is open in this catalogue and its workflow is configured here. A display flag, not an API permission: plans and videos are checked by their own requirements
`data[].reason`必填	string	Why `available` is false: coming_soon (not open in this catalogue) or not_configured (this environment); 可选值：`coming_soon` `not_configured` `contact_sales`; 可为 null
`data[].coming_soon`必填	boolean
`data[].example`必填	object
`data[].example.prompt`必填	string	A ready-to-run creative brief for `POST /v1/videos` or `POST /v1/plans`
`data[].example.content_data`必填	map<string, string>	Sample value for every input of the workflow's video type (`options.content_data`); empty when the workflow has none

示例

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