Tintage API Documentation

The **official** API for Tintage. **Base URL:** `https://api.tintage.com` ## Authentication Use `Authorization: Bearer <your-api-key>` header with your API key. ## Client Libraries ### <img src="https://tintage.com/logos/python.svg" width="20" height="20" style="vertical-align: middle;"> Python ```bash pip install tintage ``` [View on PyPI](https://pypi.org/project/tintage/) ### <img src="https://tintage.com/logos/nodejs.svg" width="20" height="20" style="vertical-align: middle;"> Node.js ```bash npm install tintage ``` [View on npm](https://www.npmjs.com/package/tintage) ### <img src="https://tintage.com/logos/php.svg" width="20" height="20" style="vertical-align: middle;"> PHP ```bash composer require tintage/tintage-php ``` [View on Packagist](https://packagist.org/packages/tintage/tintage-php) ### <img src="https://tintage.com/logos/ruby.svg" width="20" height="20" style="vertical-align: middle;"> Ruby ```bash gem install tintage ``` [View on RubyGems](https://rubygems.org/gems/tintage)

Base URL: https://api.tintage.com

API Endpoints

https://api.tintage.com/v1/render/jobs

POST https://api.tintage.com/v1/render/jobs

Create Render Job

Create a new render job

x-team:

GET https://api.tintage.com/v1/render/jobs

Get Team Render Jobs

Get render jobs for a team

limit:

offset:

status:

mine:

x-team:

https://api.tintage.com/v1/render/jobs/{job_id}

GET https://api.tintage.com/v1/render/jobs/{job_id}

Get Render Job

Get a specific render job

job_id:

x-team:

DELETE https://api.tintage.com/v1/render/jobs/{job_id}

Cancel Render Job

Cancel a render job

job_id:

x-team:

https://api.tintage.com/v1/render/queue

GET https://api.tintage.com/v1/render/queue

Get Team Queue Info

Deprecated: Kept for compatibility; now returns empty queue stats since queueing is handled by video-gen.

x-team:

https://api.tintage.com/v1/render/webhook

POST https://api.tintage.com/v1/render/webhook

Render Webhook

Webhook endpoint for video-gen server to update job status

https://api.tintage.com/v1/render/server/status

GET https://api.tintage.com/v1/render/server/status

Get Server Status

Get video-gen server status for scaling decisions

x-team:

https://api.tintage.com/v1/render/cleanup/stuck-jobs

POST https://api.tintage.com/v1/render/cleanup/stuck-jobs

Cleanup Stuck Jobs

Manually trigger cleanup of stuck render jobs. This still checks video-gen for any dangling jobs.

timeout_minutes:

x-team:

https://api.tintage.com/v1/render/cleanup/fail-all-active

POST https://api.tintage.com/v1/render/cleanup/fail-all-active

Fail All Active Jobs

Manually fail all active render jobs (emergency cleanup). Admin only.

x-team:

https://api.tintage.com/v1/render/templates

GET https://api.tintage.com/v1/render/templates

List Templates Endpoint

Return available compositions/templates and their expected props. Centralized in app.services.motion_templates. Args: sort: Sort order ('staff-picks', 'newest', 'oldest') category: Filter by category slug search: Search query for template names/descriptions/tags

sort:

category:

search:

https://api.tintage.com/v1/render/categories

GET https://api.tintage.com/v1/render/categories

List Categories Endpoint

Return available template categories. Centralized in app.services.motion_templates.

https://api.tintage.com/v1/render/templates/{template_id}

GET https://api.tintage.com/v1/render/templates/{template_id}

Get Template By Id Endpoint

Get a specific template by ID or slug. Args: template_id: The template ID or slug Returns: Template data with project object and metadata

template_id:

https://api.tintage.com/v1/render/templates/{template_id}/metadata

GET https://api.tintage.com/v1/render/templates/{template_id}/metadata

Get Template Metadata Endpoint

Get template metadata including aspect ratio and resolution. Args: template_id: The template ID or slug Returns: Template metadata including aspectRatio and resolution

template_id:

https://api.tintage.com/v1/version/

GET https://api.tintage.com/v1/version/

Get Api Version

Get API version information.

https://api.tintage.com/v1/actions

GET https://api.tintage.com/v1/actions

List Actions

List actions for the team This endpoint returns a paginated list of actions performed by the team. You can filter by status and module name.

status: Filter by status (processing, completed, failed)

module: Filter by module name

limit:

offset:

x-team:

https://api.tintage.com/v1/actions/{action_id}

GET https://api.tintage.com/v1/actions/{action_id}

Get Action

Get details of a specific action This endpoint returns the details of a specific action performed by the team.

action_id:

x-team: