Me
GET/v1/me
API key requiredSuccess 200
Parameters
| Name | Type | Description |
|---|---|---|
X-Project-IDheader | string | The project to act on; the default project when omitted; nullable |
Response 200 application/json
| Name | Type | Description |
|---|---|---|
idrequired | string | |
key_idrequired | string | Same as id |
organization_idrequired | string | |
project_idrequired | string | |
rolerequired | string | One of: owner editor viewer |
billing_moderequired | string | One of: budget prepaid |
walletrequired | object | |
permissionsrequired | map<string, boolean> |
Example
curl "https://axiomlab.online/v1/me" \ -H "Authorization: Bearer $AZIMO_API_KEY"
Workflows
GET/v1/workflows
API key requiredSuccess 200
Parameters
| Name | Type | Description |
|---|---|---|
X-Project-IDheader | string | The project to act on; the default project when omitted; nullable |
Response 200 application/json
| Name | Type | Description |
|---|---|---|
routerrequired | object | |
workflowsrequired | map<string, object> |
Example
curl "https://axiomlab.online/v1/workflows" \ -H "Authorization: Bearer $AZIMO_API_KEY"
Video Skills
GET/v1/workflows/creative_video/skills
API key requiredSuccess 200
Kept for client compatibility: the production service chooses its own techniques, so no skill catalogue is offered.
Parameters
| Name | Type | Description |
|---|---|---|
X-Project-IDheader | string | The project to act on; the default project when omitted; nullable |
Response 200 application/json
| Name | Type | Description |
|---|---|---|
datarequired | array<any> |
Example
curl "https://axiomlab.online/v1/workflows/creative_video/skills" \ -H "Authorization: Bearer $AZIMO_API_KEY"
Video Types
GET/v1/video-types
API key requiredSuccess 200
Parameters
| Name | Type | Description |
|---|---|---|
langquery | string | Display language, zh (default) or en; when absent the first zh/en entry of Accept-Language is used; length ≤ 16; nullable |
X-Project-IDheader | string | The project to act on; the default project when omitted; nullable |
accept-languageheader | string | nullable |
Response 200 application/json
| Name | Type | Description |
|---|---|---|
datarequired | array<object> | |
data[].idrequired | string | |
data[].versionrequired | any | |
data[].template | any | |
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/video-types" \ -H "Authorization: Bearer $AZIMO_API_KEY"
Playground
GET/v1/playground
API key requiredSuccess 200
The workflow gallery: eight fixed entries, each with routing values, whether this account can start it now, and a runnable example.
Parameters
| Name | Type | Description |
|---|---|---|
langquery | string | Display language, zh (default) or en; when absent the first zh/en entry of Accept-Language is used; length ≤ 16; nullable |
X-Project-IDheader | string | The project to act on; the default project when omitted; nullable |
accept-languageheader | string | nullable |
Response 200 application/json
| Name | Type | Description |
|---|---|---|
datarequired | array<object> | |
data[].idrequired | string | Stable catalogue id |
data[].namerequired | string | |
data[].summaryrequired | string | One benefit-oriented sentence |
data[].workflowrequired | string | Backend routing value for options.workflow; null for an entry that has no workflow yet (custom); nullable |
data[].video_typerequired | string | options.video_type for structured explainers, otherwise null; nullable |
data[].aspectrequired | string | One of: 16:9 9:16 1:1 |
data[].durationrequired | integer | Default options.duration_max in seconds |
data[].duration_rangerequired | array<integer> | [minimum, maximum] seconds the workflow accepts |
data[].needs_assetsrequired | boolean | At least one material file is required: a plan without one is needs_input with materials_required |
data[].availablerequired | 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[].reasonrequired | string | Why available is false: coming_soon (not open in this catalogue) or not_configured (this environment); One of: coming_soon not_configured contact_sales; nullable |
data[].coming_soonrequired | boolean | |
data[].examplerequired | object | |
data[].example.promptrequired | string | A ready-to-run creative brief for POST /v1/videos or POST /v1/plans |
data[].example.content_datarequired | map<string, string> | Sample value for every input of the workflow's video type (options.content_data); empty when the workflow has none |
Example
curl "https://axiomlab.online/v1/playground" \ -H "Authorization: Bearer $AZIMO_API_KEY"