Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions build/tools/api/filesystem-volumes.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Info>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.</Info>

## 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 <project_id>:<api_key>'
```

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=<conversation_id>' \
--request GET \
--header 'Authorization: Bearer <project_id>:<api_key>'
```

### 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"
}
}
]
}
```
7 changes: 7 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
]
},
Expand Down
Loading