Sign in

v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

List computers

Returns all computers belonging to the authenticated app, ordered by creation time descending. Pass agent to scope the results to a single agent's computers. When agent is omitted, computers for all agents in the app are returned.

Requires an app-scoped API key. If the specified agent does not exist or does not belong to the app, the endpoint returns 404.

get/api/v1/agents/{agent}/agent_computers

Path parameters

agentstring required

Agent ID (agt_...). When provided, only computers belonging to this agent are returned.

Response

Successful response

Example response

{
  "data": [
    {
      "agent": "agi_0aBcDeFgHiJkLmNoPqRsTu",
      "app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
      "config": {
        "key": "value"
      },
      "created_at": "2024-01-01T00:00:00Z",
      "error_message": "string",
      "id": "cmp_0aBcDeFgHiJkLmNoPqRsTu",
      "last_active_at": "2024-01-01T00:00:00Z",
      "lookup_key": "main-computer",
      "metadata": {
        "key": "value"
      },
      "name": "Example Name",
      "region": "us-east-1",
      "sprite_url": "https://example.com",
      "status": "ready",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}