Audio TTS API

Início rápido

Autenticação

Adicione o cabeçalho Authorization a todas as solicitações:

Authorization: Bearer YOUR_API_KEY

Endpoints

Callback de webhook (callback_url)

Inclua callback_url na solicitação de criação. Quando a tarefa atinge o estado terminal completed ou failed, nosso servidor envia um único HTTP POST para essa URL com Content-Type: application/json (sem cabeçalho de assinatura). A entrega é repetida até 3 vezes (recuo exponencial 1s/2s/4s, 10s por tentativa); se ainda não tiver êxito, um job em segundo plano continua tentando por até 30 minutos até que seu endpoint retorne 2xx.

Estrutura do payload

POST {your callback_url}
Content-Type: application/json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "clxxx...",
    "model": "<provider>/<model_name>",
    "state": "completed" | "failed",
    "param": "<JSON string>",            // request params, JSON.parse once
    "resultJson": "<JSON string> | null", // result object, JSON.parse once
    "failCode": null | "string",
    "failMsg": null | "string",
    "costTime": 12345,                    // duration in ms
    "completeTime": 1705123460000,        // ms epoch
    "createTime": 1705123450000           // ms epoch
  }
}

Note: data.param and data.resultJson are both JSON strings — call JSON.parse once on each.

Audio task: shape after JSON.parse(data.resultJson)

{
  "resultUrls":    ["https://r2.apimodels.app/audio/xxx.mp3"],
  "audioDuration": 12.5   // optional, seconds
}

resultUrls is an array of R2-hosted audio URLs (length 1 in success). When state=failed, resultJson is typically null or {"resultUrls":[]} — do not assume an audio link is present.

Exemplo de receptor em Node.js

app.post('/webhook/audio', express.json(), (req, res) => {
  const { taskId, state, resultJson, failMsg } = req.body.data
  if (state === 'completed') {
    const r = JSON.parse(resultJson)
    console.log('audio ready', taskId, r.resultUrls[0], r.audioDuration)
  } else {
    console.warn('audio failed', taskId, failMsg)
  }
  res.status(200).end()                 // must be 2xx, otherwise we retry
})

Notas

• - Uma tarefa para de tentar novamente apenas após uma resposta 2xx; uma vez entregue, nunca é enviada de novo.
• - Os callbacks não são assinados atualmente. Incorpore um token aleatório no caminho da sua callback_url e verifique-o no recebimento.
• - Use um endpoint HTTPS público que responda em até 10 segundos (tempo limite por tentativa).

Estados da tarefa

Códigos de erro

Notas importantes

• -Audio files are stored for 7 days -- download promptly
• -Poll every 3-5 seconds for status updates
• -Use callback_url for production workloads
• -Mantenha sua API key em segurança