ConsistlyAPI
Guidelines

Retrieve a brand-guideline extraction

GET
/brand_guideline_extractions/{id}

Authorization

ApiKey
AuthorizationBearer <token>

Bearer API key. Brand Governance endpoints require brand:read or brand:write (plus narrower writes for specific resources).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/brand_guideline_extractions/brand_extraction_abc..."
{  "id": "string",  "object": "brand_guideline_extraction",  "status": "queued",  "stage": "string",  "draft": {    "property1": null,    "property2": null  },  "diff": {    "property1": null,    "property2": null  },  "error": "string",  "created": "2019-08-24T14:15:22Z",  "updated": "2019-08-24T14:15:22Z"}
{  "error": {}}

Start a brand-guideline (PDF) extraction POST

Uploads a brand-guideline PDF and queues an AI extraction into the canonical brand schema. Poll GET /brand_guideline_extractions/{id} until `status` is `review`, inspect the `draft`, then POST .../commit to apply it. Requires the OpenAI integration to be configured.

Commit a brand-guideline extraction POST

Applies the reviewed draft to the workspace brand (palettes, rules, fonts).