SeeRead Developer Center

Manage your API keys, review the endpoints, and explore the lenses and styles you can pair with the SeeRead generation API.

Base URL: https://seeread.app/api/v1 Auth: x-api-key header Rate limit: 60 req/min

API keys

Create and revoke server-side secrets. API keys are tied to your SeeRead account and let you generate images on behalf of your apps.

Security reminder: API keys belong on secure servers. Never embed a key in client-side JavaScript, mobile bundles, or any code the public can inspect. Treat each key like a password.

Quick start

Generate an image with one request:

curl -X POST https://seeread.app/api/v1/images \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Summarize this article...",
    "lens": "executive-card",
    "style": "liquid-glass",
    "aspect_ratio": "16:9",
    "format": "png"
  }'
          

Poll a task:

curl https://seeread.app/api/v1/images/TASK_ID \
  -H "x-api-key: YOUR_API_KEY"
          

Each generation consumes 1 credit. You can request lens or style auto if you want SeeRead to choose the best combination.

API reference

Include the x-api-key header on every request.

POST /images

Create a generation task and receive a task id.

input

Required. Text to visualize (max 50,000 chars).

lens

Required. Lens id from below. Use auto to let SeeRead choose.

style

Required. Style id from below. Use auto to let SeeRead choose.

aspect_ratio

Required. One of: 16:9, 1:1, 9:16, 4:5, 3:2, 2:3, 4:3, 3:4, 5:4, 21:9.

format

Required. png, jpg, jpeg, or webp.

brand

Optional. Brand id to apply saved brand settings.

{
  "id": "TASK_ID",
  "status": "pending",
  "created_at": "2025-02-12T18:25:43.511Z"
}
          

GET /images/:id

Poll a task to receive the output URL once done.

{
  "id": "TASK_ID",
  "status": "completed",
  "created_at": "2025-02-12T18:25:43.511Z",
  "completed_at": "2025-02-12T18:27:21.044Z",
  "output": {
    "url": "https://...",
    "format": "png"
  }
}
          

GET /images

List your recently generated images (cursor pagination).

curl "https://seeread.app/api/v1/images?limit=20&cursor=2025-02-12T18:27:21.044Z" \
  -H "x-api-key: YOUR_API_KEY"
          

{
  "data": [
    { "id": "TASK_ID", "status": "completed", "created_at": "2025-02-12T18:25:43.511Z", "completed_at": "2025-02-12T18:27:21.044Z" }
  ],
  "has_more": false,
  "next_cursor": null
}
          

Error codes

missing_api_key - x-api-key required.
invalid_api_key - API key invalid or revoked.
invalid_request - Missing or invalid parameters.
not_found - Task id not found.
rate_limit_exceeded - Too many requests.
insufficient_credits - Not enough credits.
generation_failed - Generation could not finish.
service_unavailable - Rate limiter unavailable.

Available lenses

Use these lens ids in the lens field. Thumbnails show the default execution.

All lens ids

Available styles

Use these style ids in the style field. Visual references appear below.

All style ids