Consultas
Executar uma consulta e acompanhar o resultado.
Executar uma consulta
Executa uma consulta e cobra a conta. O que volta depende do produto: os síncronos devolvem o resultado na própria resposta; os assíncronos devolvem async: true com um consultation_id para acompanhar em GET /status.
⚠️ Confira sempre o campo success — alguns desfechos de falha chegam com HTTP 200.
Headers
Idempotency-KeyRepetir o mesmo valor faz a chamada valer por uma só: a segunda devolve o resultado da primeira sem cobrar de novo. Use quando precisar reenviar com segurança.
Executar uma consulta › Request Body
consultation_typeO identificador da consulta. O que a sua conta pode consultar sai em GET /catalog; o contrato de entrada de cada uma está em components.schemas, como Entrada_<slug>.
Os campos que a consulta exige. Variam por produto — veja Entrada_<slug> ou o campo input_schema do GET /catalog.
Executar uma consulta › Responses
A consulta foi aceita. Veja success para saber o desfecho.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, consultation_id, result | |
| type = object · requires: success, async, consultation_id +1 more | |
| type = object · requires: success, error, code |
successconsultation_idO resultado da consulta.
environmentbalanceSaldo da carteira depois da cobrança.
remaining_unitsUnidades restantes, quando o pagamento saiu de um pacote.
idempotentPresente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.
Executar uma consulta (forma longa)
Idêntica a POST /. As duas formas chegam ao mesmo motor e têm o mesmo efeito e o mesmo custo — use a que preferir.
Headers
Idempotency-KeyRepetir o mesmo valor faz a chamada valer por uma só: a segunda devolve o resultado da primeira sem cobrar de novo. Use quando precisar reenviar com segurança.
Executar uma consulta (forma longa) › Request Body
consultation_typeO identificador da consulta. O que a sua conta pode consultar sai em GET /catalog; o contrato de entrada de cada uma está em components.schemas, como Entrada_<slug>.
Os campos que a consulta exige. Variam por produto — veja Entrada_<slug> ou o campo input_schema do GET /catalog.
Executar uma consulta (forma longa) › Responses
A consulta foi aceita. Veja success para saber o desfecho.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, consultation_id, result | |
| type = object · requires: success, async, consultation_id +1 more | |
| type = object · requires: success, error, code |
successconsultation_idO resultado da consulta.
environmentbalanceSaldo da carteira depois da cobrança.
remaining_unitsUnidades restantes, quando o pagamento saiu de um pacote.
idempotentPresente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.
Acompanhar uma consulta assíncrona
Consulta o andamento pelo consultation_id devolvido no POST. Não cobra, pode ser chamado quantas vezes quiser.
Enquanto processa, a resposta traz apenas status: "processing" — não há resultado parcial. Quando termina, vem completed com o result, ou failed (e, se houve cobrança, ela é estornada).
query Parameters
consultation_idO identificador devolvido pelo POST.
Acompanhar uma consulta assíncrona › Responses
O estado atual da consulta.
successstatusconsultation_idPresente quando completed.
errorPresente quando failed.
refundedQuanto foi estornado, quando houve cobrança.
Recuperar uma consulta já feita
Procura, no histórico da sua conta, uma consulta já realizada para aquele documento e produto. Não cobra e não executa nada novo.
query Parameters
typeO slug do produto.
documentO documento, com ou sem pontuação.
Recuperar uma consulta já feita › Responses
O que foi encontrado — ou a indicação de que não há nada.
successfoundSe havia consulta no histórico.
consultation_id