API Reference

Complete reference documentation for all Twin.Actor API endpoints. All endpoints require authentication unless otherwise noted.

Base URL

text

https://api.twin.actor/api/v1

Request Format

All requests should include these headers:

http

Authorization</span>: Bearer YOUR_TOKEN
Content-Type</span>: application/json

Request bodies should be JSON-encoded. File uploads use multipart/form-data.

All responses are JSON-encoded. Successful responses return the resource directly:

json

{
  "id": 1,
  "name": "Resource name",
  "status": "active",
  "created_at": "2024-03-20T10:00:00Z"
}

Collection endpoints return arrays with pagination info when applicable:

json

[
  { "id": 1, "name": "First item" },
  { "id": 2, "name": "Second item" }
]

Errors return a consistent format:

json

{
  "detail": "Error message describing what went wrong"
}

Validation errors include field-level details:

json

{
  "detail": [
    {
      "loc": ["body", "email"],
      "msg": "Invalid email format",
      "type": "value_error"
    }
  ]
}

Code	Description
`200`	Success
`201`	Created
`202`	Accepted (async job started)
`204`	No Content (successful delete)
`400`	Bad Request (invalid parameters)
`401`	Unauthorized (missing/invalid token)
`403`	Forbidden (insufficient credits/permissions)
`404`	Not Found
`422`	Validation Error
`429`	Rate Limit Exceeded
`500`	Internal Server Error

Manage characters and avatars

Clone voices and generate TTS

Multi-scene cinematic videos

Talking-head videos

Business profiles

Business locations

Google My Business images

Share videos publicly

Click on any resource in the sidebar to see detailed documentation including request/response examples, parameters, and error codes.