Skip to main content
GET
/
v1
/
agents
List agents
curl --request GET \
  --url https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "model": "<string>",
      "fallback_models": [
        "<string>"
      ],
      "temperature": 123,
      "icon_url": "<string>",
      "skills": [
        {}
      ],
      "tools": [
        {
          "id": "<string>",
          "type": "file_search",
          "name": "<string>",
          "display_name": "<string>",
          "description": "<string>",
          "catalog_id": "<string>",
          "auth": {},
          "icon_url": "<string>",
          "vector_store_id": "<string>",
          "server": "<string>",
          "headers": {},
          "scope": "<string>",
          "url": "<string>",
          "parameters": {}
        }
      ],
      "tool_permissions": {},
      "guardrails": {},
      "sub_agents": [
        {
          "agent_id": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "starters": [
        {}
      ],
      "allowed_models": [
        "<string>"
      ],
      "max_tokens": 123,
      "max_turns": 123,
      "token_budget": 123,
      "tool_call_budget": 123,
      "canvas_enabled": true,
      "visibility": "public",
      "category": "<string>",
      "tags": [
        "<string>"
      ],
      "status": "draft",
      "profile": "simple",
      "owner_id": "<string>",
      "orgSlug": "<string>",
      "subscription_id": "<string>",
      "serviceAccountId": "<string>",
      "published_config": {},
      "published_at": "2023-11-07T05:31:56Z",
      "has_draft_changes": true,
      "rating": 123,
      "ratings_count": 123,
      "messages_count": 123,
      "conversations_count": 123,
      "access_status": "granted",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Query Parameters

scope
string

Comma-separated list (own, shared, published, all).

Maximum string length: 64
action
enum<string>

Reserved action (explore for store-style discovery, write to filter to writable scope).

Available options:
explore,
write
Maximum string length: 32
status
string
Maximum string length: 32
category
string
Maximum string length: 128
Maximum string length: 200
sort
enum<string>
Available options:
updatedAt,
createdAt
Maximum string length: 32
limit
string

Page size (max 100, default 20).

page
string

1-indexed page number.

Response

Page of agents (with published_config stripped on list rows).

Page of agents (with published_config stripped on list rows).

items
object[]
total
integer
page
integer
limit
integer