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

​
Base URL

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

​
Authentication

All endpoints require authentication. See Authentication for details.

​
List Vault Entries

List all vault entries in your tenant.

​
Endpoint

GET /services/vault

​
Response

​
entries
array
required
Array of vault entry objects
​
total
integer
required
Total number of entries
​
limit
integer|string
required
Tier limit (-1 for unlimited)
​
used
integer
required
Number of entries used

​
Get Vault Entry

Get a specific vault entry by ID.

​
Endpoint

GET /services/vault/:id

​
Path Parameters

​
id
string
required
Vault entry ID

​
Create Vault Entry

Create a new vault entry.

​
Endpoint

POST /services/vault

​
Request Body

​
name
string
required
Unique name for the credential
​
type
string
required
Credential type: API_KEY, BEARER_TOKEN, BASIC_AUTH, OAUTH2_CLIENT, OAUTH2_AUTH_CODE
​
value
object
required
Credential value (structure depends on type)
​
description
string
Optional description

​
Request Example

curl -X POST 'https://hypha-api.plinqx.app/services/vault' \
  -H 'Authorization: Bearer YOUR_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "MY_API_KEY",
    "type": "API_KEY",
    "value": {
      "key": "your-api-key-value"
    },
    "description": "API key for external service"
  }'

​
Update Vault Entry

Update an existing vault entry.

​
Endpoint

PATCH /services/vault/:id

​
Request Body

​
name
string
Updated name
​
value
object
Updated credential value
​
description
string
Updated description

​
Delete Vault Entry

Delete a vault entry.

​
Endpoint

DELETE /services/vault/:id
Deleting a vault entry fails if it’s still referenced by tools. Update tools first to remove references.

​
Get Vault Entry Usage

See which tools use a vault entry.

​
Endpoint

GET /services/vault/:id/usage

​
Response

​
tools
array
required
Array of tools using this vault entry

​
Test Vault Entry

Test vault entry credentials.

​
Endpoint

POST /services/vault/:id/test

​
Response

For OAuth2 Client Credentials:
​
success
boolean
required
Whether test succeeded
​
expiresIn
integer
Token expiration time in seconds
​
scope
string
OAuth scope
​
error
string
Error message if test failed

​
Error Responses

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

​
Next Steps

Collections API

Manage Collections via API

Webhooks API

Manage webhooks via API