Voices

Save the organization's ElevenLabs API key

Changed on

Saves or replaces the organization's ElevenLabs API key, for voices that only exist in its own ElevenLabs account: instant clones, Voice Design voices and Professional Voice Clones. Anam checks the key with ElevenLabs on each of its API hosts, including data-residency hosts, and stores it encrypted. Afterwards, POST /v1/voice-imports with useOrganizationKey: true imports a voice that speaks with it, and ElevenLabs bills that speech to the key's account. The key needs Text to Speech access, which Anam checks without generating speech.

put/v1/voices/elevenlabs-key

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/voices/elevenlabs-key
  • Auth
    HTTP bearer

Request body

apiKeystring required

An ElevenLabs API key with Text to Speech access. Never returned.

Response

The key was saved. Returns the new status.

enabledboolean required

Always true: every organization can save a key and import voices with useOrganizationKey. Kept for existing clients.

savedboolean required

Whether a key is saved.

hintstring nullable required

The saved key's last four characters.

voiceCountinteger required

Voices that speak with the key.

lastValidatedAtstring date-time nullable required

When Anam last checked the key with ElevenLabs.

lastUsedAtstring date-time nullable required

When a session last started with the key, recorded at most hourly.

Changes

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • warning

      added the new elevenlabs_key_missing_permissions enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status