本文へスキップ

ツールリファレンス

概要

呼び出せるすべてのツール。役割、スコープ、パラメーター、curl、JavaScript、Python の例。

ツールはファミリー別にまとめ、1 ファミリーにつき 1 ページを用意しています。リファレンスは API のコードから生成されるため、コードとずれることはなく、新しいツールも自動で掲載されます。

ツールファミリー#

呼び出し形式#

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

すべてのツールは、同じ方法で呼び出します。

  • Authorization: Bearer piq_live_… と Content-Type: application/json。
  • JSON の本文。これがツールの入力です。パラメーターのないツールは {} を受け付けます。
  • { "tool": "nom", "output": … } の形式の 200 レスポンス。
  • エラーは application/problem+json。エラーを参照してください。

キーのスコープ、各ツールの制約、制限は認証にあります。入力スキーマ付きの最新の一覧は GEThttps://piqline.com/api/v1/tools で取得できます。

OpenAPI ドキュメントは、同じルートをクライアントジェネレーター向けに記述しています。

API についてのご質問や、このページの誤りはありませんか。 お問い合わせ.