alpha

Get brand kit imports

Get one Brand Kit import by id: its status, the revision it added its files in and the kit version it published, the revision to restore to undo it (alpha_brand_kits_restore), and each file's status (uploading, identifying, added, needs_decision or refused) with the role and label it was added as, why it needs a decision, or why it was refused. Place a file that needs a decision with alpha_brand_kits_update_v2, naming its artifactId.

get/api/v1/alpha/brand-kit-imports/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/brand-kit-imports/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The importId create answered.

Headers

Point11-Organizationstring uuid

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

Response

Success.

importIdstring uuid required
kitKeystring required
status'uploading' | 'identifying' | 'published' | 'unchanged' | 'failed' required
runIdstring uuid nullable required
revisionArtifactIdstring uuid nullable required

The one revision the import added its files in.

versioninteger nullable required

The kit version that revision was published at.

restoreArtifactIdstring uuid nullable required

The revision before the import: restore it with alpha.brand-kits.restore.v1 to undo the import.

errorstring nullable required

Why a failed import did not finish, when it says more than its files do: for a kit with no published revision, why its brand could not be read from them.

createdAtstring date-time required
completedAtstring date-time nullable required

Changes

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