> ## Documentation Index
> Fetch the complete documentation index at: https://docs.context.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Prefetch Brand Data
> Warm the brand cache before users need it so onboarding and enrichment flows return faster.
0 Credits Only for Subscribers
## OpenAPI
````yaml POST /utility/prefetch
openapi: 3.1.0
info:
title: Context.dev API
description: API for retrieving context data from any website
version: 1.0.0
servers:
- url: https://api.context.dev/v1
security: []
tags:
- name: Webhooks
description: Inspect and retry webhook deliveries. These endpoints cost no credits.
- name: Logs
description: >-
Read your organization's API request logs to debug failed calls. These
endpoints cost no credits and use a separate rate limit.
- name: Batch
description: Scrape many pages or crawl a site asynchronously.
- name: Monitors
description: >-
Monitor pages, sitemaps, and extracted website data for exact or semantic
changes. Webhook payloads are documented by the
MonitorsChangeDetectedWebhookPayload and
MonitorsRunCompletedWebhookPayload schemas.
- name: News
description: >-
Search live first-party RSS and free historical news data by company
identity.
paths:
/utility/prefetch:
post:
tags:
- Utility
summary: Prefetch data
description: >-
Signal that you may fetch data soon to improve latency. The type field
selects what to prefetch ('brand' queues a brand data fetch,
'styleguide' queues a styleguide extraction) and identifier carries
exactly one lookup key: a domain, or an email whose domain is extracted
and validated (free email providers and disposable email addresses are
not allowed).
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- type
- identifier
properties:
type:
type: string
enum:
- brand
- styleguide
description: >-
What to prefetch: 'brand' warms the brand data cache,
'styleguide' warms the styleguide cache.
identifier:
$ref: '#/components/schemas/UtilityPrefetchIdentifier'
timeoutMS:
$ref: '#/components/schemas/TimeoutMS'
tags:
$ref: '#/components/schemas/RequestTags'
responses:
'200':
description: Successful response
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Status of the response, e.g., 'ok'
message:
type: string
description: Success message
type:
type: string
enum:
- brand
- styleguide
description: >-
The type of prefetch that was queued, echoed from the
request
domain:
type: string
description: The domain that was queued for prefetching
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'400':
description: Bad Request - validation error
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message
error_code:
type: string
enum:
- INTERNAL_ERROR
- VALID
- NOT_FOUND
- FORBIDDEN
- USAGE_EXCEEDED
- RATE_LIMITED
- UNAUTHORIZED
- DISABLED
- INSUFFICIENT_PERMISSIONS
- TIMEOUT_EXCEEDS_MAXIMUM
- WEBSITE_ACCESS_ERROR
- INPUT_VALIDATION_ERROR
description: Error code indicating the type of error
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'401':
description: Unauthorized
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
enum:
- INTERNAL_ERROR
- VALID
- NOT_FOUND
- FORBIDDEN
- USAGE_EXCEEDED
- RATE_LIMITED
- UNAUTHORIZED
- DISABLED
- INSUFFICIENT_PERMISSIONS
- TIMEOUT_EXCEEDS_MAXIMUM
- WEBSITE_ACCESS_ERROR
- INPUT_VALIDATION_ERROR
description: Error code indicating the type of error
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'403':
description: Forbidden - Paid subscription required
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message
status:
type: string
description: Status of the response, e.g., 'error'
error_code:
type: string
enum:
- FORBIDDEN
description: Error code indicating forbidden access
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'408':
description: Request Timeout
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Timeout error message
error_code:
type: string
enum:
- REQUEST_TIMEOUT
description: Error code indicating request timeout
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'422':
description: Unprocessable Entity - Free email or disposable email detected
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message
status:
type: string
description: Status of the response, e.g., 'error'
error_code:
type: string
enum:
- FREE_EMAIL_DETECTED
- DISPOSABLE_EMAIL_DETECTED
description: >-
Error code indicating whether a free email provider or
disposable email was detected
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
'429':
$ref: '#/components/responses/RateLimited'
'500':
description: Internal server error
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message
error_code:
type: string
enum:
- INTERNAL_ERROR
description: Error code indicating internal server error
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
security:
- bearerAuth: []
components:
schemas:
UtilityPrefetchIdentifier:
oneOf:
- $ref: '#/components/schemas/UtilityPrefetchDomainIdentifier'
- $ref: '#/components/schemas/UtilityPrefetchEmailIdentifier'
description: >-
Identifier of the target to prefetch. Provide exactly one of domain or
email.
TimeoutMS:
type: integer
minimum: 1000
maximum: 300000
description: >-
Optional timeout in milliseconds for the request. If the request takes
longer than this value, it will be aborted with a 408 status code.
Maximum allowed value is 300000ms (5 minutes).
RequestTags:
type: array
items:
type: string
minLength: 1
maxLength: 50
maxItems: 20
description: >-
Optional tags for tracking usage. Up to 20 tags, each 1 to 50
characters.
example:
- production
- team-alpha
KeyMetadata:
type: object
properties:
credits_consumed:
type: integer
description: Credits used by this request.
credits_remaining:
type: integer
description: Credits remaining for your organization.
required:
- credits_consumed
- credits_remaining
description: Credit usage, included whenever a valid API key is provided.
RequestId:
type: string
format: uuid
description: >-
Unique id of this API call, also sent in the X-Request-Id response
header. Quote it when contacting support about a failed request.
example: 3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91
UtilityPrefetchDomainIdentifier:
type: object
properties:
domain:
type: string
minLength: 3
description: Domain name to prefetch data for
required:
- domain
additionalProperties: false
title: By domain
description: Prefetch by domain.
UtilityPrefetchEmailIdentifier:
type: object
properties:
email:
type: string
minLength: 1
format: email
description: >-
Email address to prefetch data for. The domain will be extracted
from the email. Free email providers (gmail.com, yahoo.com, etc.)
and disposable email addresses are not allowed.
required:
- email
additionalProperties: false
title: By email
description: Prefetch by email. The domain will be extracted and validated.
headers:
RequestId:
description: >-
Unique id of this API call, sent on every response and mirrored as
request_id in JSON bodies. Quote it when contacting support.
schema:
type: string
format: uuid
RateLimitLimit:
description: Maximum requests per minute.
schema:
type: integer
minimum: 1
RateLimitRemaining:
description: Requests remaining in the current minute.
schema:
type: integer
minimum: 0
RateLimitReset:
description: Unix timestamp in seconds when the rate limit resets.
schema:
type: integer
responses:
RateLimited:
description: Rate limit exceeded
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
Retry-After:
description: Seconds until the per-minute rate limit window resets
schema:
type: integer
minimum: 1
maximum: 60
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message
error_code:
type: string
enum:
- RATE_LIMITED
description: Error code indicating the rate limit was exceeded
key_metadata:
$ref: '#/components/schemas/KeyMetadata'
request_id:
$ref: '#/components/schemas/RequestId'
required:
- request_id
- message
- error_code
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Bearer authentication header of the form `Bearer `, where
`` is your api key.
````