> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/api-reference/cn/gai-lan.md).

# 概览

Web API 的基础 URL、身份验证、请求约定、交付模式和响应信封结构。

## 基础 URL

```
https://webapi.oxylabs.io
```

## 身份验证

```http
Authorization: Bearer YOUR_API_KEY
```

每个请求都使用 Bearer token。完整说明： [身份验证](/products/web-api/authentication.md).

## 请求格式

<table data-header-hidden><thead><tr><th width="160">项目</th><th>值</th></tr></thead><tbody><tr><td>方法</td><td><code>POST</code>，除非端点另有说明</td></tr><tr><td>内容类型</td><td><code>application/json</code></td></tr><tr><td>请求体</td><td>JSON 对象。不识别的字段会被拒绝， <code>400</code></td></tr></tbody></table>

## 端点

<table><thead><tr><th width="231">类型</th><th>路径</th></tr></thead><tbody><tr><td>搜索</td><td><code>POST /v1/search</code></td></tr><tr><td>通用抓取</td><td><code>POST /v1/scrape</code></td></tr><tr><td>专用爬虫</td><td><code>POST /v1/scrape/{target}/{collection}</code></td></tr><tr><td>专用爬虫列表</td><td><code>GET /v1/scrapers</code></td></tr><tr><td>端点参数列表</td><td><code>OPTIONS /v1/{endpoint}</code></td></tr></tbody></table>

完整端点列表： [完整端点索引](/api-reference/cn/wan-zheng-duan-dian-suo-yin.md).

## 交付模式

{% hint style="info" %}
`/v1/search` 仅为同步（实时）模式。
{% endhint %}

<table><thead><tr><th>模式</th><th width="222">响应</th><th>备注</th></tr></thead><tbody><tr><td><a href="/products/web-api/scrape/delivery-modes.md#realtime">同步</a><br><code>/v1/scrape/...</code></td><td><code>200</code>，结果在 body 中</td><td>保持连接打开</td></tr><tr><td><a href="/products/web-api/scrape/delivery-modes.md#single-job-delivery-async">异步（单个任务）</a><br><code>/v1/async/scrape/...</code></td><td><code>202</code>，轮询/回调/存储</td><td>任务 ID 为 <code>metadata.request_id</code></td></tr><tr><td><a href="/products/web-api/scrape/delivery-modes.md#batch-delivery-async">异步（批量）</a><br><code>/v1/async/scrape/batch/...</code></td><td><code>202</code>，任务数组</td><td><code>query</code>/<code>url</code> 会变成列表</td></tr></tbody></table>

仅支持所选端点 `异步` 任务。每个端点的交付模式支持情况： [完整端点索引](/api-reference/cn/wan-zheng-duan-dian-suo-yin.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/api-reference/cn/gai-lan.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.