Get Custom Tool
curl --request GET \
--url https://cloud.onyx.app/api/tool/{tool_id} \
--header 'Authorization: Bearer <token>'{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}Actions
Get Custom Tool
GET
/
tool
/
{tool_id}
Get Custom Tool
curl --request GET \
--url https://cloud.onyx.app/api/tool/{tool_id} \
--header 'Authorization: Bearer <token>'{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}Documentation Index
Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Authorization header with Bearer token
Path Parameters
Response
Successful Response
Was this page helpful?
⌘I