API reference
:::info Generated page This reference is emitted from the API's OpenAPI schema, which is itself generated from the route contracts in the codebase. It cannot drift from the running API. Do not hand-edit it. :::
Base URL
https://api.decodx.ai
Authentication
Every request carries a workspace-scoped credential — a service token for unattended access, or an OAuth grant for an agent acting on a person's behalf. See REST API.
Endpoint groups
| Group | Covers |
|---|---|
| Projects | Create, read, update; compose and validate a composition |
| Jobs | Estimate, submit, poll, stream events, cancel |
| Videos | Read a finished video, export it, publish it |
| Documents | Read, update, set density, regenerate, export |
| Assets and uploads | Upload material, manage the library, per-asset effects |
| Shares | Create shares, read their analytics, read viewer comments |
| Brand | Brand kit assets, voice and avatar catalogues, music catalogue |
| Templates | Save and apply project templates |
| Workspaces and members | Workspaces, members, invitations, groups, permissions |
| Integrations | Outbound webhooks, Slack routes, YouTube connection |
| Account | Profile, preferences, two-factor, sessions, service tokens |
Conventions
- Requests and responses are JSON.
- Collection endpoints paginate.
- Errors follow one shape across the whole API — see Errors and limits.