Skip to Content
kosemdocs
ReferenceAPITools

Get tool

Gets a tool.

GET
/v1/tools/{tool}

Gets a tool.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

tool*string

The tool's ID, such as web_search.

Match^[a-z][a-z0-9_]{0,62}$

Response Body

OK

application/json
  1. response
description*string

What the tool does.

displayName*string

Name shown in user interfaces.

inputSchema*string

A JSON Schema for its calls' input, as JSON text, for software that answers a client tool's calls.

kind*string

Who carries out its calls: SERVER, kosem, while the agent waits; CLIENT, a person, or software watching the agent, which the agent waits for the answer of, sent as an answer event.

Value in"SERVER""CLIENT"
name*string

Resource name, such as tools/web_search. The last part is the tool's ID, which agents' configs and settings name it by, and the name the model calls it by.

Example Request
curl -X GET 'https://api.kosem.ai/v1/tools/string'
Example Response
{
  "description": "string",
  "displayName": "string",
  "inputSchema": "string",
  "kind": "SERVER",
  "name": "string"
}