# 概要

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

Source: https://piqline.com/ja/docs/api/reference

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

## ツールファミリー

| ファミリー | ツール |
| --- | --- |
| [コーパス](/ja/docs/api/reference/corpus) | 22 |
| [ライブ読み取り](/ja/docs/api/reference/direct) | 9 |
| [Facebook](/ja/docs/api/reference/facebook) | 8 |
| [LinkedIn](/ja/docs/api/reference/linkedin) | 10 |
| [Upwork](/ja/docs/api/reference/upwork) | 19 |
| [書き込み](/ja/docs/api/reference/write) | 12 |
| [アクション](/ja/docs/api/reference/act) | 12 |

## 呼び出し形式

`POST https://piqline.com/api/v1/tools/{nom}`

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

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

キーのスコープ、各ツールの制約、制限は[認証](/ja/docs/api/authentication)にあります。入力スキーマ付きの最新の一覧は `GET https://piqline.com/api/v1/tools` で取得できます。

[OpenAPI ドキュメント](https://piqline.com/api/v1/openapi.json)は、同じルートをクライアントジェネレーター向けに記述しています。
