AI Twin API

​

Overview

The AI Twin API allows you generate AI Twins on demand and is intended to be used in combination with the AI Creator API.

​

Generating AI Twins

• Please know that AI Twins that you generate in the Captions app are available to use via the API. So, it is not required to use the AI Twin API in order to generate videos using an AI Twin.
• If you do not have access to the AI Twin API or would like to generate an AI Twin in the Captions app, please follow these instructions.
• As long as you sign into the iPhone app with the same account as on desktop, the AI Twin will be available when you list the available creators. AI Twins will be given a unique name and appear like twin-1-sam, twin-2-sam, etc.

​

Requirements to using the API

To use the Captions API, you must:

1. Accept the Captions API Terms
2. Be actively subscribed to Captions Max, Scale, or Enterprise
3. Have enough credits to complete your request

​

Pricing & Credits

• The AI Twin API is free to use, but requires you to be subscribed to Captions Max, Scale, or Enterprise
• You can view remaining credits and purchase additional credits on the API Dashboard.

​

Usage & Credits

• Although the AI Twin API does not consume credits, you must be subscribed to Captions Max, Scale, or Enterprise.
• You can view your subscription status, credit balance, and purchase additional credits in the API Dashboard.

​

/supported-languages

List languages supported for AI Twin calibration.

​

Instructions

Request

curl -X POST https://api.captions.ai/api/twin/supported-languages -H "Content-Type: application/json" -H "x-api-key: <api-key>"

Response Types

{"supportedLanguages":["English","Spanish","French",...]}

​

/script

Fetch the script to recite in your AI Twin calibration video. This script will be used for validating your AI Twin creation.

Request

language - optional - Defaults to "English".

curl -X POST https://api.captions.ai/api/twin/script -H "Content-Type: application/json" -H "x-api-key: <api-key>" -d '{"language": "<language>"}'

Response Types

{"script":"<script>"}

​

/list

List all AI Twins available to use.

Request

curl -X POST https://api.captions.ai/api/twin/list -H "Content-Type: application/json" -H "x-api-key: <api-key>"

Response Types

{"twins":["twin-1-Joe","twin-2-Kalvin",...]}

​

/create

Begin creating your AI Twin.

Request

name - required - Name of your AI Twin.

videoUrl - required - Link to a vertical video of you reciting the script provided by the /script endpoint. This script will be used for validating the authenticity of the voice in the video. MP4 and MOV formats are supported.

language - optional - Language spoken in the video. Defaults to "English".

calibrationImageUrls - required - An ordered list of links to vertical images of you, to be used for calibration. PNG and JPEG formats are supported. These images should follow the poses provided in the examples below:

Response Types

{"operationId":"<operation-id>"}

​

/status

Check the status of an AI Twin creation process.

Request

We recommend checking the status first after 30 seconds, and every 5 seconds thereafter.

curl -X POST https://api.captions.ai/api/twin/status -H "Content-Type: application/json" -H "x-api-key: <api-key>" -H "x-operation-id: <operation-id>"

Response Types

{"state":"COMPLETE", "progress": 100}

{"state":"QUEUED|PROCESSING","progress":<progress>}

{"detail":"Invalid headers."}

​

/delete

Delete an AI Twin, based on their name.

Request

name - required - Name of AI Twin to delete. This must follow the protocol twin-<id>-<name> as provided by the /list endpoint.

curl -X POST https://api.captions.ai/api/twin/delete -H "Content-Type: application/json" -H "x-api-key: <api-key>" -d '{"name": "twin-<id>-<name>"}'

Response Types

{"success":true|false}