# API overview

Base URL, authentication, errors and every endpoint.

**API address**: Ask the person who opened your account for the API address.

## 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.

```bash
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](./api-docs-en-api-errors.md).

## All endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/video/generations` | [Create a video task](./api-docs-en-api-video-tasks-create.md) |
| GET | `/v1/video/tasks/{task_id}` | [Read a video task](./api-docs-en-api-video-tasks-retrieve.md) |
| GET | `/v1/video/tasks` | [List team tasks](./api-docs-en-api-video-tasks-list.md) |
| POST | `/v1/video/tasks/{task_id}/cancel` | [Cancel a video task](./api-docs-en-api-video-tasks-cancel.md) |
| GET | `/v1/video/tasks/{task_id}/billing` | [Read task billing](./api-docs-en-api-video-tasks-billing.md) |
| POST | `/v1/assets` | [Register an asset](./api-docs-en-api-assets-create.md) |
| GET | `/v1/assets/{asset_id}` | [Check an asset](./api-docs-en-api-assets-retrieve.md) |
| Event | `task.completed` | [Receive a task completion notification](./api-docs-en-api-events-task-completed.md) |
| Event | `task.billing_settled` | [Receive a billing settlement notification](./api-docs-en-api-events-task-billing-settled.md) |