Prefetch by Email

Warm the cache by triggering background brand data extraction using a business email address. The domain is extracted from the email automatically.

Endpoint: POST /v1/brand/prefetch-by-email Credits: 0 (free — paid plans only)

Request Body

Request Example

{
  "email": "hello@github.com"
}

Response Schema

202 Accepted

{
  "success": true,
  "message": "Prefetch triggered. Brand data will be available shortly.",
  "domain": "github.com",
  "email": "hello@github.com",
  "credits_used": 0,
  "request_id": "d0e1f2a3-b4c5-6789-3456-890123456789"
}

Code Examples

cURL

curl -X POST "https://api.orsa.dev/v1/brand/prefetch-by-email" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "hello@github.com" }'

TypeScript

await client.brand.prefetchByEmail({
  email: 'hello@github.com',
});
 
// Brand data for github.com will be cached shortly

Python

client.brand.prefetch_by_email(email="hello@github.com")
 
# Brand data for github.com will be cached shortly

Error Codes

Notes

• Free plans cannot use prefetch. Upgrade to any paid plan to access this endpoint.
• Free and disposable email providers are rejected (Gmail, Yahoo, Outlook, etc.). Only business emails are accepted.
• No credits are charged — this is a free cache-warming operation.
• The domain is extracted from the email (e.g., hello@github.com → github.com). The www. prefix is stripped automatically.
• Pair with Retrieve by Email for instant responses in onboarding flows.