Sign in
File Systems

Create file system

Creates a file system. Storage is provisioned lazily on first use by an agent run or MCP client.

post/v2/file-systems

Request body

keystring required

The unique key of the file system. The key is unique and immutable and cannot be repeated within the same workspace.

pathstring required

Entity storage path. With workspace-level API keys, the first element identifies the project. With project-level API keys, the path is relative to that project.

display_namestring

Human readable name shown in the UI. Defaults to the key.

descriptionstring
external_access'disabled' | 'read_only' | 'read_write'

Whether external MCP clients may reach this file system. Defaults to disabled.

Response

File system successfully created.

idstring

The unique identifier of the file system

keystring required

The unique key of the file system. The key is unique and immutable and cannot be repeated within the same workspace.

display_namestring required

Human readable name shown in the UI

descriptionstring required

The description of the file system. Be as precise as possible to help the AI understand what the file system is for.

project_idstring required

Identifier of the project the file system belongs to

external_access'disabled' | 'read_only' | 'read_write' required
created_by_idstring nullable

The user ID of the creator

updated_by_idstring nullable

The user ID of the last updater

createdstring required

The creation date of the file system

updatedstring required

The last update date of the file system

used_bytesstring nullable

Apparent size of the file system in bytes at the last metering. Absent until first metered.

used_inodesstring nullable

Number of files and directories in the file system at the last metering. Absent until first metered.

last_metered_atstring nullable

When usage was last measured. Absent until first metered.

Changes

Changed in 11 of the 271 revisions of this API.56

Of the 271 revisions, 82 have no diff computed.