Guest Machines
API referenceAgents

List agents

GET/api/v1/agents

List agents visible to the caller in the active organization.

Private agents are only visible to their owner and org admins/owners. Restricted agents are visible to their owner, org admins, and grantees. Org-shared agents are visible to all members.

Required access

Credentials: service principal, delegated token, user session

Scope: agents:read

Returns only agents the caller can see. Private agents are invisible to service principals regardless of scope, so a correctly scoped key against an unshared workspace returns an empty list rather than an error.

Authorization

AuthorizationBearer <token>

An organization-owned automation key, prefixed gsmc_sk_. Already bound to one organization, so it needs no X-Org-Id header. It carries no user identity: it never reaches a private resource however it is scoped, and a run it starts has no user for an interactive tool to reach.

In: header

Query Parameters

include_inactive?Include Inactive

Include inactive agents

Defaultfalse
include_tools?Include Tools

Include assigned tool names for each agent

Defaulttrue

Header Parameters

X-Org-Id?|

Selects the active organization for a credential that belongs to more than one. Service-principal keys are bound to a single organization and ignore it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/agents" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
{  "agents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "owner_user_id": "65139110-7c3c-4777-b692-80c218be3b9d",      "visibility": "org_shared",      "name": "string",      "description": "string",      "executor_type": "claude",      "model": "string",      "system_prompt": "string",      "thinking_level": "none",      "temperature": 0.1,      "execution_environment": "guest_vm",      "computer_use_enabled": false,      "environment_config": {},      "input_schema": {},      "output_schema": {},      "is_active": true,      "auto_respond": false,      "owning_team_id": "1e618706-c399-4dc7-864c-009ddf950b84",      "allowed_invocables": [        "string"      ],      "knowledge_scope": {        "folder_ids": [          "c9c54c2c-7793-4b70-8b93-7e3771bbc0c0"        ],        "file_ids": [          "1c0f12fe-c5bf-4fbd-ba1b-466cb232eca5"        ]      },      "avatar_blob_name": "string",      "avatar_sas_url": "string",      "avatar_expires_at": "2019-08-24T14:15:22Z",      "configured_tools": [        {          "origin": "builtin",          "source_id": "string",          "canonical_name": "string",          "display_name": "string",          "enabled": true,          "owned_by_caller": true        }      ],      "hidden_configured_tool_count": 0,      "allowed_tools": [        "string"      ],      "mcp_server_ids": [        "6645753c-0a13-4667-8dd3-d80a8e4fd76f"      ],      "tool_approval_modes": {        "property1": "auto",        "property2": "auto"      },      "unattended_preapproved_tools": [        "string"      ],      "config_revision": 0,      "config_digest": "0000000000000000000000000000000000000000000000000000000000000000",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}