> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pioneer.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pioneer REST API:基础 URL、身份验证与快速参考

> Pioneer REST API 概览:基础 URL、身份验证、从数据集到推理的推荐 5 步工作流,以及所有端点分组参考的链接。

Pioneer REST API 允许您以编程方式运行推理、管理数据集、启动训练任务并评估模型。所有资源都位于同一个基础 URL 下,每个请求都使用您的 API 密钥进行身份验证。Pioneer 还提供与 OpenAI 和 Anthropic 兼容的端点,因此您可以与任何已支持这些格式的工具集成。

**基础 URL:** `https://api.pioneer.ai`

## 身份验证

每个请求都需要 `X-API-Key` 头。请在 Pioneer 控制面板 [agent.pioneer.ai/api-keys](https://agent.pioneer.ai/api-keys) 创建密钥,或在登录后打开 **Settings** -> **API Keys**。请参阅[身份验证](/cn/api-reference/authentication)页面了解完整信息,包括密钥管理端点。

## 推荐工作流

在端到端构建微调模型时,请按以下顺序操作:

<Steps>
  <Step title="创建或上传数据集">
    使用 `POST /generate` 生成合成标注数据。响应中包含一个 `job_id`,请轮询 `GET /generate/jobs/{job_id}` 直到状态返回 `ready`。

    要上传您自己的标注数据,请使用三步上传流程:

    1. 调用 `POST /felix/datasets/upload/url` 获取预签名的 S3 URL,
    2. 将文件直接 `PUT` 到 S3,
    3. 调用 `POST /felix/datasets/upload/process` 触发处理。

    轮询 `GET /felix/datasets/{name}/{version}` 直到状态为 `ready`。<br />有关完整详情,请参阅[数据集](/api-reference/datasets)页面。
  </Step>

  <Step title="启动训练任务">
    使用您的 model\_name、datasets 和 base\_model 调用 `POST /felix/training-jobs`。响应中包含一个 `job_id`,请为后续步骤保存它。
  </Step>

  <Step title="轮询训练状态">
    反复调用 `GET /felix/training-jobs/:id`,直到 status 字段为 `complete`。已完成的任务会包含 F1、精确率和召回率指标。
  </Step>

  <Step title="运行评估">
    使用您的训练任务 ID 和一个留出的数据集名称调用 `POST /felix/evaluations`,以在正式提供服务前验证性能。
  </Step>

  <Step title="运行推理">
    调用 `POST /inference`,将 `base_model` 设置为您的训练任务 ID,将 dataset\_name 设置为您的留出数据集。您也可以使用任何基础模型 ID(例如 `fastino/gliner2-base-v1`)而无需微调。
  </Step>
</Steps>

<Note>
  在运行任何示例命令之前,请将 `YOUR_DATASET_NAME` 和 `YOUR_TRAINING_JOB_ID` 等占位符值替换为真实值。
</Note>

## 端点分组

<CardGroup cols={2}>
  <Card title="推理" icon="bolt" href="/api-reference/inference/pioneer">
    使用 Pioneer 格式,或通过即插即用的 OpenAI 和 Anthropic 兼容端点,对微调模型或基础模型运行预测。
  </Card>

  <Card title="训练与数据" icon="database" href="/api-reference/datasets">
    管理数据集、生成合成训练数据、启动并监控训练任务,以及运行评估。
  </Card>

  <Card title="项目" icon="folder" href="/api-reference/projects">
    将资源组织到项目中,部署训练后的模型,并对项目端点运行推理。
  </Card>

  <Card title="API 密钥" icon="key" href="/cn/api-reference/api-keys">
    在控制面板中创建密钥,然后以编程方式列出和撤销现有密钥。
  </Card>
</CardGroup>

## OpenAI 和 Anthropic 兼容性

Pioneer 提供了 OpenAI 和 Anthropic SDK 的即插即用替代方案。将您现有的客户端指向 `https://api.pioneer.ai/v1` 并使用您的 Pioneer API 密钥即可,无需其他更改。

| SDK       | 基础 URL                      | 说明                                            |
| --------- | --------------------------- | --------------------------------------------- |
| OpenAI    | `https://api.pioneer.ai/v1` | 设置 `base_url`;通过 `extra_body` 传递 Pioneer 特定字段 |
| Anthropic | `https://api.pioneer.ai/v1` | 设置 `base_url`;支持流式传输                          |

使用 `extra_body`(OpenAI SDK)或您客户端库中的等效额外参数机制传递诸如 `schema` 之类的 Pioneer 特定字段。