Referência da API

Obter execução da ferramenta

GET/v1/tool-runs/{id}

Aceita flat constante por chamada, input calculado previamente pelas entradas e usage pelo uso final. pricing.quote_required determina se a cotação é obrigatória; requires_usage, se limite de custo e uso final oficial são exigidos. Nenhum é inferido de schema_version. Com metered_pricing desativado, só novas chamadas que exigem uso final são restritas; regras constantes/por entrada sem esse requisito continuam disponíveis. A chave atual precisa de autorização de ferramentas; identidade e resultados são limitados à chave original. Com a opção geral desativada, o catálogo fica vazio; catálogo anônimo não autoriza execução.

Autenticação e permissões

Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticação: BearerAuth

Solicitação

Parâmetros de caminho

idstringObrigatório
ID da ferramenta do catálogo ou execução original, conforme objeto da operação.

Respostas e erros

HTTP 200

Execução da ferramenta obtida com sucesso

application/json

Tipo: object
Campos obrigatórios: idtool_idversionstatusoutputbillingresult_expiredcreated_atupdated_at

idstringObrigatório
Identificador público do objeto, usado na sua rota de detalhes.
tool_idstringObrigatório
ID da ferramenta no catálogo executável da chave atual.
versionstringObrigatório
Versão do contrato/recurso ou ferramenta; a execução usa a versão retornada pelo catálogo.
statusstringObrigatório
submitting/running/submission_unknown/succeeded/failed; submission_unknown indica resultado de envio desconhecido. Não reenvie com outro Idempotency-Key.
outputunknownObrigatório
JSON definido por output_schema da ferramenta; não presuma que ainda exista após expirar.
error_codestringOpcional
Código público de erro para decisões de fluxo.
billingobjectObrigatório
Status de cobrança independente, não substituível pelo status de geração.
Campos filhos de billing (7)
- review_requiredbooleanOpcional
  As evidências de cobrança exigem revisão manual.
- reasonstringOpcional
  Motivo público de ação indisponível ou revisão de cobrança.
- usageunknownOpcional
  Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.
- breakdownunknownOpcional
  Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.
- statusstringObrigatório
  Status atual do objeto; avalie separadamente da cobrança e do salvamento.
- reserved_usdstringObrigatório
  Reserva máxima USD como string.
- charged_usdstringObrigatório
  Valor USD confirmado atualmente, como string.
Ramificação allOf 1
Tipo: object
Obrigatório nesta ramificação: status, reserved_usd, charged_usd
- review_requiredbooleanOpcional
  As evidências de cobrança exigem revisão manual.
- reasonstringOpcional
  Motivo público de ação indisponível ou revisão de cobrança.
- usageunknownOpcional
  Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.
- breakdownunknownOpcional
  Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.
- statusstringObrigatório
  Status atual do objeto; avalie separadamente da cobrança e do salvamento.
- reserved_usdstringObrigatório
  Reserva máxima USD como string.
- charged_usdstringObrigatório
  Valor USD confirmado atualmente, como string.
result_expiredbooleanObrigatório
Se o resultado expirou; cobrança e idempotência permanecem.
created_atintegerObrigatório
Data de criação em segundos Unix.
updated_atintegerObrigatório
Última atualização em segundos Unix.

HTTP 400

Campos ou parâmetros de solicitação inválidos.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 401

A chave está ausente, inválida, expirada ou revogada.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 403

Permissões insuficientes de IP, conta, modelo ou ferramenta.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 404

Objeto/recurso indisponível ou função desativada.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 409

Conflito de idempotência/cotação, objeto não pronto ou ainda referenciado.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 429

Limite de solicitações/fila.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 503

Serviço, preços ou armazenamento indisponíveis.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional