Documentação

Referência da API

Buscar ferramentas executáveis

POST/v1/tools/discover

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

Corpo da solicitação · application/json

Tipo
object
Campos obrigatórios
query
Propriedades adicionais
false

Corpo da solicitação obrigatório

  • querystringObrigatório

    Não vazio, máximo de 1000 bytes UTF-8; busca ID/nome/descrição.

  • limitintegerOpcional

    Omitido ou <=0 usa 5.

    Valor padrão
    5
    Máximo
    20

Respostas e erros

HTTP 200

Ferramentas executáveis buscadas com sucesso

application/json

Tipo
object
Campos obrigatórios
resultscount
  • resultsarrayObrigatório
    Campos filhos de results (1)
    • []objectOpcional
      Campos filhos de [] (8)
      • category_idstringObrigatório

        Identificador da categoria da ferramenta.

      • collection_idstringObrigatório

        Identificador da coleção de ferramentas.

      • tagsarrayObrigatório

        Etiquetas públicas de busca.

        Campos filhos de tags (1)
        • []stringOpcional
      • idstringObrigatório

        Identificador público do objeto, usado na sua rota de detalhes.

      • namestringObrigatório

        Nome legível para o usuário.

      • descriptionstringObrigatório

        Descrição pública da finalidade.

      • versionstringObrigatório

        Versão do contrato/recurso ou ferramenta; a execução usa a versão retornada pelo catálogo.

      • pricingobjectObrigatório

        Preço público; valem as cotações e regras de cobrança atuais.

        Campos filhos de pricing (9)
        • schema_versionintegerOpcional

          Versão das regras de preço da ferramenta.

        • ruleunknownOpcional

          Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.

        • quote_requiredbooleanObrigatório

          Se novas execuções precisam confirmar cotação antes.

        • currencystringObrigatório

          Moeda da cotação/cobrança.

        • unitstringObrigatório

          call: por chamada ou cálculo prévio por entradas; usage: por uso final. Consulte mode para a semântica exata.

        • amountstringOpcional

          Em mode=flat, valor constante completo em USD, inclusive zero; input/usage não expõem valores constantes enganosos.

        • price_versionintegerObrigatório

          Revisão do preço de venda.

        • modestringObrigatório

          Semântica de venda: flat constante por chamada, input calculado por entradas, usage por uso final; independente do formato schema_version.

          Enumeração
          ["flat","input","usage"]
        • requires_usagebooleanObrigatório

          Se liquidar exige uso oficial confirmado, incluindo restrições da plataforma; não deduza apenas pelo mode de venda.

        Ramificação allOf 1

        Tipo: object

        Obrigatório nesta ramificação: currency, unit, price_version, mode, quote_required, requires_usage

        • schema_versionintegerOpcional

          Versão das regras de preço da ferramenta.

        • ruleunknownOpcional

          Valor JSON definido por schema ou protocolo da ferramenta; sem presumir campos fixos.

        • quote_requiredbooleanObrigatório

          Se novas execuções precisam confirmar cotação antes.

        • currencystringObrigatório

          Moeda da cotação/cobrança.

        • unitstringObrigatório

          call: por chamada ou cálculo prévio por entradas; usage: por uso final. Consulte mode para a semântica exata.

        • amountstringOpcional

          Em mode=flat, valor constante completo em USD, inclusive zero; input/usage não expõem valores constantes enganosos.

        • price_versionintegerObrigatório

          Revisão do preço de venda.

        • modestringObrigatório

          Semântica de venda: flat constante por chamada, input calculado por entradas, usage por uso final; independente do formato schema_version.

          Enumeração
          ["flat","input","usage"]
        • requires_usagebooleanObrigatório

          Se liquidar exige uso oficial confirmado, incluindo restrições da plataforma; não deduza apenas pelo mode de venda.

  • countintegerObrigatório

HTTP 400

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 401

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 403

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 404

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 409

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 429

Limite de solicitações/fila.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 500

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

application/json

Tipo
object
Campos obrigatórios
error

HTTP 503

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

application/json

Tipo
object
Campos obrigatórios
error
Pronto para criar? Abra console para criar uma chave de API, ou explore recursos.