API reference · Context.dev
context-dev/retrieve-brand
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
context-dev/retrieve-brand01
Input Schema
8 parameters · 0 required · 8 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Company name to resolve, e.g. 'Apple Inc'. Mutually exclusive with domain and ticker. · Min length: 3 · Max length: 30 |
domain | string | Optional | Domain to retrieve brand data for, e.g. 'example.com'. Mutually exclusive with name and ticker. · Min length: 3 |
ticker | string | Optional | Stock ticker to resolve, e.g. 'AAPL'. Mutually exclusive with domain and name. · Min length: 1 · Max length: 15 |
maxAgeMs | integer | Optional | Maximum age in milliseconds of cached brand data before Context.dev hard-refreshes it. Default 7776000000 (3 months); values are clamped to [86400000 (1 day), 31536000000 (1 year)]. · Min: 0 · Max: 9007199254740991 |
maxSpeed | boolean | Optional | Optimize for speed: Context.dev skips time-consuming enrichment for a faster response at the cost of less comprehensive data. Default false. |
timeoutMS | integer | Optional | Upstream timeout in milliseconds (max 300000). Context.dev aborts the call with a 408 when exceeded. Keep it below the endpoint's requestTimeoutMs so the provider answers before the platform's own budget expires. · Min: 1000 · Max: 300000 |
force_language | string | Optional | Force the language of the returned brand copy (a language NAME, e.g. 'english', 'french', 'japanese'). · Min length: 2 |
ticker_exchange | string | Optional | Exchange code disambiguating the ticker, e.g. 'NASDAQ', 'NYSE', 'LSE', 'XETRA'. · Min length: 2 · Max length: 10 |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
Async Workflow
This model uses asynchronous execution. Submit a request and poll for the result.
- Submit — POST to /v1/run, receive an
id - Poll — GET /v1/run/{id} until status is
completed,failed, ortimeout - Retrieve — Read
outputsfrom the completed response
03
Code Examples
Ready-to-run snippets
# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "context-dev/retrieve-brand",
"prompt": "a beautiful sunset over mountains"
}'
# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
-H "Authorization: Bearer YOUR_API_KEY"
