From 3df0dfa7d375ccbed32d7072c44755a8ca770134 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Wed, 25 Mar 2026 04:21:50 +0000 Subject: [PATCH] docs(TSP-1097): add filesystem volumes API endpoint documentation Co-Authored-By: Claude Sonnet 4.6 --- build/tools/api/filesystem-volumes.mdx | 78 ++++++++++++++++++++++++++ docs.json | 7 +++ 2 files changed, 85 insertions(+) create mode 100644 build/tools/api/filesystem-volumes.mdx diff --git a/build/tools/api/filesystem-volumes.mdx b/build/tools/api/filesystem-volumes.mdx new file mode 100644 index 00000000..19933944 --- /dev/null +++ b/build/tools/api/filesystem-volumes.mdx @@ -0,0 +1,78 @@ +--- +title: 'Filesystem volumes API' +sidebarTitle: 'Filesystem volumes' +description: 'Discover accessible filesystem volumes using the API' +--- + +The filesystem volumes API lets you discover which filesystem volumes are accessible in your Relevance AI environment. This is useful when building tools that read from or write to specific storage locations. + +All API examples on this page use the AU endpoint. Replace the subdomain with `api-d7b62b` (EU) or `api-bcbe5a` (US) if your organization is hosted in a different region. + +## Region-specific endpoints + +| Region | Base URL | +|--------|----------| +| AU | `https://api-f1db6c.stack.tryrelevance.com/latest` | +| EU | `https://api-d7b62b.stack.tryrelevance.com/latest` | +| US | `https://api-bcbe5a.stack.tryrelevance.com/latest` | + +## GET /fs/volumes + +Returns a list of accessible filesystem volumes with their metadata. + +### Parameters + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| `conversation_id` | string | No | Filter volumes by conversation context | + +### Example request + +```bash +curl 'https://api-f1db6c.stack.tryrelevance.com/latest/fs/volumes' \ + --request GET \ + --header 'Authorization: Bearer :' +``` + +To filter by conversation context, pass `conversation_id` as a query parameter: + +```bash +curl 'https://api-f1db6c.stack.tryrelevance.com/latest/fs/volumes?conversation_id=' \ + --request GET \ + --header 'Authorization: Bearer :' +``` + +### Response + +The response is a list of volume objects. Each object includes: + +| Field | Type | Description | +|-------|------|-------------| +| `key` | string | Unique identifier for the volume | +| `label` | string | Human-readable name for the volume | +| `file_types` | object | Information about the file types supported or present in the volume | + +#### Example response + +```json +{ + "results": [ + { + "key": "volume-abc123", + "label": "Conversation files", + "file_types": { + "allowed": ["pdf", "txt", "csv"], + "default": "txt" + } + }, + { + "key": "volume-def456", + "label": "Shared workspace", + "file_types": { + "allowed": ["pdf", "docx", "xlsx"], + "default": "pdf" + } + } + ] +} +``` diff --git a/docs.json b/docs.json index d19ecda9..17d21d00 100644 --- a/docs.json +++ b/docs.json @@ -326,6 +326,13 @@ "build/tools/tool-steps/file-to-text", "build/tools/tool-steps/convert-audio-video-to-text" ] + }, + { + "group": "API", + "pages": [ + "build/tools/api/long-running-tools", + "build/tools/api/filesystem-volumes" + ] } ] },