Texto

Excluir Resposta

Exclui uma resposta armazenada. Isso não cancela a geração.

DELETE
/v1/responses/{id}

Visão geral

Exclui uma resposta armazenada pelo ID. Após a exclusão, o ID não poderá mais ser recuperado ou usado como previous_response_id.

Esta é uma exclusão, não um cancelamento: ela não interrompe uma resposta que ainda está em execução. Você pode excluir apenas respostas criadas em sua própria conta. Um ID desconhecido, um ID de outra conta e um ID que você já excluiu retornarão 404.

Exemplo

Requisição

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/responses/resp_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

Exemplo de resposta

Resposta

200 OK
{
  "id": "resp_abc123",
  "object": "response.deleted",
  "deleted": true
}
deletedboolean
true quando a resposta foi excluída. Verifique este campo: o valor de object pode variar dependendo do modelo.

Erros

StatusCódigoSignificado
404response_not_foundO ID é desconhecido, pertence a outra conta ou já foi excluído.
502upstream_delete_failedO TokenLab não conseguiu excluir a resposta no serviço que a produziu. A resposta ainda está armazenada. Tente novamente mais tarde.
503upstream_delete_recovery_pendingA exclusão está sendo reconciliada. Não envie novamente imediatamente.
503response_state_unavailableO estado da resposta está temporariamente indisponível. Tente novamente mais tarde.

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

ID da resposta retornado por POST /v1/responses.

Resposta

application/json

application/json

application/json

application/json