Workspaces
Operations of the Interactive Session API. Paths are relative to your deployment's API host.
GET /api/agent-session-api/workspaces
List Workspaces in the caller's verified project owner space using cursor pagination
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
cursor | query | string | no | Opaque cursor returned by the previous page. |
limit | query | number | no | |
status | query | WorkspaceStatus | no |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WorkspaceResponseDtoPaginatedEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/agent-session-api/workspaces
Create a durable Workspace identity in the caller's verified project owner space
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json CreateWorkspaceDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json WorkspaceResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/agent-session-api/workspaces/{workspaceId}
Get a Workspace from the verified owner space
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
workspaceId | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WorkspaceResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/agent-session-api/workspaces/{workspaceId}/archive
Archive a Workspace after verifying owner scope and absence of an active write lease
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
workspaceId | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WorkspaceResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |