Machine-readable documentation
OpenAPI 3.1
Download the public endpoint contract.
Documentation index
Find the guides and endpoint references.
Model a long-running tool
A caption job is asynchronous. Expose at least two operations in your connector:- Create captions: call
POST /v1/subtitleswith the video URL and caption options, and return the job ID. - Get result: call
GET /v1/jobs/{id}to return status, progress, and completed output URLs.
Integration rules
- Check the prepaid balance and the video’s expected duration before submission.
- Require a direct HTTPS media URL; an agent cannot pass a local file path.
- Save the job ID as soon as submission succeeds.
- Poll no more often than every five seconds per job and honor
Retry-After. - Stop on
completed,failed, orcanceled. - Treat processing errors as tool results the caller can act on.
- Save output files before their 24-hour expiration.
- Each accepted submission creates a new job. Check recent jobs before retrying a submission whose response was lost.