a13nDocs

打开桌面查看器

POST/api/v1/environments/{environment_id}/desktop-viewer

认证与授权

认证与授权Bearer <token>

工作空间 API 密钥(a13n_...)

传递位置: header

路径参数

environment_id*Environment Id

请求头参数

X-Workspace-ID?|

登录会话作用的工作空间 ID,登录会话必须提供。API 密钥作用于自身工作空间,无需提供;禁止指定其他工作空间。

请求体

application/json

TypeScript 类型定义

在 TypeScript 中使用 request body 类型。

响应体

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments/string/desktop-viewer" \  -H "Content-Type: application/json" \  -d '{}'
{  "episode": 0,  "expires_at": "2019-08-24T14:15:22Z",  "generation": 0,  "mode": "view",  "password": "string",  "viewer_id": "string",  "websocket_url": "string"}