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>",
"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": {
"default": "auto",
"tools": [
{
"tool": "<string>",
"conditions": {},
"approvers": [
{
"id": "<string>"
}
]
}
]
},
"tool_activation": {
"default": "auto",
"tools": [
{
"tool": "<string>"
}
]
},
"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,
"category": "<string>",
"tags": [
"<string>"
],
"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,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"limit": 123
}List agents
List agents with multi-scope filter. Supported scopes (comma-separated):
own, shared, published, all. Default own. The reserved
action ?action=explore returns all public+restricted published
agents in the caller’s organization.
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>",
"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": {
"default": "auto",
"tools": [
{
"tool": "<string>",
"conditions": {},
"approvers": [
{
"id": "<string>"
}
]
}
]
},
"tool_activation": {
"default": "auto",
"tools": [
{
"tool": "<string>"
}
]
},
"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,
"category": "<string>",
"tags": [
"<string>"
],
"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,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"limit": 123
}Authorizations
User-bound credential carrying an identity: either a session JWT
or a user access token (at:*) generated from the user settings UI.
Send as Authorization: Bearer <token>.
Org API keys (iak_*) are not accepted here - they carry
no user identity. Use the x-prismeai-api-key header instead
(see OrgApiKeyAuth).
Query Parameters
Comma-separated list (own, shared, published, all).
64Reserved action (explore for store-style discovery, write to filter to writable scope).
explore, write 3232128200updatedAt, createdAt 32Page size (max 100, default 20).
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).
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
file_search, mcp, function ^[a-zA-Z0-9_-]+$Required for file_search.
MCP server URL (for mcp).
Required for function.
JSON Schema describing the function tool's parameters.
Human-in-the-Loop configuration. Sets a default policy plus optional per-tool overrides. Policies:
auto— run immediately (default).always_ask— halt every call on approval.ask_external— halt only on MCP tool calls.ask_first— halt the first time a tool runs in a session; cache keyed per child name unless an MCP parent rule is configured (then cached per parent).
Hide child attributes
Hide child attributes
auto, always_ask, ask_external, ask_first Hide child attributes
Hide child attributes
auto, always_ask, ask_external, ask_first Optional jsonmatch pattern compared against the tool call's
arguments. The rule's policy only fires when the pattern matches;
otherwise the call runs without prompting.
Controls whether the model can use a given tool on a given turn.
user_first tools are replaced by a same-named, schema-less stub with
a "disabled" description on each turn, unless the user explicitly
summons the tool from the chat input via metadata.tool_choice.
Eligible tool types: function and mcp. file_search, skill,
guardrail, and system types are exempt and always behave as auto.
Hide child attributes
Hide child attributes
public, private, restricted draft, published simple, workflow, agent_light, agent_full, orchestrator Snapshot of runtime fields at last publish (owners only).
Only present on restricted-agent rows in list/discovery views.
granted, none Was this page helpful?