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

# Alpha Search request

> The host model field and upstream-specific search contracts.

`POST /v1/alpha/search`

Requires `model`; `id` and `stream` are parsed, and other raw JSON fields are retained. Mapping rewrites `model`; parameter overrides may change the request.

Only selected channels support this endpoint. There is no uniform search request/result schema. Successful body and Content-Type are forwarded; `stream` does not establish a verified SSE API. See [deployment-specific example and boundaries](/en/guides/alpha-search).

[阅读中文版](/zh/api-reference/alpha-search)


## OpenAPI

````yaml openapi/relay.json POST /v1/alpha/search
openapi: 3.0.3
info:
  title: API — Core inference API
  version: 0.5.0
  description: >-
    面向接入的精选规范，不是全部管理或供应商接口。 / Curated integration specification, not the entire
    management or provider API.
  license:
    name: AGPL-3.0-or-later
servers:
  - url: https://gateway.example.com
    description: >-
      Example only; replace with your gateway origin and optional path prefix,
      without /v1.
security:
  - BearerAuth: []
paths:
  /v1/alpha/search:
    post:
      summary: Alpha Search 专用请求 / Alpha Search request
      description: >-
        必填 `model`；`id`、`stream` 可被解析，其他字段保留原始 JSON。模型映射改写 `model`，参数覆盖可能改变请求。 /
        Requires `model`; `id` and `stream` are parsed, and other raw JSON
        fields are retained. Mapping rewrites `model`; parameter overrides may
        change the request.
      operationId: alpha_search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                model:
                  type: string
                id:
                  type: string
                stream:
                  type: boolean
              additionalProperties: true
              required:
                - model
      responses:
        '200':
          description: >-
            读取业务字段，不只检查 HTTP 状态 / Validate business fields, not only HTTP
            status.
          content:
            '*/*':
              schema: {}
              example: Upstream-defined response; no uniform result schema.
        default:
          description: 错误格式与状态取决于入口 / Error status and shape depend on the entry.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 模型调用 API Key，不是控制台登录凭据 / Model API key, not console login credentials

````

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