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 Collections API lets you create, read, update, and delete Collections programmatically.

​
Base URL

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

​
Authentication

All endpoints require authentication. See Authentication for details.

​
List Collections

List all Collections in your tenant.

​
Endpoint

GET /services/collections

​
Response

​
data
array
required
Array of Collection objects

​
Collection Object

​
id
string
required
Collection identifier
​
name
string
required
Collection name
​
description
string
Collection description
​
tools
array
Array of tools in the collection

​
Get Collection

Get a specific Collection by ID.

​
Endpoint

GET /services/collections/:id

​
Path Parameters

​
id
string
required
Collection ID

​
Create Collection

Create a new Collection.

​
Endpoint

POST /services/collections

​
Request Body

​
name
string
required
Collection name
​
description
string
Optional description

​
Request Example

curl -X POST 'https://hypha-api.plinqx.app/services/collections' \
  -H 'Authorization: Bearer YOUR_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Collection",
    "description": "Collection for production tools"
  }'

​
Update Collection

Update an existing Collection.

​
Endpoint

PUT /services/collections/:id

​
Request Body

​
name
string
Updated name
​
description
string
Updated description

​
Delete Collection

Delete a Collection.

​
Endpoint

DELETE /services/collections/:id
Deleting a Collection removes all tool configurations within it. This action cannot be undone.

​
Add Tools to Collection

Add tools to a Collection.

​
Endpoint

POST /services/collections/:id/tools

​
Request Body

​
toolIds
array
required
Array of tool IDs to add

​
Remove Tool from Collection

Remove a tool from a Collection.

​
Endpoint

DELETE /services/collections/:id/tools/:toolId

​
Update Tool in Collection

Update tool configuration within a Collection.

​
Endpoint

PUT /services/collections/:id/tools/:toolId

​
Request Body

​
alias
string
Tool alias
​
enabled
boolean
Whether tool is enabled
​
credentialPolicy
string
Credential policy: SYSTEM, USER_REQUIRED, or USER_PREFERRED
​
systemCredentialId
string
System credential vault entry ID
​
policy
object
Tool policy (rate limits, field masking, quotas)

​
Error Responses

All endpoints return standard error format: 
{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}
}

​
Next Steps

Tools API

Manage tools via API

Vault API

Manage credentials via API