Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

The Tools API provides endpoints for managing custom tools, imported tools, and tool configurations.

​
Base URL

https://hypha-api.plinqx.app/services/tools

​
Authentication

All endpoints require authentication. See Authentication for details.

​
List Tools

List all tools available in your tenant.

​
Endpoint

GET /services/tools

​
Query Parameters

​
source
string
Filter by source: custom, provider, imported, mcp
​
search
string
Search tools by name or description
​
limit
integer
Maximum results to return
​
offset
integer
Pagination offset

​
Store Exposure

Manage store exposure for tools.

​
List Tools with Store Exposure

GET /api/tools/store-exposure
Returns all tools with their store exposure configuration.

​
Bulk Update Store Exposure

PATCH /api/tools/store-exposure/bulk
Update store exposure for multiple tools at once.

​
Request Body

​
toolIds
array
required
Array of tool IDs (format: custom_{id}, connection_{id}, flow_{id})
​
storeId
string
required
Store ID: chatgpt, anthropic, or gemini
​
enabled
boolean
required
Whether to enable or disable exposure

​
Request Example

curl -X PATCH 'https://hypha-api.plinqx.app/api/tools/store-exposure/bulk' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "toolIds": ["custom_abc123", "connection_def456"],
    "storeId": "chatgpt",
    "enabled": true
  }'

​
Custom Tools

​
Create Custom Tool

POST /services/custom-tools

​
Update Custom Tool

PATCH /services/custom-tools/:id

​
Publish Custom Tool

POST /services/custom-tools/:id/publish

​
Test Custom Tool

POST /services/custom-tools/:id/test

​
Error Responses

Standard error format: 
{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

​
Next Steps

Collections API

Manage Collections via API

Vault API

Manage credentials via API