Ir para o conteúdo

Referência das ferramentas

Visão geral

Todas as ferramentas chamáveis: função, scopes, parâmetros e um exemplo em curl, JavaScript e Python.

As ferramentas são agrupadas por família, uma página para cada. A referência é gerada a partir do código da API: ela não pode divergir dele, e uma nova ferramenta aparece sozinha.

Famílias de ferramentas#

Formato da chamada#

POSThttps://piqline.com/api/v1/tools/{nom}

Toda ferramenta é chamada da mesma forma:

  • Authorization: Bearer piq_live_… e Content-Type: application/json.
  • Um corpo JSON: a entrada da ferramenta. Uma ferramenta sem parâmetros aceita {}.
  • Uma resposta 200 no formato { "tool": "nom", "output": … }.
  • Um erro como application/problem+json: veja Erros.

Os scopes de uma chave, o que limita cada ferramenta e os limites estão em Autenticação. A lista atual, com os esquemas de entrada, está em GEThttps://piqline.com/api/v1/tools.

O documento OpenAPI descreve as mesmas rotas para um gerador de clientes.

Uma dúvida sobre a API, ou um erro nesta página? Escreva para nós.