Skip to content
Limited-time offerevery video just HK$1only 1,000, first come first servedGet it now
Axiom Lab
Developer docs

Reference

API reference · Other

View Markdown

Read Founder Card

POST/v1/founder/card

API key requiredSuccess 200

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

Parameters

NameTypeDescription
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Request body application/json

NameTypeDescription
assetrequiredstringlength ≤ 80

Response 200 application/json

NameTypeDescription
namestring
companystring
titlesarray<string>
contactstring
phonestring
emailstring
addressstring
citystring
websitestring
sloganstring
businessarray<string>

Example

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 requiredSuccess 200

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

Parameters

NameTypeDescription
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Request body application/json

NameTypeDescription
plan_idrequiredstringlength ≤ 80
linesarray<object>up to 12 items

Response 200 application/json

NameTypeDescription
idrequiredstring
project_idrequiredstringnullable
kindrequiredstring
namerequiredstring
versionrequiredinteger
created_atrequirednumber
updated_atrequirednumber
datarequiredobject
data.statusrequiredstringOne of: planning ready needs_input unavailable
data.requestrequiredobject
data.assetsarray<object>
data.routingobjectnullable
data.requirementsarray<object>
data.reasonstringnullable
data.job_idstringThe production this plan started; a plan starts at most one; nullable

Example

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 requiredSuccess 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.

Parameters

NameTypeDescription
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Request body application/json

NameTypeDescription
assetrequiredstringlength ≤ 80

Response 200 application/json

NameTypeDescription
photosarray<object>
photos[].assetrequiredstring
photos[].rolestring
photos[].notestring
photos[].qualitystring
photos[].sourcestring
factsarray<object>
facts[].yearstring
facts[].textstring
facts[].sourcestring
facts[].excerptstring
skippedarray<string>

Example

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 requiredSuccess 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.

Parameters

NameTypeDescription
langquerystringDisplay language, zh (default) or en; when absent the first zh/en entry of Accept-Language is used; length ≤ 16; nullable
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable
accept-languageheaderstringnullable

Response 200 application/json

NameTypeDescription
datarequiredarray<object>Empty while the styles cannot be listed; a film then gets the default style
data[].idrequiredstringThe value for options.style
data[].namerequiredstring
data[].linerequiredstringWhat the style suits, in one line
data[].betarequiredbooleanA new style: no film made with it has been delivered yet
data[].defaultrequiredbooleanThe style a film gets when options.style is not set
data[].coverrequiredstringA still of the style's sample film (GET /v1/styles/{id}/cover); nullable
data[].cliprequiredstringA 5-second silent loop of the style's sample film, starting and ending on the cover (GET /v1/styles/{id}/clip); nullable

Example

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

Style Cover

GET/v1/styles/{style_id}/cover

API key requiredSuccess 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.

Parameters

NameTypeDescription
style_idrequiredpathstring
langquerystringDisplay language, zh (default) or en; when absent the first zh/en entry of Accept-Language is used; length ≤ 16; nullable
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable
accept-languageheaderstringnullable

Response 200 image/jpeg

Returns the file bytes.

Example

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 requiredSuccess 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.

Parameters

NameTypeDescription
style_idrequiredpathstring
langquerystringDisplay language, zh (default) or en; when absent the first zh/en entry of Accept-Language is used; length ≤ 16; nullable
RangeheaderstringOne byte range: bytes=first-last, bytes=first- or bytes=-length; nullable
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable
accept-languageheaderstringnullable

Response 200 video/mp4

Returns the file bytes.

Other status codes

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

Example

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

← All endpoints