Música

Obter Status da Música

Recupera o status e o resultado de uma tarefa de geração de música

GET
/v1/tasks/{id}

GET /v1/music/generations/{id} é um endpoint de compatibilidade. Ele permanece suportado para integrações existentes. Novas integrações devem consultar GET /v1/tasks/{id}; veja Obter Status da Tarefa.

Chame GET /v1/tasks/{id} para verificar o status da sua tarefa de geração de música.

id e task_id identificam a mesma tarefa.

Uma tarefa pública expirada ou indisponível pode retornar 404 async_task_not_found. Se a propriedade da tarefa não puder ser estabelecida para a API key atual, a resposta será 403 task_not_owned.

Parâmetros de Caminho

idstringpathobrigatório

O ID da tarefa de geração de música.

Resposta

idstring

ID da tarefa.

task_idstring

Alias do mesmo ID de tarefa assíncrona, quando retornado.

poll_urlstring

URL de status para esta tarefa. Consulte GET /v1/tasks/{id} com o id.

statusstring

Status da tarefa: pending, processing, completed, failed ou timeout. Uma tarefa com falha ainda retorna HTTP 200.

progressinteger

Valor de progresso opcional. Retornado apenas quando um valor de progresso real está disponível; use status para determinar a conclusão.

Os campos de resultado dependem da operação. Músicas podem retornar audio_url e audio_id; tarefas apenas de letra retornam lyrics; a separação pode retornar múltiplos arquivos em data. video_url, título, progresso e outros metadados são opcionais. Verifique o status para conclusão e leia os campos efetivamente retornados.

audio_idstring

ID de áudio de origem opcional, utilizável com o ID desta tarefa em operações de acompanhamento suportadas.

dataarray

Array de saída opcional, incluindo arquivos de áudio separados com audio_url ou url.

audio_urlstring

URL para baixar o arquivo de áudio (quando concluído). Um link de resultado de mídia TokenLab que permanece válido por 30 dias.

video_urlstring

URL para a versão em vídeo com visualizador (quando concluído e retornado pelo modelo).

image_urlstring

URL da imagem de capa, quando o modelo retorna uma.

titlestring

Título da música gerada.

lyricsstring

Letra gerada ou fornecida.

errorstring | object

Mensagem de erro (quando falha).

error_detailsobject

Detalhes da falha quando a tarefa falhou: status, message, type, code, retryable e param quando um campo da requisição é o causador do erro.

media_retentionobject

Status de salvamento dos links de resultado: days e items[] com url, kind, status e expires_at. Pode estar ausente; os links continuam funcionando. Veja Retenção de dados.

Requisição

curl --fail-with-body "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

Resposta

Response (Completed)
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "completed",
  "audio_url": "https://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
  "title": "Night Drive",
  "lyrics": "[Verse 1]\nDriving through the night...",
  "audio_id": "audio_abc123",
  "media_retention": {
    "days": 30,
    "items": [
      {
        "url": "https://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
        "kind": "audio",
        "content_type": "audio/mpeg",
        "status": "saved",
        "expires_at": "2024-02-22T08:54:20.000Z"
      }
    ]
  }
}

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Parâmetros de caminho

id*string

O ID da tarefa assíncrona retornado por id / task_id, ou incorporado na poll_url

Resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json