alpha

Start brand kit imports

Start an import once its files are uploaded: each file is checked (it landed, its bytes are its declared type, an Office file carries no macros, ActiveX controls or embedded objects), then a model identifies each admitted file's role and the identified files are added to the kit in one new revision. Importing is free. Calling it again answers the same run. Read the outcome with alpha_brand_kit_imports_get. Needs a signed-in member.

post/api/v1/alpha/brand-kit-imports/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/brand-kit-imports/start
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

importIdstring uuid required

The importId create answered.

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

importIdstring uuid required
runIdstring uuid nullable required

The run identifying the files; null when no file was admitted, or the start was refused.

status'started' | 'completed' | 'refused' required

started: the files are being identified. completed: nothing was left to identify. refused: the run was not admitted (see refusal); nothing was added.

Changes

No recorded changes to this operation across all 1 revision of this API.