Perfil

Use endpoints de perfil para inspecionar o ID da conta do proprietário da chave API, nível, créditos e cota API restante. Chame esse endpoint antes de grandes lotes, após trabalhos importantes e durante verificações operacionais.

Obter perfil

GET /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY

Solicitar

A solicitação não requer um corpo.

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer FISHAUDIO_API_KEY"

Resposta

{
  "user_id": "user_123",
  "api_quota_remaining": 988000,
  "tier": "pro",
  "credits": 1200
}

Trate os campos desconhecidos como aditivos e evite falhas nos analisadores estritos quando a resposta obtiver novos metadados de conta ou cobrança.

Atualizar perfil

POST /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY
Content-Type: application/json

{
  "webhookUrl": "https://example.com/webhooks/fishspeech"
}

Os campos atualizáveis ​​são controlados pelo servidor. Campos desconhecidos podem ser ignorados ou rejeitados. Mantenha as atualizações de perfil separadas da criação do trabalho de mídia para que um erro de validação de perfil não possa bloquear o trabalho de geração não relacionado.

Faturamento e créditos

O endpoint do perfil é a verificação leve mais segura antes de um lote. Pode mostrar se é provável que a conta tenha créditos ou cota suficientes para a próxima operação, mas não é um sistema de reservas. Entre o seu cheque e a solicitação da mídia, outros trabalhadores poderão consumir saldo.

Para fluxos de trabalho críticos, armazene o instantâneo do perfil com o ID do lote. Se um trabalho falhar posteriormente por motivos de cota, esse instantâneo ajudará a distinguir um saldo baixo pré-existente do uso simultâneo por outro processo.

Erros