Sign in

v54

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-03397565628.8 KB
Tasks

Get AI task by ID or name

get/api/v2/tasks/{user}/{task}

Path parameters

userstring required

Username, user ID, or 'me' for the authenticated user

taskstring required

Task ID, or task name

Response

OK

created_atstring date-time
display_namestring
idstring uuid
initial_promptstring
namestring
organization_idstring uuid
owner_avatar_urlstring
owner_idstring uuid
owner_namestring
status'pending' | 'initializing' | 'active' | 'paused' | 'unknown' | 'error'
template_display_namestring
template_iconstring
template_idstring uuid
template_namestring
template_version_idstring uuid
updated_atstring date-time
workspace_agent_lifecycle'created' | 'starting' | 'start_timeout' | 'start_error' | 'ready' | 'shutting_down' | 'shutdown_timeout' | 'shutdown_error' | 'off'
workspace_build_numberinteger
workspace_namestring
workspace_status'pending' | 'starting' | 'running' | 'stopping' | 'stopped' | 'failed' | 'canceling' | 'canceled' | 'deleting' | 'deleted'

Example response

{
  "workspace_agent_health": {
    "reason": "agent has lost connection"
  }
}