API Reference

Beta

Directories

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Upload File To Directory

FileUploadResponse Beta.Directories.Files.Upload(FileUploadParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/beta/directories/{directory_id}/files/upload

Upload a file and create its directory entry in one call; unique_id / display_name default to values derived from file metadata.

ParametersExpand Collapse

FileUploadParams parameters

required string directoryID

Path param

required string uploadFile

Body param

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

string? displayName

Body param

string? externalFileID

Body param

string? metadata

Body param: User metadata as a JSON object string.

string? uniqueID

Body param

ReturnsExpand Collapse

class FileUploadResponse:

API response schema for a directory file.

required string ID

Unique identifier for the directory file.

required string DirectoryID

Directory the file belongs to.

required string DisplayName

Display name for the file.

minLength1

required string ProjectID

Project the directory file belongs to.

required string UniqueID

Unique identifier for the file in the directory

minLength1

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

DateTimeOffset? DeletedAt

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

PresignedUrl? DownloadUrl

Schema for a presigned URL.

required DateTimeOffset ExpiresAt

The time at which the presigned URL expires

formatdate-time

required string Url

A presigned URL for IO operations against a private file

formaturi

minLength1

IReadOnlyDictionary<string, string>? FormFields

Form fields for a presigned POST request

string? FileID

File ID for the storage location.

IReadOnlyDictionary<string, Metadata> Metadata

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

string

Long

Double

Boolean

JsonElement

IReadOnlyList<string>

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Upload File To Directory

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

FileUploadParams parameters = new()
{
    DirectoryID = "directory_id",
    UploadFile = Encoding.UTF8.GetBytes("Example data"),
};

var response = await client.Beta.Directories.Files.Upload(parameters);

Console.WriteLine(response);

200 example

{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}