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

> ## Agent Instructions
> - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative.
> - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key.
> - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste.
> - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`.
> - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt

# Oxylabs Web API 网页抓取

> <!-- aisa-pricing:start -->
公开参考价格：每次成功请求 $0.00145 USD。 最终费用以账户适用价格及实际结算为准。
<!-- aisa-pricing:end -->

## 请求规范

* **方法与路径:** POST /apis/v1/oxylabs/scrape
* **可用状态:** enabled
* **请求 URL 模板:** `https://api.aisa.one/apis/v1/oxylabs/scrape`
* **Runtime 事实版本:** 330a1b946e291c58fa7755e63e8cb2a4ec60e05fb4b373af15c0723c4dc1d294

[完整 OpenAPI 定义](https://aisa.one/docs/openapi/zh/oxylabs.json)

有效请求与价格声明（包括认证和引用的 schema）：

```json theme={null}
{
  "operationId": "post_oxylabs_apis_v1_oxylabs_scrape",
  "method": "POST",
  "path": "/apis/v1/oxylabs/scrape",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "examples": {
          "default": {
            "value": {
              "output": [
                "html"
              ],
              "run_js": false,
              "url": "https://example.com"
            }
          },
          "minimal": {
            "value": {
              "url": "https://example.com"
            }
          }
        },
        "schema": {
          "additionalProperties": false,
          "properties": {
            "device": {
              "enum": [
                "desktop",
                "mobile"
              ],
              "type": "string"
            },
            "location": {
              "maxLength": 2,
              "minLength": 2,
              "type": "string"
            },
            "output": {
              "default": [
                "html"
              ],
              "items": {
                "enum": [
                  "html",
                  "markdown"
                ],
                "type": "string"
              },
              "maxItems": 2,
              "minItems": 1,
              "type": "array"
            },
            "run_js": {
              "default": false,
              "enum": [
                false
              ],
              "type": "boolean"
            },
            "url": {
              "format": "https_url",
              "maxLength": 8192,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "request_formula",
    "customer_pricing": "fixed_success",
    "default_request_estimate_usd": 0.00145,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```

## 费用与请求规则

公开参考价格：每次成功请求 \$0.00145 USD。 最终费用以账户适用价格及实际结算为准。

公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口，执行前请针对完整请求获取免费报价；执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。

* **默认请求参考估价（USD）:** 0.00145
* **计费依据:** request\_formula
* **结算证据来源:** request\_snapshot


## OpenAPI

````yaml openapi/zh/oxylabs.json POST /apis/v1/oxylabs/scrape
openapi: 3.1.0
info:
  description: ''
  title: Oxylabs Web API
  version: '1'
  x-aisa-capabilities:
    idempotency: Idempotency-Key
    max_price: X-AISA-Max-Price-USD
    quote:
      header: X-AISA-Cost-Mode
      value: quote
  x-aisa-catalogs:
    oxylabs:
      description: ''
      title: Oxylabs Web API
      x-aisa-capabilities:
        idempotency: Idempotency-Key
        max_price: X-AISA-Max-Price-USD
        quote:
          header: X-AISA-Cost-Mode
          value: quote
      x-aisa-document:
        facts_hash: 330a1b946e291c58fa7755e63e8cb2a4ec60e05fb4b373af15c0723c4dc1d294
        generator_version: '3'
        protocol_version: '1'
        schema_version: '1'
      x-aisa-plans:
        builder: 1
        display_plan: payg
        payg: 1
        similarweb_payg: 1
        team: 1
        version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-configured-paths:
    - /apis/v1/oxylabs/ai-search
    - /apis/v1/oxylabs/scrape
    - /apis/v1/oxylabs/search
  x-aisa-document:
    composer_version: '26'
    document_hash: sha256:eba3ef86733db91138e8b31aab5f21802c02ad058101de9d3dfe79120b82eb64
    facts_hash: 330a1b946e291c58fa7755e63e8cb2a4ec60e05fb4b373af15c0723c4dc1d294
    generator_version: '3'
    protocol_version: '1'
    response_pending: []
    schema_version: '1'
  x-aisa-plans:
    builder: 1
    display_plan: payg
    payg: 1
    similarweb_payg: 1
    team: 1
    version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-provider: oxylabs
servers:
  - url: https://api.aisa.one
security:
  - bearerAuth: []
paths:
  /apis/v1/oxylabs/scrape:
    post:
      tags:
        - oxylabs
      summary: Oxylabs Web API 网页抓取
      description: |-
        <!-- aisa-pricing:start -->
        公开参考价格：每次成功请求 $0.00145 USD。 最终费用以账户适用价格及实际结算为准。
        <!-- aisa-pricing:end -->
      operationId: post_oxylabs_apis_v1_oxylabs_scrape
      requestBody:
        content:
          application/json:
            examples:
              default:
                value:
                  output:
                    - html
                  run_js: false
                  url: https://example.com
              minimal:
                value:
                  url: https://example.com
            schema:
              additionalProperties: false
              properties:
                device:
                  enum:
                    - desktop
                    - mobile
                  type: string
                location:
                  maxLength: 2
                  minLength: 2
                  type: string
                output:
                  default:
                    - html
                  items:
                    enum:
                      - html
                      - markdown
                    type: string
                  maxItems: 2
                  minItems: 1
                  type: array
                run_js:
                  default: false
                  enum:
                    - false
                  type: boolean
                url:
                  format: https_url
                  maxLength: 8192
                  type: string
              required:
                - url
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - required:
                      - state
                  - required:
                      - status
                properties:
                  metadata:
                    properties:
                      request_id:
                        description: 供应商请求标识符。
                        type: string
                      timestamp:
                        description: Unix 时间戳，单位为秒。
                        type: integer
                    type: object
                  params:
                    description: 执行参数，包含供应商的默认值；响应中回显的字段不代表 AISA 请求支持额外参数。
                    type: object
                  results:
                    allOf:
                      - prefixItems:
                          - anyOf:
                              - properties:
                                  html:
                                    type: string
                                required:
                                  - html
                              - properties:
                                  markdown:
                                    type: string
                                required:
                                  - markdown
                    items:
                      properties:
                        html:
                          description: 请求的 HTML 内容；未请求该格式时为 null。
                          type:
                            - string
                            - 'null'
                        json:
                          description: 当前 AISA 接口不请求此格式，通常为 null。
                          type:
                            - object
                            - 'null'
                        markdown:
                          description: 请求的 Markdown 内容；未请求该格式时为 null。
                          type:
                            - string
                            - 'null'
                        metadata:
                          properties:
                            page:
                              type: integer
                            run_js:
                              type: boolean
                            url:
                              description: 重定向后实际抓取的 URL。
                              type: string
                          type: object
                        screenshot:
                          description: 当前 AISA 接口不请求此格式，通常为 null。
                          type:
                            - string
                            - 'null'
                      type: object
                    minItems: 1
                    type: array
                  state:
                    const: done
                    description: 实际观测到的同步成功标记；当前 Web API 响应可能省略 status 字段。
                    type: string
                  status:
                    const: 200
                    description: 官方响应示例中的成功标记；state 为 done 时可能省略此字段。
                    type: integer
                required:
                  - results
                type: object
          description: Web API 原生网页抓取成功响应。
        default:
          content:
            application/json:
              schema: {}
          description: >-
            Error response; upstream passthrough responses may use provider
            formats
      x-codeSamples:
        - label: Reference example
          lang: text
          source: >-
            # Fixed reference example. Playground inputs do not update this
            sample.

            curl --request POST \
              --url https://api.aisa.one/apis/v1/oxylabs/scrape \
              --header 'Authorization: Bearer <token>' \
              --header 'Content-Type: application/json' \
              --data '{
              "output": [
                "html"
              ],
              "run_js": false,
              "url": "https://example.com"
            }'
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.