# 概览

> 每个可调用的工具：它的作用、scope、参数，以及 curl、JavaScript 和 Python 示例。

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

工具按族分组，每族一页。参考内容由 API 代码生成：不会与代码脱节，新增的工具会自动出现。

## 工具族

| 族 | 工具 |
| --- | --- |
| [语料库](/zh/docs/api/reference/corpus) | 22 |
| [实时读取](/zh/docs/api/reference/direct) | 9 |
| [Facebook](/zh/docs/api/reference/facebook) | 8 |
| [LinkedIn](/zh/docs/api/reference/linkedin) | 10 |
| [Upwork](/zh/docs/api/reference/upwork) | 19 |
| [写入](/zh/docs/api/reference/write) | 12 |
| [操作](/zh/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` 返回：参见[错误](/zh/docs/api/errors)。

密钥的 scope、每个工具的边界以及各项限制，见[认证](/zh/docs/api/authentication)。带输入结构的实时列表位于 `GET https://piqline.com/api/v1/tools`。

[OpenAPI 文档](https://piqline.com/api/v1/openapi.json)以同样的路由描述供客户端生成器使用。
