Get a single tool from an agent - Prisme.ai

Get a single tool from an agent

curl --request GET \
  --url https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

GET

/

v1

/

agents

/

{agentId}

/

tools

/

{toolId}

Get a single tool from an agent

curl --request GET \
  --url https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/tools/{toolId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

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).

Path Parameters

agentId

string

required

Maximum string length: 64

toolId

string

required

Maximum string length: 128

Response

Tool record.

Tool entry attached to an agent. Discriminated by type - file_search (requires vector_store_id), mcp (uses server, headers, scope), or function (uses url, parameters, headers).

id

string

type

enum<string>

Available options:

file_search,

mcp,

function

name

string

Pattern: ^[a-zA-Z0-9_-]+$

display_name

string

description

string

catalog_id

string

auth

object

icon_url

string

vector_store_id

string

Required for file_search.

server

string

MCP server URL (for mcp).

headers

object

scope

string

url

string

Required for function.

parameters

object

JSON Schema describing the function tool's parameters.