TipoChatDocs
Abrir plataforma

Fazer pedidos

A API aceita JSON por HTTPS. As rotas de integração exigem chave de API; apenas a verificação de saúde é pública.

Como ligar a sua aplicação

O seu frontend ou app móvel chama primeiro o seu próprio servidor; é esse servidor que guarda TIPOCHAT_API_KEY e comunica com https://api.tipochat.co.mz. Nunca ligue a chave diretamente ao browser ou à aplicação distribuída.

RecursoPOST criaGET lê
Texto/v1/responsesNão existe; o POST devolve o texto.
ÁudioUpload ou job/v1/jobs/{id} até terminar.
Imagem/v1/images/generations/v1/images/jobs/{id} até terminar.

Envie JSON apenas nos POST da API. Os GET não têm corpo e não precisam de Idempotency-Key; mantenha sempre o header Authorization.

Endpoint de respostas

POSThttps://api.tipochat.co.mz/v1/responses

Verificação de saúde

GET https://api.tipochat.co.mz/health devolve {"status":"ok"} sem chave. Use-a apenas para verificar a disponibilidade do proxy; ela não confirma que uma chave, saldo ou serviço de IA estão ativos.

Headers

HeaderObrigatórioDescrição
AuthorizationSimBearer tc_live_… ou Bearer tc_test_….
Content-TypeSimUse application/json.
Idempotency-KeyNas operações que criam trabalhoEntre 8 e 255 caracteres.
X-Request-IdNãoDiagnóstico; até 100 caracteres.

Idempotência

A mesma chave e o mesmo corpo devolvem a resposta já guardada. A mesma chave com corpo diferente devolve 409 idempotency_key_reused.

Repetições

Sem resposta de rede

Repita com a mesma chave.

409 request_in_progress

Aguarde e repita a mesma chave.

502 provider_outcome_unknown

Não crie um novo pedido; a operação exige reconciliação.

502 provider_error

O pedido foi encerrado; após backoff, uma nova operação precisa de nova chave.

Escreva para pesquisar páginas, campos e erros.