API reference
Every endpoint, field and response of the Charchy Send API, generated from our OpenAPI file.
These pages are generated from the OpenAPI file the API is built against. Download it for code generators, API clients and AI agents:
charchy.krd/docs/openapi.yaml (OpenAPI 3.1)
Basics
| Base URL | https://api.charchy.krd/v1 |
| Authentication | Authorization: Bearer chy_live_… or chy_test_… |
| Request bodies | JSON (Content-Type: application/json), except image uploads (multipart/form-data) |
| Times | ISO 8601 strings, e.g. 2026-11-20T09:00:00+03:00 |
| Ids | Emails em_…, images img_…, webhook events evt_… |
| Addresses | to, cc, bcc and reply_to take one address or an array |
| Errors | { "error": { "code", "message", "field"?, "docs" } } — all codes |
| Duplicates | Idempotency-Key header on every send |
| Limits | Rate limits, sizes and counts |
Endpoints
POST /emails | Send an email |
POST /emails/batch | Send up to 100 emails |
GET /emails/{id} | An email's status and event timeline |
GET /emails | List emails of the last 30 days |
PATCH /emails/{id} | Reschedule a scheduled email |
POST /emails/{id}/cancel | Cancel a scheduled or queued email |
POST /images | Host an image for your emails |
GET /usage | Your plan, credits, daily cap and limits — Rate limits and quotas |
Webhooks are described in the same file, under webhooks.
There is no "try it" console: the API sends no CORS headers, because a key belongs on a server. Use curl or your own code with a test key.