Skip to content
Shortcut: /, ⌘K or Ctrl+K

Voice

View as Markdown

The audio asset object

Attributes

  • idstring (uuid)required

    Identifier for this resource.

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

  • namestringrequired

    Human-readable name for this resource.

  • sourcestringrequired

    Specifies source for this management platform access voice audio asset.

    Allowed valuesuploadtts
  • statusstringrequired

    Current status of this resource or operation.

    Allowed valuespending_uploaduploadedtranscodingreadyfailed
  • failureReasonstringrequirednullable

    Specifies failure reason for this management platform access voice audio asset.

    Allowed valuesunsupported_formattoo_largetoo_longdecode_failedsilenttts_failedprocessing_failed
  • originalFormatstringrequirednullable

    Specifies original format for this management platform access voice audio asset.

    Allowed valuesmp3wavoggm4a
  • originalContentTypestringrequirednullable

    Category assigned to original content.

  • sizeBytesintegerrequirednullable

    Size of the original file in bytes.

  • durationMsintegerrequirednullable

    Length of the converted audio, set when ready.

  • contentSha256stringrequirednullable

    SHA-256 (hex) of the converted 16 kHz mono PCM audio, set when ready.

  • ttsobjectrequirednullable

    Specifies tts for this management platform access voice audio asset.

    Show 7 child fields
  • retentionDaysintegerrequirednullable

    Days after creation when the asset is deleted automatically. Null keeps it until you delete it.

  • expiresAtstring (date-time)requirednullable

    ISO 8601 timestamp when this resource expires.

  • inUseCountintegerrequired

    Campaigns and flows that use the asset. An asset in use cannot be deleted or expire.

  • revisionintegerrequired

    Changes when you rename the asset or change its retention. Send it as expectedRevision to avoid overwriting another change.

  • createdAtstring (date-time)required

    ISO 8601 timestamp when this resource was created.

  • updatedAtstring (date-time)required

    ISO 8601 timestamp when this resource was last updated.

  • readyAtstring (date-time)requirednullable

    Timestamp for ready at.

The audio asset object
{
  "id": "00000000-0000-4000-8000-000000000000",
  "projectId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "source": "upload",
  "status": "pending_upload",
  "failureReason": "unsupported_format",
  "originalFormat": "mp3",
  "originalContentType": "string",
  "sizeBytes": 0,
  "durationMs": 0,
  "contentSha256": "string",
  "tts": {
    "provider": "elevenlabs",
    "voiceId": "string",
    "model": "string",
    "text": "string",
    "characters": 0,
    "keySource": "managed",
    "credentialId": "00000000-0000-4000-8000-000000000000"
  },
  "retentionDays": 0,
  "expiresAt": "2026-09-22T12:00:00Z",
  "inUseCount": 0,
  "revision": 0,
  "createdAt": "2026-09-22T12:00:00Z",
  "updatedAt": "2026-09-22T12:00:00Z",
  "readyAt": "2026-09-22T12:00:00Z"
}

The voice provider key object

Attributes

  • idstring (uuid)required

    Identifier for this resource.

  • projectIdstring (uuid)requirednullable

    The project that may use the key, or null for every project of the team.

  • providerstringrequired

    Specifies provider for this management platform access voice provider credential.

    Allowed valueselevenlabsopenai
  • labelstringrequired

    Specifies label for this management platform access voice provider credential.

  • keyFingerprintstringrequired

    First 8 hex characters of the SHA-256 of the key. The key itself is never returned.

  • statusstringrequired

    Current status of this resource or operation.

    Allowed valuesunverifiedvalidinvalid
  • verifiedAtstring (date-time)requirednullable

    Timestamp for verified at.

  • lastErrorstringrequirednullable

    Specifies last error for this management platform access voice provider credential.

    Allowed valuesunauthorizedquota_exceededforbidden_scopeprovider_unavailable
  • revisionintegerrequired

    Specifies revision for this management platform access voice provider credential.

  • createdAtstring (date-time)required

    ISO 8601 timestamp when this resource was created.

  • updatedAtstring (date-time)required

    ISO 8601 timestamp when this resource was last updated.

The voice provider key object
{
  "id": "00000000-0000-4000-8000-000000000000",
  "projectId": "00000000-0000-4000-8000-000000000000",
  "provider": "elevenlabs",
  "label": "string",
  "keyFingerprint": "string",
  "status": "unverified",
  "verifiedAt": "2026-09-22T12:00:00Z",
  "lastError": "unauthorized",
  "revision": 0,
  "createdAt": "2026-09-22T12:00:00Z",
  "updatedAt": "2026-09-22T12:00:00Z"
}

Create voice audio upload

POST/platform/voice/audioPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Creates an audio asset and returns a URL to send the file to. Send the file with POST and the returned headers within 5 minutes, then call POST /platform/voice/audio/{assetId}/complete. MP3, WAV, OGG (Opus or Vorbis) and M4A (AAC), up to 16 MB and 10 minutes of audio.

Body

  • projectIdstring (uuid)

    Project that owns the asset. Required for team keys.

  • namestringrequiredlength1–100

    Human-readable name for this resource.

  • contentTypestringrequired

    IANA media type that matches the payload.

    • Media type: IANA type/subtype value matching the payload, such as audio/ogg, audio/mpeg, or audio/aac

    Allowed valuesaudio/mpegaudio/wavaudio/x-wavaudio/oggaudio/mp4audio/x-m4a
  • sizeBytesintegerrequiredrange1–16777216

    File size in bytes, at most 16 MB.

  • retentionDaysintegerrange1–3650

    Delete the asset automatically this many days after creation (1 to 3650). Omit to keep it until you delete it.

Responses

  • 201Asset created in `pending_upload`, with the upload URL.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 2 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 402`gate_limit_reached`: a Voice Automation limit is enforced and reached.
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 409`state_conflict`: the project already holds 500 audio assets.
  • 500Internal server error
  • 503`voice_unavailable`: audio storage is not configured. `provider_unavailable`: the voice provider did not answer.
POST /platform/voice/audiocURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/voice/audio" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "contentType": "audio/mpeg",
  "sizeBytes": 1
}'
Response
{
  "success": true,
  "data": {
    "asset": {
      "id": "00000000-0000-4000-8000-000000000000",
      "projectId": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "source": "upload",
      "status": "pending_upload",
      "failureReason": "unsupported_format",
      "originalFormat": "mp3",
      "originalContentType": "string",
      "sizeBytes": 0,
      "durationMs": 0,
      "contentSha256": "string",
      "tts": {
        "provider": "elevenlabs",
        "voiceId": "string",
        "model": "string",
        "text": "string",
        "characters": 0,
        "keySource": "managed",
        "credentialId": "00000000-0000-4000-8000-000000000000"
      },
      "retentionDays": 0,
      "expiresAt": "2026-09-22T12:00:00Z",
      "inUseCount": 0,
      "revision": 0,
      "createdAt": "2026-09-22T12:00:00Z",
      "updatedAt": "2026-09-22T12:00:00Z",
      "readyAt": "2026-09-22T12:00:00Z"
    },
    "upload": {
      "url": "https://example.com",
      "method": "POST",
      "headers": {},
      "maxBytes": 0,
      "expiresAt": "2026-09-22T12:00:00Z"
    }
  }
}

Create voice provider credential

POST/platform/voice/provider-credentialsPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Stores your ElevenLabs or OpenAI API key, encrypted, after checking it with the provider. A key the provider rejects is not stored. When the provider cannot be reached the key is stored with status unverified. The key is never returned.

Body

  • providerstringrequired

    Specifies provider for this management platform access create voice provider credential request.

    Allowed valueselevenlabsopenai
  • labelstringrequiredlength1–100

    Specifies label for this management platform access create voice provider credential request.

  • apiKeystringrequiredlength1–512

    The provider API key. Write-only: it is never returned.

  • projectIdstring (uuid)nullable

    Limit the key to one project. Null or omitted makes it available to every project; project tokens must use their own project.

Responses

  • 201Credential stored.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 11 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 402`gate_limit_reached`: a Voice Automation limit is enforced and reached.
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 409`state_conflict`: the same key is already stored for this provider and project, or the team holds 50 credentials.
  • 422`provider_credential_invalid`: the provider rejected the key.
  • 500Internal server error
  • 503`voice_unavailable`: credential storage is not configured.
POST /platform/voice/provider-credentialscURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/voice/provider-credentials" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "elevenlabs",
  "label": "string",
  "apiKey": "string"
}'
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "provider": "elevenlabs",
    "label": "string",
    "keyFingerprint": "string",
    "status": "unverified",
    "verifiedAt": "2026-09-22T12:00:00Z",
    "lastError": "unauthorized",
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z"
  }
}

List voice audio

GET/platform/voice/audioPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:read

Lists a project's audio assets, newest first.

Query parameters

  • projectIdstring (uuid)

    Identifier of the Polymorfa project that owns this resource.

  • statusstring

    Current status of this resource or operation.

    Allowed valuespending_uploaduploadedtranscodingreadyfailed
  • cursorstringmax length200

    Specifies cursor for this query parameter.

  • limitintegerrange1–100

    Specifies limit for this query parameter.

Responses

  • 200A page of audio assets.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured data carried by this object.

      Show 19 child fields
    • pageobjectrequired

      Specifies page for this management platform access list voice audio response.

      Show 2 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
GET /platform/voice/audiocURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/voice/audio" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "projectId": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "source": "upload",
      "status": "pending_upload",
      "failureReason": "unsupported_format",
      "originalFormat": "mp3",
      "originalContentType": "string",
      "sizeBytes": 0,
      "durationMs": 0,
      "contentSha256": "string",
      "tts": {
        "provider": "elevenlabs",
        "voiceId": "string",
        "model": "string",
        "text": "string",
        "characters": 0,
        "keySource": "managed",
        "credentialId": "00000000-0000-4000-8000-000000000000"
      },
      "retentionDays": 0,
      "expiresAt": "2026-09-22T12:00:00Z",
      "inUseCount": 0,
      "revision": 0,
      "createdAt": "2026-09-22T12:00:00Z",
      "updatedAt": "2026-09-22T12:00:00Z",
      "readyAt": "2026-09-22T12:00:00Z"
    }
  ],
  "page": {
    "nextCursor": "string",
    "hasMore": true
  }
}

List voice provider credentials

GET/platform/voice/provider-credentialsPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:read

Lists your stored ElevenLabs and OpenAI keys. Keys are never returned; keyFingerprint identifies them.

Query parameters

  • projectIdstring (uuid)

    Identifier of the Polymorfa project that owns this resource.

Responses

  • 200Provider credentials in creation order.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured data carried by this object.

      Show 11 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
GET /platform/voice/provider-credentialscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/voice/provider-credentials" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "projectId": "00000000-0000-4000-8000-000000000000",
      "provider": "elevenlabs",
      "label": "string",
      "keyFingerprint": "string",
      "status": "unverified",
      "verifiedAt": "2026-09-22T12:00:00Z",
      "lastError": "unauthorized",
      "revision": 0,
      "createdAt": "2026-09-22T12:00:00Z",
      "updatedAt": "2026-09-22T12:00:00Z"
    }
  ]
}

Get voice audio

GET/platform/voice/audio/{assetId}Platform API
Base URL
https://api.polymorfa.com
Required permission
voice:read

Path parameters

  • assetIdstring (uuid)required

    Identifier for the asset.

Responses

  • 200The audio asset.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 19 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
GET /platform/voice/audio/{assetId}cURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/voice/audio/<assetId>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "source": "upload",
    "status": "pending_upload",
    "failureReason": "unsupported_format",
    "originalFormat": "mp3",
    "originalContentType": "string",
    "sizeBytes": 0,
    "durationMs": 0,
    "contentSha256": "string",
    "tts": {
      "provider": "elevenlabs",
      "voiceId": "string",
      "model": "string",
      "text": "string",
      "characters": 0,
      "keySource": "managed",
      "credentialId": "00000000-0000-4000-8000-000000000000"
    },
    "retentionDays": 0,
    "expiresAt": "2026-09-22T12:00:00Z",
    "inUseCount": 0,
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z",
    "readyAt": "2026-09-22T12:00:00Z"
  }
}

Get voice audio preview

GET/platform/voice/audio/{assetId}/previewPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:read

Returns a URL, valid for 5 minutes, to an Opus-in-Ogg preview of a ready asset for playback.

Path parameters

  • assetIdstring (uuid)required

    Identifier for the asset.

Responses

  • 200Preview URL.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 3 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 409`asset_not_ready`: the asset is not `ready`.
  • 500Internal server error
  • 503`voice_unavailable`: audio storage is not configured. `provider_unavailable`: the voice provider did not answer.
GET /platform/voice/audio/{assetId}/previewcURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/voice/audio/<assetId>/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "url": "https://example.com",
    "contentType": "audio/ogg",
    "expiresAt": "2026-09-22T12:00:00Z"
  }
}

Get voice provider credential

GET/platform/voice/provider-credentials/{credentialId}Platform API
Base URL
https://api.polymorfa.com
Required permission
voice:read

Path parameters

  • credentialIdstring (uuid)required

    Identifier for the credential.

Responses

  • 200The credential, without its key.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 11 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
GET /platform/voice/provider-credentials/{credentialId}cURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/voice/provider-credentials/<credentialId>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "provider": "elevenlabs",
    "label": "string",
    "keyFingerprint": "string",
    "status": "unverified",
    "verifiedAt": "2026-09-22T12:00:00Z",
    "lastError": "unauthorized",
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z"
  }
}

Update voice audio

PATCH/platform/voice/audio/{assetId}Platform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Renames an asset or changes its retention. Send expectedRevision to refuse the change with 409 voice_asset_revision_conflict when the asset changed since you read it.

Path parameters

  • assetIdstring (uuid)required

    Identifier for the asset.

Body

  • expectedRevisionintegermin1

    Apply the change only if the asset still has this revision.

  • namestringlength1–100

    Human-readable name for this resource.

  • retentionDaysintegernullablerange1–3650

    Null removes automatic deletion. Retention counts from creation.

Responses

  • 200The updated asset.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 19 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 409`voice_asset_revision_conflict`: the asset changed after `expectedRevision`.
  • 500Internal server error
PATCH /platform/voice/audio/{assetId}cURL
Not available with the Test key. Use a team key or project token.
curl -X PATCH "https://api.polymorfa.com/platform/voice/audio/<assetId>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedRevision": 1,
  "name": "string",
  "retentionDays": 1
}'
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "source": "upload",
    "status": "pending_upload",
    "failureReason": "unsupported_format",
    "originalFormat": "mp3",
    "originalContentType": "string",
    "sizeBytes": 0,
    "durationMs": 0,
    "contentSha256": "string",
    "tts": {
      "provider": "elevenlabs",
      "voiceId": "string",
      "model": "string",
      "text": "string",
      "characters": 0,
      "keySource": "managed",
      "credentialId": "00000000-0000-4000-8000-000000000000"
    },
    "retentionDays": 0,
    "expiresAt": "2026-09-22T12:00:00Z",
    "inUseCount": 0,
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z",
    "readyAt": "2026-09-22T12:00:00Z"
  }
}

Synthesize voice audio

POST/platform/voice/audio/ttsPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Generates speech from text with ElevenLabs or OpenAI and stores it as an audio asset. Without credentialId Polymorfa's provider key is used; with it, your stored key for that provider. The provider processes the text. The asset converts asynchronously like an upload.

Body

  • projectIdstring (uuid)

    Project that owns the asset. Required for team keys.

  • namestringrequiredlength1–100

    Human-readable name for this resource.

  • textstringrequiredlength1–5000

    Text to speak: up to 5,000 characters for ElevenLabs and 4,096 for OpenAI.

  • providerstringrequired

    Specifies provider for this management platform access synthesize voice audio request.

    Allowed valueselevenlabsopenai
  • voiceIdstringrequiredlength1–64

    ElevenLabs voice ID, or an OpenAI voice name such as alloy.

  • modelstringlength1–64

    ElevenLabs: eleven_multilingual_v2 (default), eleven_flash_v2_5, eleven_turbo_v2_5. OpenAI: gpt-4o-mini-tts (default), tts-1, tts-1-hd.

  • credentialIdstring (uuid)

    Use your stored key for the provider. Omit to use Polymorfa's key.

  • retentionDaysintegerrange1–3650

    Specifies retention days for this management platform access synthesize voice audio request.

Responses

  • 201Asset created, now `transcoding`.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 19 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 402`gate_limit_reached`: a Voice Automation limit is enforced and reached.
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 409`state_conflict`: the project already holds 500 audio assets.
  • 422`provider_credential_invalid`: the provider rejected your stored key.
  • 500Internal server error
  • 503`voice_unavailable`: audio storage is not configured. `provider_unavailable`: the voice provider did not answer.
POST /platform/voice/audio/ttscURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/voice/audio/tts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "text": "string",
  "provider": "elevenlabs",
  "voiceId": "string"
}'
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "source": "upload",
    "status": "pending_upload",
    "failureReason": "unsupported_format",
    "originalFormat": "mp3",
    "originalContentType": "string",
    "sizeBytes": 0,
    "durationMs": 0,
    "contentSha256": "string",
    "tts": {
      "provider": "elevenlabs",
      "voiceId": "string",
      "model": "string",
      "text": "string",
      "characters": 0,
      "keySource": "managed",
      "credentialId": "00000000-0000-4000-8000-000000000000"
    },
    "retentionDays": 0,
    "expiresAt": "2026-09-22T12:00:00Z",
    "inUseCount": 0,
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z",
    "readyAt": "2026-09-22T12:00:00Z"
  }
}

Complete voice audio upload

POST/platform/voice/audio/{assetId}/completePlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Confirms that the file was sent and starts conversion. The asset moves to transcoding, then to ready or failed; the voice.asset_ready or voice.asset_failed webhook reports the result.

Path parameters

  • assetIdstring (uuid)required

    Identifier for the asset.

Responses

  • 200The asset, now `transcoding`.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 19 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 409`state_conflict`: the asset is not waiting for an upload, or the file was not received.
  • 500Internal server error
  • 503`voice_unavailable`: audio storage is not configured. `provider_unavailable`: the voice provider did not answer.
POST /platform/voice/audio/{assetId}/completecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/voice/audio/<assetId>/complete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "source": "upload",
    "status": "pending_upload",
    "failureReason": "unsupported_format",
    "originalFormat": "mp3",
    "originalContentType": "string",
    "sizeBytes": 0,
    "durationMs": 0,
    "contentSha256": "string",
    "tts": {
      "provider": "elevenlabs",
      "voiceId": "string",
      "model": "string",
      "text": "string",
      "characters": 0,
      "keySource": "managed",
      "credentialId": "00000000-0000-4000-8000-000000000000"
    },
    "retentionDays": 0,
    "expiresAt": "2026-09-22T12:00:00Z",
    "inUseCount": 0,
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z",
    "readyAt": "2026-09-22T12:00:00Z"
  }
}

Verify voice provider credential

POST/platform/voice/provider-credentials/{credentialId}/verifyPlatform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Checks the stored key with the provider again and records the result in status, verifiedAt and lastError.

Path parameters

  • credentialIdstring (uuid)required

    Identifier for the credential.

Responses

  • 200The credential with the new result.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 11 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403`voice_not_enabled`: the team is not enrolled in the Voice Automation beta. Also `permission_denied` and `missing_scope`.
  • 404Resource not found
  • 500Internal server error
  • 503`voice_unavailable`: credential storage is not configured.
POST /platform/voice/provider-credentials/{credentialId}/verifycURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/voice/provider-credentials/<credentialId>/verify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "projectId": "00000000-0000-4000-8000-000000000000",
    "provider": "elevenlabs",
    "label": "string",
    "keyFingerprint": "string",
    "status": "unverified",
    "verifiedAt": "2026-09-22T12:00:00Z",
    "lastError": "unauthorized",
    "revision": 0,
    "createdAt": "2026-09-22T12:00:00Z",
    "updatedAt": "2026-09-22T12:00:00Z"
  }
}

Delete voice audio

DELETE/platform/voice/audio/{assetId}Platform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Deletes the asset and its stored audio. Returns 409 voice_asset_in_use while a campaign or flow uses it.

Path parameters

  • assetIdstring (uuid)required

    Identifier for the asset.

Responses

  • 200Asset deleted.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 2 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 409`voice_asset_in_use`: a campaign or flow uses the asset.
  • 500Internal server error
DELETE /platform/voice/audio/{assetId}cURL
Not available with the Test key. Use a team key or project token.
curl -X DELETE "https://api.polymorfa.com/platform/voice/audio/<assetId>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "deleted": true
  }
}

Delete voice provider credential

DELETE/platform/voice/provider-credentials/{credentialId}Platform API
Base URL
https://api.polymorfa.com
Required permission
voice:manage

Deletes the stored key. Requests that name it with credentialId fail afterwards.

Path parameters

  • credentialIdstring (uuid)required

    Identifier for the credential.

Responses

  • 200Credential deleted.
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 2 child fields
    Show 3 headers
  • 400Bad request — request body or params failed validation
  • 401Missing or invalid authentication token
  • 403Authenticated but not permitted (missing scope or rule violation)
  • 404Resource not found
  • 500Internal server error
DELETE /platform/voice/provider-credentials/{credentialId}cURL
Not available with the Test key. Use a team key or project token.
curl -X DELETE "https://api.polymorfa.com/platform/voice/provider-credentials/<credentialId>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "deleted": true
  }
}