> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Get voice audio > **Required scope:** `voice:read` ## OpenAPI ````yaml api-reference/features/communicate.json GET /platform/voice/audio/{assetId} openapi: 3.0.3 info: title: Communicate API methods version: 1.0.0 description: >- Task-focused communicate methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/voice/audio/{assetId}: get: tags: - Voice summary: Get voice audio description: '**Required scope:** `voice:read`' operationId: managementGetVoiceAudio parameters: - schema: type: string format: uuid required: true name: assetId in: path description: |- Identifier for the asset. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | responses: '200': description: The audio asset. content: application/json: schema: $ref: >- #/components/schemas/management__PlatformAccessGetVoiceAudioResponse '400': description: Bad request — request body or params failed validation content: application/json: schema: $ref: '#/components/schemas/management__PlatformAccessPublicError' example: error: type: invalid_request_error code: invalid_parameter message: Correct the invalid request field. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#invalid-parameter '401': description: Missing or invalid authentication token content: application/json: schema: $ref: '#/components/schemas/management__PlatformAccessPublicError' example: error: type: authentication_error code: invalid_credential message: Supply a valid credential. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#invalid-credential '403': description: Authenticated but not permitted (missing scope or rule violation) content: application/json: schema: $ref: '#/components/schemas/management__PlatformAccessPublicError' example: error: type: permission_error code: permission_denied message: The credential does not have access to this resource. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#permission-denied '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/management__PlatformAccessPublicError' example: error: type: invalid_request_error code: resource_not_found message: The resource is unavailable to this caller. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#resource-not-found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/management__PlatformAccessPublicError' example: error: type: api_error code: internal_error message: >- An unexpected service failure occurred. Keep the request ID for support. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#internal-error security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__PlatformAccessGetVoiceAudioResponse: type: object properties: success: type: boolean enum: - true description: |- Whether the request succeeded. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | data: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceAudioAsset' description: Structured data carried by this object. required: - success - data management__PlatformAccessPublicError: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string enum: - invalid_parameter - invalid_credential - entitlement_required - gate_limit_reached - method_not_allowed - permission_denied - missing_scope - resource_not_found - hms_not_enabled - media_fetch_failed - resource_gone - feature_unavailable - stream_cursor_invalid - stream_cursor_expired - stream_connection_limit_reached - state_conflict - idempotency_conflict - idempotency_in_progress - idempotency_completed - idempotency_outcome_unknown - call_claimed - call_not_ringing - connection_limit - unsupported_for_connection - call_permission_required - invalid_sip_trunk - calls_disabled - call_recipient_opted_out - call_destination_blocked - call_permission_request_limited - call_permission_granted - call_opt_out_limit - number_restricted - sip_trunk_in_use - sip_trunk_revision_conflict - sip_trunk_limit - sip_unavailable - voice_not_enabled - provider_credential_invalid - provider_unavailable - asset_not_ready - voice_asset_in_use - voice_asset_revision_conflict - voice_unavailable - rate_limit_exceeded - internal_error - operation_not_supported - upstream_failure - service_unavailable - credential_verification_unavailable - session_not_ready - command_dispatch_failed - result_unknown - recipient_not_on_whatsapp - conversation_window_closed - template_not_approved - media_too_large - whatsapp_rate_limited - new_chat_limit_reached - whatsapp_account_restricted - bansafe_suspended - bansafe_org_suspended - bansafe_cold_blocked - bansafe_cold_held - bansafe_throttled - bansafe_daily_allowance_reached - bansafe_accounting_unavailable - bansafe_send_outcome_unknown - campaigns_not_entitled - campaign_throughput_capped description: >- Stable machine-readable code for this result. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_parameter` | Invalid parameter. | | `invalid_credential` | Invalid credential. | | `entitlement_required` | Entitlement required. | | `gate_limit_reached` | Gate limit reached. | | `method_not_allowed` | Method not allowed. | | `permission_denied` | Permission denied. | | `missing_scope` | Missing scope. | | `resource_not_found` | Resource not found. | | `hms_not_enabled` | Hms not enabled. | | `media_fetch_failed` | Media fetch failed. | | `resource_gone` | Resource gone. | | `feature_unavailable` | Feature unavailable. | | `stream_cursor_invalid` | Stream cursor invalid. | | `stream_cursor_expired` | Stream cursor expired. | | `stream_connection_limit_reached` | Stream connection limit reached. | | `state_conflict` | State conflict. | | `idempotency_conflict` | Idempotency conflict. | | `idempotency_in_progress` | Idempotency in progress. | | `idempotency_completed` | Idempotency completed. | | `idempotency_outcome_unknown` | Idempotency outcome unknown. | | `call_claimed` | Call claimed. | | `call_not_ringing` | Call not ringing. | | `connection_limit` | Connection limit. | | `unsupported_for_connection` | Unsupported for connection. | | `call_permission_required` | Call permission required. | | `invalid_sip_trunk` | Invalid sip trunk. | | `calls_disabled` | Calls disabled. | | `call_recipient_opted_out` | Call recipient opted out. | | `call_destination_blocked` | Call destination blocked. | | `call_permission_request_limited` | Call permission request limited. | | `call_permission_granted` | Call permission granted. | | `call_opt_out_limit` | Call opt out limit. | | `number_restricted` | Number restricted. | | `sip_trunk_in_use` | Sip trunk in use. | | `sip_trunk_revision_conflict` | Sip trunk revision conflict. | | `sip_trunk_limit` | Sip trunk limit. | | `sip_unavailable` | Sip unavailable. | | `voice_not_enabled` | Voice not enabled. | | `provider_credential_invalid` | Provider credential invalid. | | `provider_unavailable` | Provider unavailable. | | `asset_not_ready` | Asset not ready. | | `voice_asset_in_use` | Voice asset in use. | | `voice_asset_revision_conflict` | Voice asset revision conflict. | | `voice_unavailable` | Voice unavailable. | | `rate_limit_exceeded` | Rate limit exceeded. | | `internal_error` | Internal error. | | `operation_not_supported` | Operation not supported. | | `upstream_failure` | Upstream failure. | | `service_unavailable` | Service unavailable. | | `credential_verification_unavailable` | Credential verification unavailable. | | `session_not_ready` | Session not ready. | | `command_dispatch_failed` | Command dispatch failed. | | `result_unknown` | Result unknown. | | `recipient_not_on_whatsapp` | Recipient not on whatsapp. | | `conversation_window_closed` | Conversation window closed. | | `template_not_approved` | Template not approved. | | `media_too_large` | Media too large. | | `whatsapp_rate_limited` | Whatsapp rate limited. | | `new_chat_limit_reached` | New chat limit reached. | | `whatsapp_account_restricted` | Whatsapp account restricted. | | `bansafe_suspended` | Bansafe suspended. | | `bansafe_org_suspended` | Bansafe org suspended. | | `bansafe_cold_blocked` | Bansafe cold blocked. | | `bansafe_cold_held` | Bansafe cold held. | | `bansafe_throttled` | Bansafe throttled. | | `bansafe_daily_allowance_reached` | Bansafe daily allowance reached. | | `bansafe_accounting_unavailable` | Bansafe accounting unavailable. | | `bansafe_send_outcome_unknown` | Bansafe send outcome unknown. | | `campaigns_not_entitled` | Campaigns not entitled. | | `campaign_throughput_capped` | Campaign throughput capped. | message: type: string description: Human-readable message associated with this result. param: type: string nullable: true description: |- Specifies param for this error. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - type - code - message - param - request_id description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Specifies docs for this management platform access public error. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - error - data - docs management__PlatformAccessVoiceAudioAsset: type: object properties: id: type: string format: uuid description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | projectId: type: string format: uuid description: |- Identifier of the Polymorfa project that owns this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | name: type: string description: Human-readable name for this resource. source: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceAudioSource' description: >- Specifies source for this management platform access voice audio asset. **Allowed values** | Value | Meaning | | --- | --- | | `upload` | Upload. | | `tts` | Tts. | status: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceAudioStatus' description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `pending_upload` | Pending upload. | | `uploaded` | Uploaded. | | `transcoding` | Transcoding. | | `ready` | Ready. | | `failed` | Failed. | failureReason: allOf: - $ref: >- #/components/schemas/management__PlatformAccessVoiceAudioFailureReason description: >- Specifies failure reason for this management platform access voice audio asset. **Allowed values** | Value | Meaning | | --- | --- | | `unsupported_format` | Unsupported format. | | `too_large` | Too large. | | `too_long` | Too long. | | `decode_failed` | Decode failed. | | `silent` | Silent. | | `tts_failed` | Tts failed. | | `processing_failed` | Processing failed. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `unsupported_format` or `too_large` or `too_long` or `decode_failed` or `silent` or `tts_failed` or `processing_failed` | | Alternative 2 | `null` | originalFormat: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceAudioFormat' description: >- Specifies original format for this management platform access voice audio asset. **Allowed values** | Value | Meaning | | --- | --- | | `mp3` | Mp3. | | `wav` | Wav. | | `ogg` | Ogg. | | `m4a` | M4a. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `mp3` or `wav` or `ogg` or `m4a` | | Alternative 2 | `null` | originalContentType: type: string nullable: true description: |- Category assigned to original content. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | sizeBytes: type: integer nullable: true description: |- Size of the original file in bytes. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | durationMs: type: integer nullable: true description: |- Length of the converted audio, set when `ready`. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | contentSha256: type: string nullable: true description: >- SHA-256 (hex) of the converted 16 kHz mono PCM audio, set when `ready`. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | tts: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceAudioTts' description: >- Specifies tts for this management platform access voice audio asset. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `provider`: `elevenlabs` or `openai`; Field `keySource`: `managed` or `customer`; Required fields: `provider`, `voiceId`, `model`, `text`, `characters`, `keySource`, `credentialId` | | Alternative 2 | `null` | retentionDays: type: integer nullable: true description: >- Days after creation when the asset is deleted automatically. Null keeps it until you delete it. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | expiresAt: type: string nullable: true format: date-time description: |- ISO 8601 timestamp when this resource expires. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Format: `date-time` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `date-time` | inUseCount: type: integer description: >- Campaigns and flows that use the asset. An asset in use cannot be deleted or expire. revision: type: integer description: >- Changes when you rename the asset or change its retention. Send it as `expectedRevision` to avoid overwriting another change. createdAt: type: string format: date-time description: |- ISO 8601 timestamp when this resource was created. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `date-time` | updatedAt: type: string format: date-time description: |- ISO 8601 timestamp when this resource was last updated. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `date-time` | readyAt: type: string nullable: true format: date-time description: |- Timestamp for ready at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Format: `date-time` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `date-time` | required: - id - projectId - name - source - status - failureReason - originalFormat - originalContentType - sizeBytes - durationMs - contentSha256 - tts - retentionDays - expiresAt - inUseCount - revision - createdAt - updatedAt - readyAt management__PlatformAccessVoiceAudioSource: type: string enum: - upload - tts management__PlatformAccessVoiceAudioStatus: type: string enum: - pending_upload - uploaded - transcoding - ready - failed description: >- `pending_upload`: waiting for the file. `uploaded` and `transcoding`: being converted. `ready`: usable. `failed`: see `failureReason`. Treat unknown values as `failed`. management__PlatformAccessVoiceAudioFailureReason: type: string nullable: true enum: - unsupported_format - too_large - too_long - decode_failed - silent - tts_failed - processing_failed - null management__PlatformAccessVoiceAudioFormat: type: string nullable: true enum: - mp3 - wav - ogg - m4a - null description: Container of the original file, known after conversion. management__PlatformAccessVoiceAudioTts: type: object nullable: true properties: provider: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceProvider' description: >- Specifies provider for this management platform access voice audio tt. **Allowed values** | Value | Meaning | | --- | --- | | `elevenlabs` | Elevenlabs. | | `openai` | Openai. | voiceId: type: string description: ElevenLabs voice ID or OpenAI voice name. model: type: string description: Specifies model for this management platform access voice audio tt. text: type: string description: The text that was spoken. characters: type: integer description: Characters sent to the provider. keySource: allOf: - $ref: '#/components/schemas/management__PlatformAccessVoiceKeySource' description: >- Specifies key source for this management platform access voice audio tt. **Allowed values** | Value | Meaning | | --- | --- | | `managed` | Managed. | | `customer` | Customer. | credentialId: type: string nullable: true format: uuid description: |- Your provider credential, when `keySource` is `customer`. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Format: `uuid` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | required: - provider - voiceId - model - text - characters - keySource - credentialId description: How the speech was generated. Null for uploads. management__PlatformAccessVoiceProvider: type: string enum: - elevenlabs - openai management__PlatformAccessVoiceKeySource: type: string enum: - managed - customer description: '`managed`: Polymorfa''s provider key. `customer`: your stored key.' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ````