Skip to main content
POST
/
api
/
v1
/
brand-kit
/
extract
cURL
curl --request POST \
  --url http://localhost:3001/api/v1/brand-kit/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "websiteUrl": "<string>"
}
'
{
  "success": true,
  "workflowId": "<string>",
  "message": "<string>",
  "brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Body

application/json
​
websiteUrl
string<uri>
required

Response

Default Response

​
success
boolean
required
​
workflowId
string
required
​
message
string
required
​
brandId
string<uuid>
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)$