完整公开 API 参考

本页由 FastAPI 外部路由面与经筛选的公开 OpenAPI 自动生成，列出外部 OAuth 或 MCP 服务端可调用的全部接口；运营后台、桌面内部接口和官网私有 BFF 不在公开合同内。

所有 Bearer Token 调用都必须发生在可信服务端。Access Token、Code、Client Secret 和 Call Context 不得进入浏览器 JavaScript、AI Prompt、URL 或日志。

OAuth

GET /oauth/authorize

Authorize an open agent

Starts the authorization-code flow. Team authorization should include an exact team_id. Public clients use PKCE S256.

鉴权: 浏览器授权会话

参数

名称	位置	必填	类型	说明
response_type	query	是	string
client_id	query	是	string
redirect_uri	query	是	string
scope	query	否	string
state	query	否	string
code_challenge	query	否	string
code_challenge_method	query	否	string
team_id	query	否	string

响应

状态	说明	Schema
302	Redirects to login, consent, Team selection, or the registered callback.	—
400	Invalid client, redirect URI, scope, Team context, or PKCE input.	—

POST /oauth/authorize

Authorize Submit

鉴权: 浏览器授权会话

请求体

• application/x-www-form-urlencoded: Body_authorize_submit_oauth_authorize_post（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /oauth/revoke

Revoke an open-agent token

鉴权: 智能体客户端凭据

请求体

• application/x-www-form-urlencoded: object（必填）

响应

状态	说明	Schema
200	Revocation is idempotent.	—
400	Invalid client credentials.	—

POST /oauth/token

Exchange an authorization code

Consumes a five-minute single-use authorization code. New exchanges return a 7-day access token and no refresh token.

鉴权: 智能体客户端凭据

请求体

• application/x-www-form-urlencoded: object（必填）

响应

状态	说明	Schema
200	Access token response. Team exchanges also include team_id and team_authorization_id.	OAuthTokenResponse
400	OAuth error	OAuthError

Open context

GET /api/v1/open/balance

Get the Personal balance

Rejects Team-bound tokens.

鉴权: OAuth Bearer；Scope: balance

响应

状态	说明	Schema
200		—
default		—

POST /api/v1/open/charge

Charge

鉴权: OAuth Bearer；Scope: charge

请求体

• application/json: OpenAgentChargeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/desktop-execution-grants

Create Grant

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
Idempotency-Key	header	是	string

请求体

• application/json: DesktopExecutionGrantInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/open/desktop-execution-grants/{grant_id}

Revoke Grant

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
grant_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/desktop-execution-grants/{grant_id}/runs

Admit Run

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
grant_id	path	是	string

请求体

• application/json: DesktopExecutionRunInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/desktop-execution-grants/{grant_id}/runs/{run_id}/model-results/{sequence}

Model Result

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
grant_id	path	是	string
run_id	path	是	string
sequence	path	是	integer
requestFingerprint	query	是	string
X-Xiaoya-Team-Id	header	否	string / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/employee-generation-results/{operation_digest}

Generation Result

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
operation_digest	path	是	string
requestFingerprint	query	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PATCH /api/v1/open/employee-instances/{instance_id}

Open Patch Instance

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

请求体

• application/json: EmployeeInstancePatch（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/open/employee-instances/{instance_id}

Open Archive Instance

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/employee-instances/{instance_id}/boundary

Open Instance Boundary

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/employee-instances/{instance_id}/copy

Open Copy Instance

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

请求体

• application/json: EmployeeCopyInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/employee-instances/{instance_id}/dependencies/{item_type}/{item_id}/package

Open Dependency Package

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
item_type	path	是	string
item_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PATCH /api/v1/open/employee-instances/{instance_id}/studio-link

Open Studio Link

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

请求体

• application/json: EmployeeStudioLinkInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/employee-instances/{instance_id}/upgrade

Open Upgrade Instance

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
instance_id	path	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

请求体

• application/json: EmployeeUpgradeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/employee-market/{template_id}/cloud-installation

Open Cloud Installation

鉴权: 见接口契约

参数

名称	位置	必填	类型	说明
template_id	path	是	string
operationId	query	是	string
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/me

Get the current agent-scoped user

鉴权: OAuth Bearer；Scope: profile

响应

状态	说明	Schema
200	Current subject	SuccessEnvelope + object
default		—

POST /api/v1/open/refund

Refund

鉴权: OAuth Bearer；Scope: charge

请求体

• application/json: OpenAgentRefundInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/usage

Get Personal usage attributed to the current agent

Rejects Team-bound tokens. Team overview is not equivalent to this detail contract.

鉴权: OAuth Bearer；Scope: usage

响应

状态	说明	Schema
200		—
default		—

Personal account

GET /api/v1/open/account/bootstrap

Bootstrap

鉴权: OAuth Bearer；Scope: account

响应

状态	说明	Schema
200	Successful Response	object

GET /api/v1/open/account/entitlements

Open Personal State

鉴权: OAuth Bearer；Scope: account

响应

状态	说明	Schema
200	Successful Response	object

POST /api/v1/open/account/gift-cards/redeem

Redeem Card

鉴权: OAuth Bearer；Scope: account

参数

名称	位置	必填	类型	说明
Idempotency-Key	header	是	string

请求体

• application/json: GiftCardInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/account/orders

Orders

鉴权: OAuth Bearer；Scope: payment

参数

名称	位置	必填	类型	说明
page	query	否	integer
pageSize	query	否	integer

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/account/payments/wechat

Create Wechat Order

鉴权: OAuth Bearer；Scope: payment

请求体

• application/json: RechargeOrderInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/account/payments/{order_id}

Payment Order

鉴权: OAuth Bearer；Scope: payment

参数

名称	位置	必填	类型	说明
order_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/account/performance

Performance

鉴权: OAuth Bearer；Scope: account

参数

名称	位置	必填	类型	说明
range	query	否	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/account/products

Products

鉴权: OAuth Bearer；Scope: payment

响应

状态	说明	Schema
200	Successful Response	object

PATCH /api/v1/open/account/profile

Update Profile

鉴权: OAuth Bearer；Scope: account

请求体

• application/json: ProfileInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/account/profile/avatar

Upload Profile Avatar

鉴权: OAuth Bearer；Scope: account

请求体

• multipart/form-data: Body_upload_profile_avatar_api_v1_open_account_profile_avatar_post（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/account/referral

Referral

鉴权: OAuth Bearer；Scope: account

响应

状态	说明	Schema
200	Successful Response	object

GET /api/v1/open/account/refunds

Refunds

鉴权: OAuth Bearer；Scope: payment

参数

名称	位置	必填	类型	说明
page	query	否	integer
pageSize	query	否	integer

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Models

GET /api/v1/open/models

List models available to the Personal context

Requires a Personal-bound token with the model scope.

鉴权: OAuth Bearer；Scope: model

响应

状态	说明	Schema
200	Personal model catalog	SuccessEnvelope + object
default		—

Team

GET /api/v1/open/teams

List Team contexts visible to the current subject

鉴权: OAuth Bearer；Scope: profile

响应

状态	说明	Schema
200	Team contexts	SuccessEnvelope + object
default		—

POST /api/v1/open/teams

Create Open Team

鉴权: OAuth Bearer；Scope: profile

请求体

• application/json: TeamCreateInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/invitations/accept

Accept Open Invitation

鉴权: OAuth Bearer；Scope: profile

请求体

• application/json: TeamInvitationAcceptInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/audit

Audit Log

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
page	query	否	integer
pageSize	query	否	integer

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/balance

Get the exact Team balance

鉴权: OAuth Bearer；Scope: balance

参数

名称	位置	必填	类型	说明
undefined	undefined	否	—

响应

状态	说明	Schema
200		—
default		—

POST /api/v1/open/teams/{team_id}/charge

Team Charge

鉴权: OAuth Bearer；Scope: charge

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: OpenAgentTeamChargeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/context

Resolve one Team context

鉴权: OAuth Bearer；Scope: profile

参数

名称	位置	必填	类型	说明
undefined	undefined	否	—

响应

状态	说明	Schema
200	Team context	SuccessEnvelope + object
default		—

GET /api/v1/open/teams/{team_id}/entitlements

Open Team State

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/invitations

Invitations

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/invitations

Create Invitation

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamInvitationInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/open/teams/{team_id}/invitations/{invitation_id}

Revoke Invitation

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
invitation_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/join-links

Join Links

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/join-links

Create Join Link

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamJoinLinkCreateInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/open/teams/{team_id}/join-links/{link_id}

Revoke Join Link

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
link_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/knowledge/search

Open Agent Search

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: KnowledgeAgentSearchInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/member-credits

Member Credits

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/member-credits/allocate

Allocate Credits

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamCreditChangeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/member-credits/reclaim

Reclaim Credits

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamCreditChangeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PUT /api/v1/open/teams/{team_id}/member-credits/{member_id}/quota

Update Member Credit Quota

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
member_id	path	是	string

请求体

• application/json: TeamMemberQuotaInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/members

Members

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PUT /api/v1/open/teams/{team_id}/members/{member_id}/organization

Update Member Org

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
member_id	path	是	string

请求体

• application/json: TeamMemberOrganizationInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PATCH /api/v1/open/teams/{team_id}/members/{member_id}/role

Update Role

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
member_id	path	是	string

请求体

• application/json: TeamMemberRoleInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PATCH /api/v1/open/teams/{team_id}/members/{member_id}/status

Update Status

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
member_id	path	是	string

请求体

• application/json: TeamMemberStatusInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/membership

Open Team Current Membership

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/membership/orders

List Open Team Membership Orders

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
page	query	否	integer
pageSize	query	否	integer

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/membership/orders

Create Open Team Membership Order

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamMembershipOrderInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/membership/orders/{order_id}

Get Open Team Membership Order

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
order_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/membership/orders/{order_id}/refunds

List Open Team Membership Refunds

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
order_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/membership/plans

Open Team Membership Plans

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/models

List models available to the exact Team context

鉴权: OAuth Bearer；Scope: model

参数

名称	位置	必填	类型	说明
undefined	undefined	否	—

响应

状态	说明	Schema
200	Versioned Team model catalog	SuccessEnvelope + object
default		—

GET /api/v1/open/teams/{team_id}/organization

Get Organization

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/organization/{kind}

Create Org Item

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
kind	path	是	string

请求体

• application/json: TeamOrganizationItemInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/overview

Open Team Overview

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/open/teams/{team_id}/profile

Team Profile

鉴权: OAuth Bearer；Scope: team_read / team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

PATCH /api/v1/open/teams/{team_id}/profile

Update Team Profile

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamProfileInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/refund

Team Refund

鉴权: OAuth Bearer；Scope: charge

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: OpenAgentTeamRefundInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open/teams/{team_id}/wallet/fund

Fund Wallet

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

请求体

• application/json: TeamWalletFundingInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Model gateway

POST /api/proxy/v1/chat/completions

Call the compatible Chat Completions gateway

Personal open-agent tokens support streaming. A Team-bound token requires every X-Xiaoya workflow header and currently rejects stream=true.

鉴权: OAuth Bearer；Scope: model

参数

名称	位置	必填	类型	说明
undefined	undefined	否	—
undefined	undefined	否	—
undefined	undefined	否	—
undefined	undefined	否	—
undefined	undefined	否	—
X-Request-ID	header	是	string	Stable client request ID. Reuse the same value only when retrying the same request in the same billing account context.

请求体

• application/json: object（必填）

响应

状态	说明	Schema
200	JSON completion or text/event-stream for a supported Personal streaming request.	object / string
default		—

TTS gateway

POST /api/proxy/v1/audio/speech

Create Speech

鉴权: OAuth Bearer；Scope: model

参数

名称	位置	必填	类型	说明
X-Xiaoya-Team-Id	header	否	string / null
X-Request-ID	header	是	string	Stable client request ID. Reuse the same value only when retrying the same request in the same billing account context.

请求体

• application/json: TtsSpeechInput（必填）

响应

状态	说明	Schema
200	Generated speech audio. The response is never cached.	string / string / string / string
422	Validation Error	HTTPValidationError

GET /api/proxy/v1/tts/options

List Tts Options

鉴权: OAuth Bearer；Scope: model

参数

名称	位置	必填	类型	说明
X-Xiaoya-Team-Id	header	否	string / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Sponsored billing

POST /api/v1/open/public-billing-sessions

Create Public Billing Session

鉴权: OAuth Bearer；Scope: model

请求体

• application/json: PublicBillingSessionInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/open/public-billing-sessions/{session_id}

Revoke Public Billing Session

鉴权: OAuth Bearer；Scope: model

参数

名称	位置	必填	类型	说明
session_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Runtime assets

GET /api/v1/runtime-assets/{item_type}

List Runtime Assets

鉴权: OAuth Bearer；Scope: skill

参数

名称	位置	必填	类型	说明
item_type	path	是	MarketItemType
X-Xiaoya-Team-Id	header	否	string / null
X-Xiaoya-Team-Context-Version	header	否	integer / null

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/runtime-assets/{item_type}/{item_id}/package

Download Runtime Asset Package

鉴权: OAuth Bearer；Scope: skill

参数

名称	位置	必填	类型	说明
item_type	path	是	MarketItemType
item_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Execution grants

GET /api/v1/teams/{team_id}/execution-grants

Execution Grants

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/teams/{team_id}/execution-grants

Create Execution Grant

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
Idempotency-Key	header	是	string

请求体

• application/json: TeamExecutionGrantInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/teams/{team_id}/execution-grants/{grant_id}

Revoke Execution Grant

鉴权: OAuth Bearer；Scope: team_manage

参数

名称	位置	必填	类型	说明
team_id	path	是	string
grant_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

Sandbox

GET /api/v1/sandbox-runtime/computer/capabilities

Configured Capabilities

鉴权: OAuth Bearer；Scope: sandbox

响应

状态	说明	Schema
200	Successful Response	object

POST /api/v1/sandbox-runtime/workspaces

Create Sandbox Workspace

鉴权: OAuth Bearer；Scope: sandbox

请求体

• application/json: SandboxWorkspaceCreateInput（必填）

响应

状态	说明	Schema
201	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/sandbox-runtime/workspaces/{sandbox_id}

Sandbox Workspace Status

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

DELETE /api/v1/sandbox-runtime/workspaces/{sandbox_id}

Destroy Sandbox Workspace

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/commands

Execute Sandbox Command

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: SandboxCommandInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer

Status

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/control

Acquire

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: ControlAcquireInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/control/heartbeat

Heartbeat

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: ControlLeaseInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/control/release

Release

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: ControlLeaseInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/key

Key

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: KeyInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/mouse

Mouse

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: MouseInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/screenshot

Screenshot

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

GET /api/v1/sandbox-runtime/workspaces/{sandbox_id}/computer/status

Status

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/files

Upload Sandbox File

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: SandboxFileUploadInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/files/download

Download Sandbox File

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: SandboxFileDownloadInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/pause

Pause Sandbox Workspace

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/sandbox-runtime/workspaces/{sandbox_id}/resume

Resume Sandbox Workspace

鉴权: OAuth Bearer；Scope: sandbox

参数

名称	位置	必填	类型	说明
sandbox_id	path	是	string

请求体

• application/json: SandboxResumeInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

MCP service callbacks

POST /api/v1/open-agent-tools/call-context/introspect

Introspect Open Agent Call Context

鉴权: JSON Body 中的智能体 Client ID 与 Client Secret

请求体

• application/json: OpenAgentCallContextIntrospectionInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

POST /api/v1/open-agent-tools/callbacks/{invocation_id}

Complete Open Agent Async Tool

鉴权: X-Xiaoya-Call-Context

参数

名称	位置	必填	类型	说明
invocation_id	path	是	string
X-Xiaoya-Call-Context	header	是	string

请求体

• application/json: OpenAgentAsyncResultInput（必填）

响应

状态	说明	Schema
200	Successful Response	object
422	Validation Error	HTTPValidationError

公共 Schema 字段

Body_authorize_submit_oauth_authorize_post

字段	必填	类型	说明
client_id	是	string	maxLength=32
redirect_uri	是	string	maxLength=2000
scope	否	string	maxLength=500
state_value	否	string / null
code_challenge	否	string / null
code_challenge_method	否	string / null
csrf_token	是	string	maxLength=200
decision	是	string	maxLength=10
team_id	否	string / null
team_consent_proof	否	string / null

Body_upload_profile_avatar_api_v1_open_account_profile_avatar_post

字段	必填	类型	说明
file	是	string	format=binary

ChatMessage

字段	必填	类型	说明
role	是	string	enum=system, user, assistant, tool
content	是	object

ControlAcquireInput

字段	必填	类型	说明
conversationId	是	string	format=uuid

ControlLeaseInput

字段	必填	类型	说明
conversationId	是	string	format=uuid
fence	是	integer	min=1

DesktopExecutionGrantInput

字段	必填	类型	说明
purpose	否	ExecutionGrantPurpose
workspaceId	是	string	minLength=1; maxLength=36
employeeId	是	string	minLength=1; maxLength=36
desktopSessionId	是	string	minLength=1; maxLength=36
deviceId	是	string	minLength=1; maxLength=128
scopes	是	array<string>
expiresInSeconds	否	integer	min=3600; max=31536000

DesktopExecutionRunInput

字段	必填	类型	说明
runId	是	string	minLength=36; maxLength=36

EmployeeCopyInput

字段	必填	类型	说明
operationId	是	string	minLength=8; maxLength=120

EmployeeInstancePatch

字段	必填	类型	说明
expectedConfigVersion	是	integer	min=1
changes	是	object

EmployeeStudioLinkInput

字段	必填	类型	说明
operationId	是	string	minLength=8; maxLength=120
studioEmployeeId	是	string	minLength=1; maxLength=36

EmployeeUpgradeInput

字段	必填	类型	说明
expectedConfigVersion	是	integer	min=1
operationId	是	string	minLength=8; maxLength=120
version	是	string	minLength=1; maxLength=32
resolutions	否	object

ErrorEnvelope

字段	必填	类型	说明
success	是	boolean
code	是	string
message	是	string
request_id	是	string

ExecutionGrantPurpose

结构: string

GiftCardInput

字段	必填	类型	说明
code	是	string	minLength=12; maxLength=64

HTTPValidationError

字段	必填	类型	说明
detail	否	array<ValidationError>

KeyInput

字段	必填	类型	说明
keys	是	array<string>

KnowledgeAgentSearchInput

字段	必填	类型	说明
query	是	string	minLength=1; maxLength=4000
knowledgeBaseIds	否	array<string>
limit	否	integer	min=1; max=20

MarketItemType

结构: string

MembershipBillingPeriod

结构: string

ModelCatalogItem

字段	必填	类型	说明
modelCode	是	string
displayName	是	string
modelType	是	string	enum=llm, image, video
acceptsText	否	boolean
acceptsImage	否	boolean
acceptsFile	否	boolean
outputsText	否	boolean
outputsImage	否	boolean
outputsAudio	否	boolean
outputsVideo	否	boolean
parameterSchemaVersion	是	integer	min=1
parameterSpec	是	object / null
structuredOutputMode	否	string	Explicit structured-output mode declared by the model catalog. Use prompt when this field is absent. The legacy supportsJson flag alone does not declare native json_object or json_schema support.; enum=prompt, json_object, json_schema

MouseInput

字段	必填	类型	说明
x	是	integer	min=0
y	是	integer	min=0
action	否	string	enum=move, click, down, up
button	否	string	enum=left, middle, right

OAuthError

字段	必填	类型	说明
error	是	string	enum=invalid_client, invalid_grant, unsupported_grant_type
error_description	是	string

OAuthTokenResponse

字段	必填	类型	说明
access_token	是	string
token_type	是	string
expires_in	是	integer
scope	是	string
team_id	否	string
team_authorization_id	否	string

OpenAgentAsyncResultInput

字段	必填	类型	说明
result	是	object

OpenAgentCallContextIntrospectionInput

字段	必填	类型	说明
clientId	是	string	minLength=3; maxLength=32
clientSecret	是	string	minLength=1; maxLength=512
token	是	string	minLength=1; maxLength=8192

OpenAgentChargeInput

字段	必填	类型	说明
points	是	integer	min=1; max=1000000000000
reason	是	string	minLength=1; maxLength=100
idempotencyKey	是	string	minLength=8; maxLength=64

OpenAgentRefundInput

字段	必填	类型	说明
points	是	integer	min=1; max=1000000000000
reason	是	string	minLength=1; maxLength=100
idempotencyKey	是	string	minLength=8; maxLength=64
chargeIdempotencyKey	是	string	minLength=8; maxLength=64

OpenAgentTeamChargeInput

字段	必填	类型	说明
points	是	integer	min=1; max=1000000000000
idempotencyKey	是	string	minLength=8; maxLength=64

OpenAgentTeamRefundInput

字段	必填	类型	说明
points	是	integer	min=1; max=1000000000000
idempotencyKey	是	string	minLength=8; maxLength=64
chargeIdempotencyKey	是	string	minLength=8; maxLength=64

OpenAgentUser

字段	必填	类型	说明
userId	是	string	Stable subject isolated to the current open agent.
displayName	是	string
avatarUrl	否	string / null	format=uri

PaymentOrderType

结构: string

PaymentProvider

结构: string

ProfileInput

字段	必填	类型	说明
displayName	否	string / null
avatarUrl	否	string / null

PublicBillingSessionInput

字段	必填	类型	说明
expires_in_seconds	否	integer	min=60; max=3600
max_points	否	integer	min=1; max=1000000000
max_calls	否	integer	min=1; max=10000

RechargeOrderInput

字段	必填	类型	说明
amount_cents	否	integer / null
order_type	否	PaymentOrderType
product_code	否	string / null
idempotency_key	是	string	minLength=8; maxLength=120
catalog_version	否	string / null
billing_period	否	MembershipBillingPeriod / null

SandboxCommandInput

字段	必填	类型	说明
command	是	array<string>
workingDirectory	否	string	minLength=1; maxLength=1000
environment	否	object
timeoutSeconds	否	integer	min=1; max=900

SandboxFileDownloadInput

字段	必填	类型	说明
sourcePath	是	string	minLength=1; maxLength=1000

SandboxFileUploadInput

字段	必填	类型	说明
destinationPath	是	string	minLength=1; maxLength=1000
contentBase64	是	string	minLength=1; maxLength=45000000

SandboxResumeInput

字段	必填	类型	说明
snapshotId	否	string / null

SandboxWorkspaceCreateInput

字段	必填	类型	说明
employeeId	是	string	format=uuid
logicalWorkspaceId	是	string	format=uuid
idempotencyKey	是	string	minLength=8; maxLength=160
cpuMilli	否	integer / null
memoryMb	否	integer / null
maxRunMinutes	否	integer / null
idlePauseSeconds	否	integer / null
environment	否	object

SuccessEnvelope

字段	必填	类型	说明
success	是	boolean
data	是	object
request_id	是	string

TeamContext

字段	必填	类型	说明
teamId	是	string
name	是	string
status	是	string
memberId	是	string
memberStatus	是	string
role	是	string

TeamCreateInput

字段	必填	类型	说明
name	是	string	minLength=1; maxLength=120
idempotencyKey	否	string / null

TeamCreditChangeInput

字段	必填	类型	说明
memberId	是	string	minLength=1; maxLength=36
points	是	integer	min=1; max=1000000000000
idempotencyKey	是	string	minLength=8; maxLength=160

TeamExecutionGrantInput

字段	必填	类型	说明
subjectType	是	TeamExecutionSubjectType
subjectId	是	string	minLength=1; maxLength=128
scopes	是	array<string>
expiresInSeconds	否	integer	min=3600; max=31536000

TeamExecutionSubjectType

结构: string

TeamInvitationAcceptInput

字段	必填	类型	说明
token	是	string	minLength=20; maxLength=200

TeamInvitationInput

字段	必填	类型	说明
invitee	是	string	minLength=3; maxLength=320
role	是	string	minLength=1; maxLength=32
expiresInHours	否	integer	min=1; max=168

TeamJoinLinkCreateInput

字段	必填	类型	说明
kind	否	TeamJoinLinkKind
role	否	string	minLength=1; maxLength=32
maxUses	否	integer	min=1; max=10000
expiresInHours	否	integer	min=1; max=720

TeamJoinLinkKind

结构: string

TeamMemberOrganizationInput

字段	必填	类型	说明
departmentId	否	string / null
positionId	否	string / null
managerMemberId	否	string / null
roleIds	否	array<string>

TeamMemberQuotaInput

字段	必填	类型	说明
quotaLimit	否	integer / null
expectedVersion	是	integer	min=0
idempotencyKey	是	string	minLength=8; maxLength=160

TeamMemberRoleInput

字段	必填	类型	说明
role	是	string	minLength=1; maxLength=32

TeamMembershipOrderAction

结构: string

TeamMembershipOrderInput

字段	必填	类型	说明
provider	是	PaymentProvider
planVersionId	是	string	minLength=1; maxLength=36
action	是	TeamMembershipOrderAction
idempotencyKey	是	string	minLength=8; maxLength=120
expectedSubscriptionVersion	否	integer / null
seatCount	否	integer / null
billingPeriod	否	MembershipBillingPeriod / null

TeamMemberStatusInput

字段	必填	类型	说明
status	是	string	minLength=1; maxLength=24

TeamModelCatalog

字段	必填	类型	说明
teamId	是	string
teamContextVersion	是	integer
planVersionId	是	string
catalogVersion	是	string
items	是	array<ModelCatalogItem>

TeamOrganizationItemInput

字段	必填	类型	说明
name	是	string	minLength=1; maxLength=120
parentId	否	string / null
description	否	string	maxLength=500

TeamProfileInput

字段	必填	类型	说明
name	是	string	minLength=1; maxLength=120
avatarUrl	否	string / null
description	否	string	maxLength=500

TeamWalletFundingInput

字段	必填	类型	说明
points	是	integer	min=1; max=1000000000000
idempotencyKey	是	string	minLength=8; maxLength=160

TtsSpeechInput

字段	必填	类型	说明
tts_config_id	是	string	minLength=3; maxLength=100
voice	是	string	minLength=1; maxLength=256
input	是	string	minLength=1; maxLength=9999
response_format	否	string	minLength=2; maxLength=20
speed	否	number	min=0.5; max=2
volume	否	number	max=10
pitch	否	integer	min=-12; max=12
emotion	否	string / null
sample_rate	否	integer	enum=8000, 16000, 22050, 24000, 32000, 44100
bitrate	否	integer	enum=32000, 64000, 128000, 256000
audio_channel	否	integer	enum=1, 2
language_boost	否	string	enum=Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Persian, Slovak, Swedish, Croatian, Filipino, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Tamil, Afrikaans, auto
text_normalization	否	boolean
latex_read	否	boolean

ValidationError

字段	必填	类型	说明
loc	是	array<string / integer>
msg	是	string
type	是	string