List Tools
List all available agent tools.
Use this endpoint to discover available tools before creating a session.
Tool Categories:
- search: Tools for searching data (execute_retriever)
- read: Tools for reading resources (list_, get_)
- create: Tools for creating resources (create_*) - requires confirmation
- update: Tools for updating resources (update_*) - requires confirmation
- delete: Tools for deleting resources (delete_*) - requires confirmation
- upload: Tools for file uploads (upload_object)
Note: Write operations (create, update, delete) require user confirmation via the /confirmations endpoint before execution.
Args: request: FastAPI request with tenant context category: Optional filter by tool category
Returns: ListToolsResponse with available tools
Example:
# List all tools
curl -X GET http://localhost:8000/v1/agents/tools \
-H "Authorization: Bearer {api_key}" \
-H "X-Namespace: {namespace_id}"
# List only search tools
curl -X GET "http://localhost:8000/v1/agents/tools?category=search" \
-H "Authorization: Bearer {api_key}" \
-H "X-Namespace: {namespace_id}"
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer YOUR_API_KEY"
"Bearer YOUR_STRIPE_API_KEY"
REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'
"ns_abc123def456"
"production"
"my-namespace"
Query Parameters
Filter by tool category
Response
Successful Response
Response for listing available agent tools.
Use this endpoint to discover available tools before creating a session. Pass tool names to available_tools in AgentConfig when creating a session.
Attributes: results: List of available tools with descriptions total: Total number of tools available categories: Unique tool categories
Example:
python response = ListToolsResponse( results=[ ToolInfo(name="smart_search", description="...", category="search"), ToolInfo(name="list_collections", description="...", category="read"), ], total=25, categories=["search", "read", "create"] )