Console endpoint

Open Console Session

POST/console-sessions/

Example request

application/json

{
  "resourceId": "my-interactive-resource"
}

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/console-sessions/"

Supply a valid request.json before running this command.

201 Createdapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "resourceId": "string",
  "runtimeId": "string",
  "connectionId": "string",
  "actorId": "string",
  "status": "string",
  "externalId": "string",
  "failure": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "connectedAt": "2026-01-01T00:00:00Z",
  "finishedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Replace the example resourceId with a saved resource that has a connected interactive runtime; actorId is optional. A successful request starts the terminal and returns a connected session. Resolution or startup failure returns 422, not a successful session record. Use the console guide for streaming and closure.

Related guide

See the Console guide for related tasks and context.