参考
API参考
预览版：功能和API可能会变化。
PDF由浏览器的打印对话框生成，不是托管的导出服务。
公开API参考
API参考。本页不会发送任何请求。
1. 说明
Draft getCurrentUser
2. 地址
GET /me
相对于你配置的Control API基础地址。本页不会访问任何托管端点。
3. 请求参数
此Schema层级未声明属性表。
4. 响应参数
200
Locally implemented safe current User response.
| 名称 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
data | object | response | 必填 | #/components/schemas/CurrentUserResource |
只有此对象存在时，必填要求才生效。
response.data
只有此对象存在时，必填要求才生效。
| 名称 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
id | string | response | 必填 | 暂无说明。 |
status | string | response | 必填 | 暂无说明。 |
display_name | string | response | 必填 | 暂无说明。 |
created_at | string | response | 必填 | 暂无说明。 |
memberships | array<object> | response | 必填 | 暂无说明。 |
memberships_truncated | boolean | response | 必填 | 暂无说明。 |
projects | array<object> | response | 必填 | 暂无说明。 |
projects_truncated | boolean | response | 必填 | 暂无说明。 |
response.data.memberships[]
只有此对象存在时，必填要求才生效。
| 名称 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
organization_id | string | response | 必填 | 暂无说明。 |
user_id | string | response | 必填 | 暂无说明。 |
role | string | response | 必填 | 暂无说明。 |
status | string | response | 必填 | 暂无说明。 |
created_at | string | response | 必填 | 暂无说明。 |
response.data.projects[]
只有此对象存在时，必填要求才生效。
| 名称 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
id | string | response | 必填 | 暂无说明。 |
organization_id | string | response | 必填 | 暂无说明。 |
name | string | response | 必填 | 暂无说明。 |
status | string | response | 必填 | 暂无说明。 |
default_region | string | response | 必填 | 暂无说明。 |
created_at | string | response | 必填 | 暂无说明。 |
environments | array<object> | response | 必填 | 暂无说明。 |
response.data.projects[].environments[]
只有此对象存在时，必填要求才生效。
| 名称 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
id | string | response | 必填 | 暂无说明。 |
kind | string | response | 必填 | 暂无说明。 |
status | string | response | 必填 | 暂无说明。 |
enabled | boolean | response | 必填 | 暂无说明。 |
5. 请求示例
暂无请求示例。
6. 响应示例
暂无响应示例。请参考上方的响应参数。
7. 错误
default: Canonical OneSay error response.
OneSay Control API的公开操作，由它的OpenAPI文档生成。参考目录列出了能力、操作、授权、事件、错误码和MCP工具。
在本页的操作浏览器中选择一个操作，即可查看它的地址、请求和响应字段、示例以及错误。
全部操作#
每个操作的方法、路径及其所需授权。
| 操作 | 方法 | 路径 | 授权 |
|---|---|---|---|
getCurrentUser | GET | /me | 无（适用身份验证策略） |
createOrganization | POST | /organizations | 无（适用身份验证策略） |
listOrganizations | GET | /organizations | organization.read |
getOrganization | GET | /organizations/{organization_id} | organization.read |
updateOrganization | PATCH | /organizations/{organization_id} | organization.manage |
listOrganizationMemberships | GET | /organizations/{organization_id}/memberships | organization.read |
createOrganizationMembership | POST | /organizations/{organization_id}/memberships | organization.manage |
createProject | POST | /projects | project.manage |
listProjects | GET | /projects | project.read |
getProject | GET | /projects/{project_id} | project.read |
updateProject | PATCH | /projects/{project_id} | project.manage |
archiveProject | POST | /projects/{project_id}/archive | project.manage |
listProjectEnvironments | GET | /projects/{project_id}/environments | project.read |
createApplication | POST | /applications | application.manage |
listApplications | GET | /applications | application.read |
getApplication | GET | /applications/{application_id} | application.read |
updateApplication | PATCH | /applications/{application_id} | application.manage |
revokeApplication | POST | /applications/{application_id}/revoke | application.manage |
createCredential | POST | /credentials | credential.create |
listCredentials | GET | /credentials | credential.read |
getCredential | GET | /credentials/{credential_id} | credential.read |
rotateCredential | POST | /credentials/{credential_id}/rotate | credential.create |
revokeCredential | POST | /credentials/{credential_id}/revoke | credential.revoke |
createDevice | POST | /devices | device.create |
listDevices | GET | /devices | device.read |
getDevice | GET | /devices/{device_id} | device.read |
updateDevice | PATCH | /devices/{device_id} | device.update |
publishDeviceCapabilities | PUT | /devices/{device_id}/capabilities | device.capabilities.publish |
createDeviceProvisioningSession | POST | /devices/{device_id}/provisioning-sessions | device.update |
exchangeDeviceAccessToken | POST | /device-access-tokens | 无（适用身份验证策略） |
exchangeDeviceProvisioningCode | POST | /device-provisioning/exchange | 无（适用身份验证策略） |
rotateDeviceCredential | POST | /devices/{device_id}/credentials/rotate | device.update |
revokeDevice | POST | /devices/{device_id}/revoke | device.revoke |
createSource | POST | /sources | source.create |
listSources | GET | /sources | source.read |
getSource | GET | /sources/{source_id} | source.read |
createContextSnapshot | POST | /context-snapshots | context_snapshot.create |
getContextSnapshot | GET | /context-snapshots/{context_snapshot_id} | context_snapshot.read |
createRoom | POST | /rooms | room.create |
listRooms | GET | /rooms | room.read |
getRoom | GET | /rooms/{room_id} | room.read |
closeRoom | POST | /rooms/{room_id}/close | room.close |
listRoomParticipants | GET | /rooms/{room_id}/participants | participant.read |
listRoomSignals | GET | /rooms/{room_id}/signals | room.read |
createRealtimeConnection | POST | /realtime/connections | room.join |
resumeRealtimeConnection | POST | /realtime/connections/resume | room.join |
getRealtimeCapabilities | GET | /realtime/capabilities | capability.read |
createTask | POST | /tasks | task.dictation.create |
listTasks | GET | /tasks | task.read |
getTask | GET | /tasks/{task_id} | task.read |
cancelTask | POST | /tasks/{task_id}/cancel | task.cancel |
getUsageSummary | GET | /usage/summary | usage.read |
listUsageEvents | GET | /usage/events | usage.read |
listDeveloperLogs | GET | /logs | logs.read |
getDeveloperLogTimeline | GET | /logs/{request_id} | logs.read |
listCapabilities | GET | /capabilities | capability.read |
getCapability | GET | /capabilities/{capability_id} | capability.read |
listActions | GET | /actions | capability.read |
getAction | GET | /actions/{action_id} | capability.read |
getApplicationRequirements | GET | /applications/{application_id}/requirements | application.requirements.read |
replaceApplicationRequirements | PUT | /applications/{application_id}/requirements | application.manage |
evaluateApplicationCompatibility | GET | /applications/{application_id}/compatibility | application.compatibility.read |
createAppSession | POST | /app-sessions | app.session.create |
getAppSession | GET | /app-sessions/{app_session_id} | app.session.read |
closeAppSession | POST | /app-sessions/{app_session_id}/close | app.session.close |
revokeAppSession | POST | /app-sessions/{app_session_id}/revoke | app.session.revoke |
getAppSessionCapabilities | GET | /app-sessions/{app_session_id}/capabilities | app.session.capabilities.read |
createConsentRequest | POST | /consent-requests | 无（适用身份验证策略） |
getConsentRequest | GET | /consent-requests/{consent_request_id} | 无（适用身份验证策略） |
decideConsentRequest | POST | /consent-requests/{consent_request_id}/decision | 无（适用身份验证策略） |
createDelegation | POST | /delegations | delegation.create |
listDelegations | GET | /delegations | delegation.read |
getDelegation | GET | /delegations/{delegation_id} | delegation.read |
revokeDelegation | POST | /delegations/{delegation_id}/revoke | delegation.revoke |
enableDataSyncScope | POST | /data-sync/scopes/enable | data.sync.control |
disableDataSyncScopeRetainingData | POST | /data-sync/scopes/disable-retain | data.sync.control |
readDataSyncChanges | GET | /data-sync/changes | data.sync.read |
createDataSyncSnapshot | POST | /data-sync/snapshots | data.sync.read |
readDataSyncSnapshot | GET | /data-sync/snapshots/{snapshot_id} | data.sync.read |
completeDataSyncSnapshot | POST | /data-sync/snapshots/{snapshot_id}/complete | data.sync.read |
createRTCConnection | POST | /rtc/connections | room.join |
getRTCConnection | GET | /rtc/connections/{connection_id} | room.join |
revokeRTCConnection | POST | /rtc/connections/{connection_id}/revoke | room.join |
getRTCMediaKeys | GET | /rtc/connections/{connection_id}/media-keys | room.join |
createRTCPublication | POST | /rooms/{room_id}/rtc/publications | room.join, source.use |
endRTCPublication | POST | /rooms/{room_id}/rtc/publications/{publication_id}/end | room.join |
updateRTCSubscriptions | PUT | /rooms/{room_id}/rtc/subscriptions | room.join, rtc.subscription.configure |
createAgentExecution | POST | /rooms/{room_id}/agent-executions | room.join, source.use, signal.audio.subscribe, agent.execution.create |
getAgentExecution | GET | /rooms/{room_id}/agent-executions/{agent_execution_id} | agent.execution.read |
stopAgentExecution | POST | /rooms/{room_id}/agent-executions/{agent_execution_id}/stop | agent.execution.stop |
updateRTCPacketPolicy | PUT | /rooms/{room_id}/rtc/packet-policy | room.join, rtc.packet.configure |
查看原始Markdown
# API参考
OneSay Control API的公开操作，由它的OpenAPI文档生成。[参考目录](catalog.md)列出了能力、操作、授权、事件、错误码和MCP工具。
在本页的操作浏览器中选择一个操作，即可查看它的地址、请求和响应字段、示例以及错误。
## 全部操作
每个操作的方法、路径及其所需授权。
| 操作 | 方法 | 路径 | 授权 |
|---|---|---|---|
| `getCurrentUser` | GET | `/me` | 无（适用身份验证策略） |
| `createOrganization` | POST | `/organizations` | 无（适用身份验证策略） |
| `listOrganizations` | GET | `/organizations` | `organization.read` |
| `getOrganization` | GET | `/organizations/{organization_id}` | `organization.read` |
| `updateOrganization` | PATCH | `/organizations/{organization_id}` | `organization.manage` |
| `listOrganizationMemberships` | GET | `/organizations/{organization_id}/memberships` | `organization.read` |
| `createOrganizationMembership` | POST | `/organizations/{organization_id}/memberships` | `organization.manage` |
| `createProject` | POST | `/projects` | `project.manage` |
| `listProjects` | GET | `/projects` | `project.read` |
| `getProject` | GET | `/projects/{project_id}` | `project.read` |
| `updateProject` | PATCH | `/projects/{project_id}` | `project.manage` |
| `archiveProject` | POST | `/projects/{project_id}/archive` | `project.manage` |
| `listProjectEnvironments` | GET | `/projects/{project_id}/environments` | `project.read` |
| `createApplication` | POST | `/applications` | `application.manage` |
| `listApplications` | GET | `/applications` | `application.read` |
| `getApplication` | GET | `/applications/{application_id}` | `application.read` |
| `updateApplication` | PATCH | `/applications/{application_id}` | `application.manage` |
| `revokeApplication` | POST | `/applications/{application_id}/revoke` | `application.manage` |
| `createCredential` | POST | `/credentials` | `credential.create` |
| `listCredentials` | GET | `/credentials` | `credential.read` |
| `getCredential` | GET | `/credentials/{credential_id}` | `credential.read` |
| `rotateCredential` | POST | `/credentials/{credential_id}/rotate` | `credential.create` |
| `revokeCredential` | POST | `/credentials/{credential_id}/revoke` | `credential.revoke` |
| `createDevice` | POST | `/devices` | `device.create` |
| `listDevices` | GET | `/devices` | `device.read` |
| `getDevice` | GET | `/devices/{device_id}` | `device.read` |
| `updateDevice` | PATCH | `/devices/{device_id}` | `device.update` |
| `publishDeviceCapabilities` | PUT | `/devices/{device_id}/capabilities` | `device.capabilities.publish` |
| `createDeviceProvisioningSession` | POST | `/devices/{device_id}/provisioning-sessions` | `device.update` |
| `exchangeDeviceAccessToken` | POST | `/device-access-tokens` | 无（适用身份验证策略） |
| `exchangeDeviceProvisioningCode` | POST | `/device-provisioning/exchange` | 无（适用身份验证策略） |
| `rotateDeviceCredential` | POST | `/devices/{device_id}/credentials/rotate` | `device.update` |
| `revokeDevice` | POST | `/devices/{device_id}/revoke` | `device.revoke` |
| `createSource` | POST | `/sources` | `source.create` |
| `listSources` | GET | `/sources` | `source.read` |
| `getSource` | GET | `/sources/{source_id}` | `source.read` |
| `createContextSnapshot` | POST | `/context-snapshots` | `context_snapshot.create` |
| `getContextSnapshot` | GET | `/context-snapshots/{context_snapshot_id}` | `context_snapshot.read` |
| `createRoom` | POST | `/rooms` | `room.create` |
| `listRooms` | GET | `/rooms` | `room.read` |
| `getRoom` | GET | `/rooms/{room_id}` | `room.read` |
| `closeRoom` | POST | `/rooms/{room_id}/close` | `room.close` |
| `listRoomParticipants` | GET | `/rooms/{room_id}/participants` | `participant.read` |
| `listRoomSignals` | GET | `/rooms/{room_id}/signals` | `room.read` |
| `createRealtimeConnection` | POST | `/realtime/connections` | `room.join` |
| `resumeRealtimeConnection` | POST | `/realtime/connections/resume` | `room.join` |
| `getRealtimeCapabilities` | GET | `/realtime/capabilities` | `capability.read` |
| `createTask` | POST | `/tasks` | `task.dictation.create` |
| `listTasks` | GET | `/tasks` | `task.read` |
| `getTask` | GET | `/tasks/{task_id}` | `task.read` |
| `cancelTask` | POST | `/tasks/{task_id}/cancel` | `task.cancel` |
| `getUsageSummary` | GET | `/usage/summary` | `usage.read` |
| `listUsageEvents` | GET | `/usage/events` | `usage.read` |
| `listDeveloperLogs` | GET | `/logs` | `logs.read` |
| `getDeveloperLogTimeline` | GET | `/logs/{request_id}` | `logs.read` |
| `listCapabilities` | GET | `/capabilities` | `capability.read` |
| `getCapability` | GET | `/capabilities/{capability_id}` | `capability.read` |
| `listActions` | GET | `/actions` | `capability.read` |
| `getAction` | GET | `/actions/{action_id}` | `capability.read` |
| `getApplicationRequirements` | GET | `/applications/{application_id}/requirements` | `application.requirements.read` |
| `replaceApplicationRequirements` | PUT | `/applications/{application_id}/requirements` | `application.manage` |
| `evaluateApplicationCompatibility` | GET | `/applications/{application_id}/compatibility` | `application.compatibility.read` |
| `createAppSession` | POST | `/app-sessions` | `app.session.create` |
| `getAppSession` | GET | `/app-sessions/{app_session_id}` | `app.session.read` |
| `closeAppSession` | POST | `/app-sessions/{app_session_id}/close` | `app.session.close` |
| `revokeAppSession` | POST | `/app-sessions/{app_session_id}/revoke` | `app.session.revoke` |
| `getAppSessionCapabilities` | GET | `/app-sessions/{app_session_id}/capabilities` | `app.session.capabilities.read` |
| `createConsentRequest` | POST | `/consent-requests` | 无（适用身份验证策略） |
| `getConsentRequest` | GET | `/consent-requests/{consent_request_id}` | 无（适用身份验证策略） |
| `decideConsentRequest` | POST | `/consent-requests/{consent_request_id}/decision` | 无（适用身份验证策略） |
| `createDelegation` | POST | `/delegations` | `delegation.create` |
| `listDelegations` | GET | `/delegations` | `delegation.read` |
| `getDelegation` | GET | `/delegations/{delegation_id}` | `delegation.read` |
| `revokeDelegation` | POST | `/delegations/{delegation_id}/revoke` | `delegation.revoke` |
| `enableDataSyncScope` | POST | `/data-sync/scopes/enable` | `data.sync.control` |
| `disableDataSyncScopeRetainingData` | POST | `/data-sync/scopes/disable-retain` | `data.sync.control` |
| `readDataSyncChanges` | GET | `/data-sync/changes` | `data.sync.read` |
| `createDataSyncSnapshot` | POST | `/data-sync/snapshots` | `data.sync.read` |
| `readDataSyncSnapshot` | GET | `/data-sync/snapshots/{snapshot_id}` | `data.sync.read` |
| `completeDataSyncSnapshot` | POST | `/data-sync/snapshots/{snapshot_id}/complete` | `data.sync.read` |
| `createRTCConnection` | POST | `/rtc/connections` | `room.join` |
| `getRTCConnection` | GET | `/rtc/connections/{connection_id}` | `room.join` |
| `revokeRTCConnection` | POST | `/rtc/connections/{connection_id}/revoke` | `room.join` |
| `getRTCMediaKeys` | GET | `/rtc/connections/{connection_id}/media-keys` | `room.join` |
| `createRTCPublication` | POST | `/rooms/{room_id}/rtc/publications` | `room.join`, `source.use` |
| `endRTCPublication` | POST | `/rooms/{room_id}/rtc/publications/{publication_id}/end` | `room.join` |
| `updateRTCSubscriptions` | PUT | `/rooms/{room_id}/rtc/subscriptions` | `room.join`, `rtc.subscription.configure` |
| `createAgentExecution` | POST | `/rooms/{room_id}/agent-executions` | `room.join`, `source.use`, `signal.audio.subscribe`, `agent.execution.create` |
| `getAgentExecution` | GET | `/rooms/{room_id}/agent-executions/{agent_execution_id}` | `agent.execution.read` |
| `stopAgentExecution` | POST | `/rooms/{room_id}/agent-executions/{agent_execution_id}/stop` | `agent.execution.stop` |
| `updateRTCPacketPolicy` | PUT | `/rooms/{room_id}/rtc/packet-policy` | `room.join`, `rtc.packet.configure` |