Skip to main content
POST
Prefetch brand data
0 credits Paid plans See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json
type
enum<string>
required

Data to prefetch.

Available options:
brand,
styleguide
identifier
By domain · object
required

Identifier of the target to prefetch. Provide exactly one of domain or email.

timeoutOpts
object

Request deadline and what to return when it passes.

tags
string[]

Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

status
string

Always ok on success.

message
string

Success message

type
enum<string>

The type of prefetch that was queued, echoed from the request

Available options:
brand,
styleguide
domain
string

The domain that was queued for prefetching

key_metadata
object

Credits this request used and your remaining balance.