Crayo Logo
Developer reference

Crayo API documentation

The Crayo API is a JSON REST API at https://api.crayo.ai that clips long videos into vertical shorts with AutoClip, transcribes media, composes and renders captioned projects, generates images and narration, and tracks views across social platforms. Authenticate with a bearer key from the Developers page of the Crayo app and every endpoint on this page is one request away.

Quickstart

Set CRAYO_API_KEY in your shell to a key from the Developers page, then run these four calls in order. Every request is a plain HTTPS call against https://api.crayo.ai.

  1. 1Confirm the key works and read your credit balances.GET/v1/account
    curl "https://api.crayo.ai/v1/account" \
      -H "Authorization: Bearer $CRAYO_API_KEY"
  2. 2Bring a long video into your library from a public https URL.POST/v1/assets
    curl -X POST "https://api.crayo.ai/v1/assets" \
      -H "Authorization: Bearer $CRAYO_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "url": "https://example.com/media/hook-clip.mp4",
      "name": "Hook clip"
    }'
  3. 3Start an AutoClip job on that asset.POST/v1/autoclip
    curl -X POST "https://api.crayo.ai/v1/autoclip" \
      -H "Authorization: Bearer $CRAYO_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "asset_id": "cm7x1k2p40001abcd",
      "clip_count": 5,
      "clip_length": 60,
      "edit_level": "full"
    }'
  4. 4Poll the job, or register an autoclip.completed webhook, then export each clip by its project_id.GET/v1/autoclip/{id}
    curl "https://api.crayo.ai/v1/autoclip/cm7x1m8880001abcd" \
      -H "Authorization: Bearer $CRAYO_API_KEY"

Long-running work (renders, AutoClip, speech enhancement, tracker refreshes) finishes in the background. Register a webhook with POST /v1/webhooks instead of polling on a timer.

All endpoints

68 endpoints in 12 groups. Each group page documents every endpoint with parameters, a curl request, the response body and the errors it can return.

Account

Plan, credit balances, storage, and your key's limits.

1
Assets and Uploads

Your media library, plus the two ways to get files into it.

7
Generation

Images, icons, face swaps, narration, and voice changes.

6
Catalogs

Voices, languages, subtitle styles, and background music.

4
Transcripts

Word-level speech-to-text on your own media.

1
Projects

Compose scenes into a video, then render it.

6
Exports

Track renders and collect the finished file.

2
AutoClip

Turn a long video into vertical shorts automatically.

3
Speech Enhancer

Studio-clean speech from any recording, with separate speech, music and background levels.

5
View Tracker: Raw (manage it yourself)

Live lookups. You call, you schedule, you store. 1 credit per request.

15
View Tracker: Managed (our scheduler)

We refresh on your cadence, keep every reading, and push webhooks.

14
Webhooks

Get told when long-running work finishes.

4
Getting startedCreate an API key on the Crayo Developers page, send it as a bearer token to api.crayo.ai, and learn the rate limits, error envelope and webhooks.OpenAPI specificationDownload the Crayo API OpenAPI 3.1 document covering every endpoint, parameter, request body, response and error code, ready for Postman or client generators.

Frequently asked questions

Anything the Crayo app does from code: AutoClip jobs that turn a long video into captioned vertical clips, transcripts with word timings, projects composed from scenes, narration, music and captions, renders delivered by webhook, image and voice generation, and View Tracker lookups and scheduled trackers across Instagram, YouTube, TikTok, Twitter and Facebook.

Create a key on the Developers page of the Crayo app and send it on every request as Authorization: Bearer <key>. Keys start with crayo_sk_ and an account can hold up to 5 active keys.

No. The API spends the same credit balances as the Crayo app: export, voiceover, image, video and tracker credits. Reads are free, generation and rendering cost credits, and credits are charged when a request is accepted.

Yes. An OpenAPI 3.1 document covering all 68 endpoints is served at crayo.ai/docs/openapi.json, ready to import into an API client or a code generator.

Still have questions?

Contact our 24/7 support team for any concerns or inquiries.

Get in touch