このページの内容

リファレンス

APIリファレンス

プレビュー版:機能とAPIは変更される場合があります。

PDFはブラウザーの印刷ダイアログで作成します。ホスト型のエクスポートサービスではありません。

公開APIリファレンス

APIリファレンスです。このページからリクエストは送信されません。

1. 説明

Draft getCurrentUser

2. アドレス

GET /me

設定済みのControl APIベースURLからの相対パスです。このページからホストされたエンドポイントに接続することはありません。

3. リクエストパラメーター

このスキーマ階層にはプロパティ表が定義されていません。

4. レスポンスパラメーター

200

Locally implemented safe current User response.

名前型場所必須説明
dataobjectresponse必須#/components/schemas/CurrentUserResource

必須の指定は、このオブジェクトが存在する場合に適用されます。

response.data

必須の指定は、このオブジェクトが存在する場合に適用されます。

名前型場所必須説明
idstringresponse必須説明はありません。
statusstringresponse必須説明はありません。
display_namestringresponse必須説明はありません。
created_atstringresponse必須説明はありません。
membershipsarray<object>response必須説明はありません。
memberships_truncatedbooleanresponse必須説明はありません。
projectsarray<object>response必須説明はありません。
projects_truncatedbooleanresponse必須説明はありません。
response.data.memberships[]

必須の指定は、このオブジェクトが存在する場合に適用されます。

名前型場所必須説明
organization_idstringresponse必須説明はありません。
user_idstringresponse必須説明はありません。
rolestringresponse必須説明はありません。
statusstringresponse必須説明はありません。
created_atstringresponse必須説明はありません。
response.data.projects[]

必須の指定は、このオブジェクトが存在する場合に適用されます。

名前型場所必須説明
idstringresponse必須説明はありません。
organization_idstringresponse必須説明はありません。
namestringresponse必須説明はありません。
statusstringresponse必須説明はありません。
default_regionstringresponse必須説明はありません。
created_atstringresponse必須説明はありません。
environmentsarray<object>response必須説明はありません。
response.data.projects[].environments[]

必須の指定は、このオブジェクトが存在する場合に適用されます。

名前型場所必須説明
idstringresponse必須説明はありません。
kindstringresponse必須説明はありません。
statusstringresponse必須説明はありません。
enabledbooleanresponse必須説明はありません。

5. リクエスト例

リクエスト例はありません。

6. レスポンス例

レスポンス例はありません。上記のレスポンスパラメーターを参照してください。

7. エラー

  • default: Canonical OneSay error response.

OneSay Control APIの公開オペレーションです。OpenAPIドキュメントから生成しています。リファレンスカタログには、ケイパビリティ、アクション、グラント、イベント、エラーコード、MCPツールを掲載しています。

このページのオペレーションブラウザーで、各オペレーションのアドレス、リクエストとレスポンスのフィールド、例、エラーを確認できます。

オペレーション#

各オペレーションのメソッド、パス、必要なグラントです。

オペレーションメソッドパスグラント
getCurrentUserGET/meなし(認証ポリシーを適用)
createOrganizationPOST/organizationsなし(認証ポリシーを適用)
listOrganizationsGET/organizationsorganization.read
getOrganizationGET/organizations/{organization_id}organization.read
updateOrganizationPATCH/organizations/{organization_id}organization.manage
listOrganizationMembershipsGET/organizations/{organization_id}/membershipsorganization.read
createOrganizationMembershipPOST/organizations/{organization_id}/membershipsorganization.manage
createProjectPOST/projectsproject.manage
listProjectsGET/projectsproject.read
getProjectGET/projects/{project_id}project.read
updateProjectPATCH/projects/{project_id}project.manage
archiveProjectPOST/projects/{project_id}/archiveproject.manage
listProjectEnvironmentsGET/projects/{project_id}/environmentsproject.read
createApplicationPOST/applicationsapplication.manage
listApplicationsGET/applicationsapplication.read
getApplicationGET/applications/{application_id}application.read
updateApplicationPATCH/applications/{application_id}application.manage
revokeApplicationPOST/applications/{application_id}/revokeapplication.manage
createCredentialPOST/credentialscredential.create
listCredentialsGET/credentialscredential.read
getCredentialGET/credentials/{credential_id}credential.read
rotateCredentialPOST/credentials/{credential_id}/rotatecredential.create
revokeCredentialPOST/credentials/{credential_id}/revokecredential.revoke
createDevicePOST/devicesdevice.create
listDevicesGET/devicesdevice.read
getDeviceGET/devices/{device_id}device.read
updateDevicePATCH/devices/{device_id}device.update
publishDeviceCapabilitiesPUT/devices/{device_id}/capabilitiesdevice.capabilities.publish
createDeviceProvisioningSessionPOST/devices/{device_id}/provisioning-sessionsdevice.update
exchangeDeviceAccessTokenPOST/device-access-tokensなし(認証ポリシーを適用)
exchangeDeviceProvisioningCodePOST/device-provisioning/exchangeなし(認証ポリシーを適用)
rotateDeviceCredentialPOST/devices/{device_id}/credentials/rotatedevice.update
revokeDevicePOST/devices/{device_id}/revokedevice.revoke
createSourcePOST/sourcessource.create
listSourcesGET/sourcessource.read
getSourceGET/sources/{source_id}source.read
createContextSnapshotPOST/context-snapshotscontext_snapshot.create
getContextSnapshotGET/context-snapshots/{context_snapshot_id}context_snapshot.read
createRoomPOST/roomsroom.create
listRoomsGET/roomsroom.read
getRoomGET/rooms/{room_id}room.read
closeRoomPOST/rooms/{room_id}/closeroom.close
listRoomParticipantsGET/rooms/{room_id}/participantsparticipant.read
listRoomSignalsGET/rooms/{room_id}/signalsroom.read
createRealtimeConnectionPOST/realtime/connectionsroom.join
resumeRealtimeConnectionPOST/realtime/connections/resumeroom.join
getRealtimeCapabilitiesGET/realtime/capabilitiescapability.read
createTaskPOST/taskstask.dictation.create
listTasksGET/taskstask.read
getTaskGET/tasks/{task_id}task.read
cancelTaskPOST/tasks/{task_id}/canceltask.cancel
getUsageSummaryGET/usage/summaryusage.read
listUsageEventsGET/usage/eventsusage.read
listDeveloperLogsGET/logslogs.read
getDeveloperLogTimelineGET/logs/{request_id}logs.read
listCapabilitiesGET/capabilitiescapability.read
getCapabilityGET/capabilities/{capability_id}capability.read
listActionsGET/actionscapability.read
getActionGET/actions/{action_id}capability.read
getApplicationRequirementsGET/applications/{application_id}/requirementsapplication.requirements.read
replaceApplicationRequirementsPUT/applications/{application_id}/requirementsapplication.manage
evaluateApplicationCompatibilityGET/applications/{application_id}/compatibilityapplication.compatibility.read
createAppSessionPOST/app-sessionsapp.session.create
getAppSessionGET/app-sessions/{app_session_id}app.session.read
closeAppSessionPOST/app-sessions/{app_session_id}/closeapp.session.close
revokeAppSessionPOST/app-sessions/{app_session_id}/revokeapp.session.revoke
getAppSessionCapabilitiesGET/app-sessions/{app_session_id}/capabilitiesapp.session.capabilities.read
createConsentRequestPOST/consent-requestsなし(認証ポリシーを適用)
getConsentRequestGET/consent-requests/{consent_request_id}なし(認証ポリシーを適用)
decideConsentRequestPOST/consent-requests/{consent_request_id}/decisionなし(認証ポリシーを適用)
createDelegationPOST/delegationsdelegation.create
listDelegationsGET/delegationsdelegation.read
getDelegationGET/delegations/{delegation_id}delegation.read
revokeDelegationPOST/delegations/{delegation_id}/revokedelegation.revoke
enableDataSyncScopePOST/data-sync/scopes/enabledata.sync.control
disableDataSyncScopeRetainingDataPOST/data-sync/scopes/disable-retaindata.sync.control
readDataSyncChangesGET/data-sync/changesdata.sync.read
createDataSyncSnapshotPOST/data-sync/snapshotsdata.sync.read
readDataSyncSnapshotGET/data-sync/snapshots/{snapshot_id}data.sync.read
completeDataSyncSnapshotPOST/data-sync/snapshots/{snapshot_id}/completedata.sync.read
createRTCConnectionPOST/rtc/connectionsroom.join
getRTCConnectionGET/rtc/connections/{connection_id}room.join
revokeRTCConnectionPOST/rtc/connections/{connection_id}/revokeroom.join
getRTCMediaKeysGET/rtc/connections/{connection_id}/media-keysroom.join
createRTCPublicationPOST/rooms/{room_id}/rtc/publicationsroom.join, source.use
endRTCPublicationPOST/rooms/{room_id}/rtc/publications/{publication_id}/endroom.join
updateRTCSubscriptionsPUT/rooms/{room_id}/rtc/subscriptionsroom.join, rtc.subscription.configure
createAgentExecutionPOST/rooms/{room_id}/agent-executionsroom.join, source.use, signal.audio.subscribe, agent.execution.create
getAgentExecutionGET/rooms/{room_id}/agent-executions/{agent_execution_id}agent.execution.read
stopAgentExecutionPOST/rooms/{room_id}/agent-executions/{agent_execution_id}/stopagent.execution.stop
updateRTCPacketPolicyPUT/rooms/{room_id}/rtc/packet-policyroom.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` |