API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

File

Files are used to upload documents via presigned URLs. After uploading and completing a file, link it to resources through their own APIs (e.g. attach a transcript to a meeting). See File uploads for the full upload flow and supported purposes. For meeting transcript attachments, see Uploading meeting transcripts. Not every retrievable file is listable: files uploaded through the app and synced chat attachments are fetchable by id (GET /v1/files/{id}, GET /v1/files/{id}/url, or a CRM record’s $files relationship) but never appear in GET /v1/files.

Create a file upload session

POST/v1/files

Complete a file upload

POST/v1/files/{id}/complete

Retrieve a file

GET/v1/files/{id}

List files

GET/v1/files

Get a file download URL

GET/v1/files/{id}/url

Cancel a file upload

POST/v1/files/{id}/cancel

ModelsExpand Collapse

FileCancelResponse object { id, completedAt, createdAt, 5 more }

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

FileCompleteResponse object { id, completedAt, createdAt, 5 more }

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

FileCreateResponse object { id, completedAt, createdAt, 7 more }

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

uploadHeaders: map[string]

Headers to include in the upload request.

uploadUrl: string

Upload URL. Upload the file bytes directly to this URL.

FileListResponse object { data, object, totalCount }

data: array of object { id, completedAt, createdAt, 5 more }

Array of file objects for the current page.

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

object: string

The object type, always "list".

totalCount: number

Total number of matching files.

minimum0

maximum9007199254740991

FileRetrieveResponse object { id, completedAt, createdAt, 5 more }

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

FileURLResponse object { expiresAt, url }

expiresAt: string

When the download URL expires.

url: string

Temporary download URL for the file.