Charchy Senddocs

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 URLhttps://api.charchy.krd/v1
AuthenticationAuthorization: Bearer chy_live_… or chy_test_…
Request bodiesJSON (Content-Type: application/json), except image uploads (multipart/form-data)
TimesISO 8601 strings, e.g. 2026-11-20T09:00:00+03:00
IdsEmails em_…, images img_…, webhook events evt_…
Addressesto, cc, bcc and reply_to take one address or an array
Errors{ "error": { "code", "message", "field"?, "docs" } } — all codes
DuplicatesIdempotency-Key header on every send
LimitsRate limits, sizes and counts

Endpoints

POST /emailsSend an email
POST /emails/batchSend up to 100 emails
GET /emails/{id}An email's status and event timeline
GET /emailsList emails of the last 30 days
PATCH /emails/{id}Reschedule a scheduled email
POST /emails/{id}/cancelCancel a scheduled or queued email
POST /imagesHost an image for your emails
GET /usageYour 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.

On this page