API v1

API overview

Base URL, authentication, errors and every endpoint.

View Markdown

API address

Reading the API address…

Every request path follows this address, for example POST /v1/video/generations. The examples read it from the CHENVOYA_BASE_URL environment variable, without a trailing slash.

Authentication

Customer calls use an API key with the Bearer scheme in a request header. Keep the value in the local CHENVOYA_API_KEY environment variable. Examples reference the variable only. Never paste its actual value into documentation or logs.

Authorization: Bearer ${CHENVOYA_API_KEY}

Error responses

Errors contain an error object and trace_id. Handle error.code in your application; message is a readable explanation and optional details carries structured information. Each operation below lists its error codes and states. The notes do not imply extra retry or billing guarantees.

Every error code and what to do about it is on Error codes.

All endpoints

POST/v1/video/generationsCreate a video taskGET/v1/video/tasks/{task_id}Read a video taskGET/v1/video/tasksList team tasksPOST/v1/video/tasks/{task_id}/cancelCancel a video taskGET/v1/video/tasks/{task_id}/billingRead task billingPOST/v1/assetsRegister an assetGET/v1/assets/{asset_id}Check an assetEventtask.completedReceive a task completion notificationEventtask.billing_settledReceive a billing settlement notification