其他 · API · Axiom Lab

Read Founder Card

POST/v1/founder/card

需要 API Key成功 200

Read a business card into empty form fields. The vision cost is internal, not a second customer charge.

参数

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

请求体 application/json

名称	类型	说明
`asset`必填	string	长度 ≤ 80

返回 200 application/json

名称	类型	说明
`name`	string
`company`	string
`titles`	array<string>
`contact`	string
`phone`	string
`email`	string
`address`	string
`city`	string
`website`	string
`slogan`	string
`business`	array<string>

示例

curl -X POST "https://axiomlab.online/v1/founder/card" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset": "<asset>"}'

Edit Founder Script

POST/v1/founder/script

需要 API Key成功 200

Replace lines of a plan's script. The result must still pass the same checks; an edit cannot waive them.

参数

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

请求体 application/json

名称	类型	说明
`plan_id`必填	string	长度 ≤ 80
`lines`	array<object>	最多 12 项

返回 200 application/json

名称	类型	说明
`id`必填	string
`project_id`必填	string	可为 null
`kind`必填	string
`name`必填	string
`version`必填	integer
`created_at`必填	number
`updated_at`必填	number
`data`必填	object
`data.status`必填	string	可选值：`planning` `ready` `needs_input` `unavailable`
`data.request`必填	object
`data.assets`	array<object>
`data.routing`	object	可为 null
`data.requirements`	array<object>
`data.reason`	string	可为 null
`data.job_id`	string	The production this plan started; a plan starts at most one; 可为 null

示例

curl -X POST "https://axiomlab.online/v1/founder/script" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan_id": "<plan_id>"}'

Import Founder Zip

POST/v1/founder/import

需要 API Key成功 200

Unpack a zip the customer uploaded. Photos become assets; fact lines stay drafts until the customer adds them.

Vision and the extraction call are internal cost, the same as card reading: not a second customer charge.

参数

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

请求体 application/json

名称	类型	说明
`asset`必填	string	长度 ≤ 80

返回 200 application/json

名称	类型	说明
`photos`	array<object>
`photos[].asset`必填	string
`photos[].role`	string
`photos[].note`	string
`photos[].quality`	string
`photos[].source`	string
`facts`	array<object>
`facts[].year`	string
`facts[].text`	string
`facts[].source`	string
`facts[].excerpt`	string
`skipped`	array<string>

示例

curl -X POST "https://axiomlab.online/v1/founder/import" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset": "<asset>"}'

Styles

GET/v1/styles

需要 API Key成功 200

The visual styles a film can be made in (options.style), named in the page's language. Needs no key or session (the signed-out create page shows them too); a key that is sent must be valid.

参数

名称	类型	说明
`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>	Empty while the styles cannot be listed; a film then gets the default style
`data[].id`必填	string	The value for `options.style`
`data[].name`必填	string
`data[].line`必填	string	What the style suits, in one line
`data[].beta`必填	boolean	A new style: no film made with it has been delivered yet
`data[].default`必填	boolean	The style a film gets when `options.style` is not set
`data[].cover`必填	string	A still of the style's sample film (`GET /v1/styles/{id}/cover`); 可为 null
`data[].clip`必填	string	A 5-second silent loop of the style's sample film, starting and ending on the cover (`GET /v1/styles/{id}/clip`); 可为 null

示例

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

Style Cover

GET/v1/styles/{style_id}/cover

需要 API Key成功 200

A still of the style's sample film. Needs no key or session, like the list. The listed link changes with the image, so a browser may keep it for a day.

参数

名称	类型	说明
`style_id`必填path	string
`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 image/jpeg

返回文件内容。

示例

curl "https://axiomlab.online/v1/styles/<style_id>/cover" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Style Clip

GET/v1/styles/{style_id}/clip

需要 API Key成功 200

A 5-second silent loop of the style's sample film. Needs no key or session, like the list. Honours a single byte Range. The listed link changes with the clip, so a browser may keep it for a day.

参数

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

返回 200 video/mp4

返回文件内容。

其他状态码

416 The range lies outside the clip (`Content-Range: bytes */<length>`)

示例

curl "https://axiomlab.online/v1/styles/<style_id>/clip" \
  -H "Authorization: Bearer $AZIMO_API_KEY"