Volumes

List volumes in a workspace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

Query Parameters

environment_id?string|null

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "volumes": [
    {
      "volume_id": "string",
      "workspace_id": "string",
      "org_id": "string",
      "environment_id": "string",
      "name": "string",
      "description": "string",
      "embedding_model_id": "string",
      "extraction_model_id": "string",
      "indexing_mode": "auto",
      "chunking_strategy": "recursive",
      "status": "active",
      "tags": [
        "string"
      ],
      "reindex_status": "string",
      "reindex_started_at": "string",
      "reindex_completed_at": "string",
      "reindex_progress": {},
      "reindex_error": "string",
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create a new volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

Length1 <= length <= 100

environment_id*Environment Id

description?|null

embedding_model_id?string|null

extraction_model_id?string|null

indexing_mode?IndexingMode

Default"auto"

Value in"auto" | "manual" | "off"

chunking_strategy?Chunking Strategy

Default"recursive"

tags?array<string>

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "environment_id": "string"  }'

{
  "message": "Volume created successfully",
  "volume": {
    "volume_id": "string",
    "workspace_id": "string",
    "org_id": "string",
    "environment_id": "string",
    "name": "string",
    "description": "string",
    "embedding_model_id": "string",
    "extraction_model_id": "string",
    "indexing_mode": "auto",
    "chunking_strategy": "recursive",
    "status": "active",
    "tags": [
      "string"
    ],
    "reindex_status": "string",
    "reindex_started_at": "string",
    "reindex_completed_at": "string",
    "reindex_progress": {},
    "reindex_error": "string",
    "created_by": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get a volume by ID

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string"

{
  "volume_id": "string",
  "workspace_id": "string",
  "org_id": "string",
  "environment_id": "string",
  "name": "string",
  "description": "string",
  "embedding_model_id": "string",
  "extraction_model_id": "string",
  "indexing_mode": "auto",
  "chunking_strategy": "recursive",
  "status": "active",
  "tags": [
    "string"
  ],
  "reindex_status": "string",
  "reindex_started_at": "string",
  "reindex_completed_at": "string",
  "reindex_progress": {},
  "reindex_error": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|null

indexing_mode?|null

chunking_strategy?string|null

embedding_model_id?string|null

extraction_model_id?string|null

tags?array<string>|null

status?string|null

Response Body

`application/json`

curl -X PATCH "https://loading/v1/orgs/string/workspaces/string/volumes/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "message": "Volume updated successfully",
  "volume": {
    "volume_id": "string",
    "workspace_id": "string",
    "org_id": "string",
    "environment_id": "string",
    "name": "string",
    "description": "string",
    "embedding_model_id": "string",
    "extraction_model_id": "string",
    "indexing_mode": "auto",
    "chunking_strategy": "recursive",
    "status": "active",
    "tags": [
      "string"
    ],
    "reindex_status": "string",
    "reindex_started_at": "string",
    "reindex_completed_at": "string",
    "reindex_progress": {},
    "reindex_error": "string",
    "created_by": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/volumes/string"

{
  "message": "Volume deleted successfully"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List mounts for a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string/mounts"

{
  "mounts": [
    {
      "mount_id": "string",
      "volume_id": "string",
      "app_id": "string",
      "path_pattern": "string",
      "access_level": "string",
      "granted_by": "string",
      "created_at": "string"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create a volume mount for an app

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

app_id*App Id

path_pattern?Path Pattern

Default"/*"

access_level?MountAccessLevel

Default"read"

Value in"read" | "write" | "read_write" | "append_only"

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/string/mounts" \  -H "Content-Type: application/json" \  -d '{    "app_id": "string"  }'

{
  "message": "Mount created successfully",
  "mount": {
    "mount_id": "string",
    "volume_id": "string",
    "app_id": "string",
    "path_pattern": "string",
    "access_level": "string",
    "granted_by": "string",
    "created_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete a volume mount

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

mount_id*Mount Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/volumes/string/mounts/string"

{
  "message": "Mount removed successfully"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Read an entry from a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

path*Path

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string/entries/string"

{
  "entry_id": "string",
  "volume_id": "string",
  "path": "string",
  "content_type": "string",
  "content": {},
  "content_text": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "schema_id": "string",
  "is_indexed": false,
  "indexed_at": "string",
  "total_chunks": 0,
  "ttl_seconds": 0,
  "written_by_app_id": "string",
  "written_by_execution_id": "string",
  "tags": [
    "string"
  ],
  "metadata": {},
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete an entry from a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

path*Path

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/volumes/string/entries/string"

{
  "message": "Entry deleted successfully"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Write an entry to a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

path*Path

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content?|

Structured content (JSON)

content_text?|

Text content for direct text entries

schema_id?string|null

ttl_seconds?|

Auto-expiry in seconds

tags?array<string>

metadata?

Response Body

`application/json`

curl -X PUT "https://loading/v1/orgs/string/workspaces/string/volumes/string/entries/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "message": "Entry written successfully",
  "entry": {
    "entry_id": "string",
    "volume_id": "string",
    "path": "string",
    "content_type": "string",
    "content": {},
    "content_text": "string",
    "mime_type": "string",
    "size_bytes": 0,
    "schema_id": "string",
    "is_indexed": false,
    "indexed_at": "string",
    "total_chunks": 0,
    "ttl_seconds": 0,
    "written_by_app_id": "string",
    "written_by_execution_id": "string",
    "tags": [
      "string"
    ],
    "metadata": {},
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List entries in a volume (directory-like)

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Query Parameters

prefix?Prefix

Path prefix to list

Default"/"

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string/list"

{
  "path": "string",
  "directories": [
    "string"
  ],
  "entries": [
    {
      "entry_id": "string",
      "volume_id": "string",
      "path": "string",
      "content_type": "string",
      "content": {},
      "content_text": "string",
      "mime_type": "string",
      "size_bytes": 0,
      "schema_id": "string",
      "is_indexed": false,
      "indexed_at": "string",
      "total_chunks": 0,
      "ttl_seconds": 0,
      "written_by_app_id": "string",
      "written_by_execution_id": "string",
      "tags": [
        "string"
      ],
      "metadata": {},
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Upload a file entry to a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

path*Path

Header Parameters

authorization?string|null

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*File

tags?|

JSON-encoded list of tags

metadata?|

JSON-encoded metadata object

ttl_seconds?|

Auto-expiry in seconds

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/string/entries/string/upload" \  -F file="string"

{
  "message": "Entry written successfully",
  "entry": {
    "entry_id": "string",
    "volume_id": "string",
    "path": "string",
    "content_type": "string",
    "content": {},
    "content_text": "string",
    "mime_type": "string",
    "size_bytes": 0,
    "schema_id": "string",
    "is_indexed": false,
    "indexed_at": "string",
    "total_chunks": 0,
    "ttl_seconds": 0,
    "written_by_app_id": "string",
    "written_by_execution_id": "string",
    "tags": [
      "string"
    ],
    "metadata": {},
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get a presigned download URL for a file entry

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

path*Path

Query Parameters

expires_in?Expires In

URL expiry in seconds

Default3600

Range60 <= value <= 604800

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string/entries/string/download"

{
  "entry_id": "string",
  "path": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "download_url": "string",
  "expires_in": 3600
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Semantic search within a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query*Query

Length1 <= length

path_prefix?|

Restrict search to path prefix

top_k?Top K

Default10

Range1 <= value <= 100

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/string/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{
  "results": [
    {
      "entry_id": "string",
      "volume_id": "string",
      "volume_name": "string",
      "path": "string",
      "score": 0,
      "content_preview": "string",
      "chunk_index": 0
    }
  ],
  "query": "string",
  "total": 0
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Search across all volumes an app has access to

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

Query Parameters

app_id*App Id

App ID to search volumes for

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query*Query

Length1 <= length

path_prefix?|

Restrict search to path prefix

top_k?Top K

Default10

Range1 <= value <= 100

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/search-all?app_id=string" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{
  "results": [
    {
      "entry_id": "string",
      "volume_id": "string",
      "volume_name": "string",
      "path": "string",
      "score": 0,
      "content_preview": "string",
      "chunk_index": 0
    }
  ],
  "query": "string",
  "total": 0
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List active locks on a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/volumes/string/locks"

{
  "locks": [
    {
      "lock_id": "string",
      "volume_id": "string",
      "partition": "string",
      "lock_type": "string",
      "holder_app_id": "string",
      "holder_execution_id": "string",
      "acquired_at": "string",
      "expires_at": "string"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Acquire a partition lock on a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

partition*Partition

Path prefix to lock

lock_type?VolumeLockType

Default"write"

Value in"read" | "write" | "exclusive"

app_id*App Id

execution_id?string|null

timeout_seconds?Timeout Seconds

Default300

Range10 <= value <= 3600

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/string/locks" \  -H "Content-Type: application/json" \  -d '{    "partition": "string",    "app_id": "string"  }'

{
  "message": "Lock acquired successfully",
  "lock": {
    "lock_id": "string",
    "volume_id": "string",
    "partition": "string",
    "lock_type": "string",
    "holder_app_id": "string",
    "holder_execution_id": "string",
    "acquired_at": "string",
    "expires_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Release a partition lock

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

partition*Partition

Query Parameters

lock_id*Lock Id

Lock ID to release

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/volumes/string/locks/string?lock_id=string"

{
  "message": "Lock released successfully"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Trigger a full reindex of a volume

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

volume_id*Volume Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

new_embedding_model_id?string|null

confirm?Confirm

Defaultfalse

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/volumes/string/reindex" \  -H "Content-Type: application/json" \  -d '{}'

null

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`