VoiceStudioDocs
Cloud reference

Audiobooks

POST
/v1/audiobooks/plan

Synchronous, GPU-free audiobook planning. It admits no Job: it reads a ready script Artifact, computes the versioned plan, and optionally stores it as an audiobook_plan Artifact. The body carries references and options only, never script text, and the plan itself carries codepoint offsets rather than script content. store_plan creates a tenant Artifact and therefore additionally requires the Artifact-management role, which is the only 403 on this route. Render admission is deliberately not open.

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Request Body

application/json

project_id*string
Length1 <= length <= 128
script_artifact_id*string
Length1 <= length <= 128
model_class?string

Value in

  • ""
  • "standard"
  • "fast"
chapterization?
voices?
store_plan?boolean

Stores the plan as an audiobook_plan Artifact. This creates a tenant Artifact and additionally requires the Artifact-management role.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/v1/audiobooks/plan" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "string",
    "script_artifact_id": "string"
  }'
json
{
  "plan": {
    "schema_version": "string",
    "script_artifact_id": "string",
    "script_artifact_sha256": "string",
    "model_class": "string",
    "rating_policy_version": "string",
    "options": {
      "mode": "headings",
      "max_chapter_codepoints": 1
    },
    "chapters": [
      {
        "index": 0,
        "title": "string",
        "voice_id": "string",
        "spans": [
          {
            "start_codepoint": 0,
            "end_codepoint": 0
          }
        ],
        "codepoints": 0,
        "estimated_credit_units": 0
      }
    ],
    "total_codepoints": 0,
    "estimated_credit_units": 0
  },
  "plan_artifact_id": "string"
}