API reference

Autenticação da API

Aprenda a autenticar suas solicitações à API da ElevenLabs

Chaves de API

A API da ElevenLabs usa chaves de API para autenticação. Todas as solicitações à API devem incluir sua chave de API, usada para autenticar suas solicitações e acompanhar a cota de uso.

Cada chave de API pode ser configurada com as seguintes restrições:

  1. Restrição de escopo: defina restrições de acesso limitando quais endpoints da API a chave pode acessar.
  2. Cota de créditos: defina limites personalizados de créditos para controlar o uso.
  3. Lista de permissões de IP: restrinja a chave a endereços IP ou intervalos CIDR específicos. Solicitações de IPs que não estão na lista de permissões são rejeitadas com um erro 403. Saiba mais.

Lembre-se de que sua chave de API é secreta. Não a compartilhe com outras pessoas nem a exponha em códigos do lado do cliente (navegadores, apps).

Todas as solicitações à API devem incluir sua chave de API no cabeçalho HTTP xi-api-key, da seguinte forma:

xi-api-key: ELEVENLABS_API_KEY

Como fazer solicitações

Você pode colar o comando abaixo no terminal para executar sua primeira solicitação à API. Substitua $ELEVENLABS_API_KEY pela sua chave de API secreta.

curl 'https://api.elevenlabs.io/v1/models' \
  -H 'Content-Type: application/json' \
  -H 'xi-api-key: $ELEVENLABS_API_KEY'

Exemplo com o pacote Python elevenlabs:

from elevenlabs.client import ElevenLabs
elevenlabs = ElevenLabs(
  api_key='YOUR_API_KEY',
)

Exemplo com o pacote Node.js elevenlabs:

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
const elevenlabs = new ElevenLabsClient({
  apiKey: "YOUR_API_KEY",
});

Tokens de uso único

Para determinados endpoints, você pode usar tokens de uso único para autenticar suas solicitações. Esses tokens são válidos por tempo limitado e podem ser usados para se conectar à API sem expor sua chave de API, por exemplo, pelo lado do cliente.

Consulte a documentação sobre tokens de uso único para mais informações.