Skip to main content
GET
/
api
/
v1
/
brand-kit
/
{brandId}
/
extraction-progress
Get brand kit extraction progress
curl --request GET \
  --url http://localhost:3001/api/v1/brand-kit/{brandId}/extraction-progress \
  --header 'x-api-key: <api-key>'
{
  "currentStep": "<string>",
  "completedSteps": 123,
  "totalSteps": 123,
  "isComplete": true,
  "isFailed": true,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

​
brandId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

​
currentStep
string
required
​
completedSteps
number
required
​
totalSteps
number
required
​
isComplete
boolean
required
​
isFailed
boolean
required
​
error
string