Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Large Language Models (LLMs)
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
Legal notices
Tools
Fetch Tools
GET
/
tools
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/tools \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"permission": "read_only",
"input_schema": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
},
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"required": [
"<string>"
]
},
"binding": {
"openapi": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>"
},
"python": {
"function": "<string>",
"requirements": [
"<string>"
],
"connections": {}
},
"wxflows": {
"endpoint": "<string>",
"flow_name": "<string>",
"security": []
},
"skill": {
"skillset_id": "<string>",
"skill_id": "<string>",
"skill_operation_path": "<string>",
"http_method": "GET"
},
"client_side": {},
"rag": {
"vector_id": "<string>"
},
"conversational_search": {
"conversational_search_config": {},
"connections": [
"<any>"
],
"version": "0.0.1"
},
"mcp": {
"server_url": "<string>",
"source": "public-registry",
"env": {},
"command": "<string>",
"args": [
"<string>"
],
"connections": {}
}
},
"display_name": "<string>",
"uid": "<string>",
"collab_idf": "<string>",
"environment_id": "<string>",
"toolkit_id": "<string>"
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
Successful Response
The response is of type ToolOut · object[]
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/tools \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"permission": "read_only",
"input_schema": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
},
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"required": [
"<string>"
]
},
"binding": {
"openapi": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>"
},
"python": {
"function": "<string>",
"requirements": [
"<string>"
],
"connections": {}
},
"wxflows": {
"endpoint": "<string>",
"flow_name": "<string>",
"security": []
},
"skill": {
"skillset_id": "<string>",
"skill_id": "<string>",
"skill_operation_path": "<string>",
"http_method": "GET"
},
"client_side": {},
"rag": {
"vector_id": "<string>"
},
"conversational_search": {
"conversational_search_config": {},
"connections": [
"<any>"
],
"version": "0.0.1"
},
"mcp": {
"server_url": "<string>",
"source": "public-registry",
"env": {},
"command": "<string>",
"args": [
"<string>"
],
"connections": {}
}
},
"display_name": "<string>",
"uid": "<string>",
"collab_idf": "<string>",
"environment_id": "<string>",
"toolkit_id": "<string>"
}
]
Assistant
Responses are generated using AI and may contain mistakes.