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

client.File.New(ctx, body) (*FileCreateResponse, error)

POST/v1/files

Complete a file upload

client.File.Complete(ctx, id, body) (*FileCompleteResponse, error)

POST/v1/files/{id}/complete

Retrieve a file

client.File.Get(ctx, id) (*FileRetrieveResponse, error)

GET/v1/files/{id}

List files

client.File.List(ctx, query) (*FileListResponse, error)

GET/v1/files

Get a file download URL

client.File.URL(ctx, id) (*FileURLResponse, error)

GET/v1/files/{id}/url

Cancel a file upload

client.File.Cancel(ctx, id, body) (*FileCancelResponse, error)

POST/v1/files/{id}/cancel

ModelsExpand Collapse

type FileCancelResponse struct{…}

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status FileCancelResponseStatus

Current upload status of the file.

One of the following:

const FileCancelResponseStatusPending FileCancelResponseStatus = "PENDING"

const FileCancelResponseStatusCompleted FileCancelResponseStatus = "COMPLETED"

const FileCancelResponseStatusCancelled FileCancelResponseStatus = "CANCELLED"

const FileCancelResponseStatusExpired FileCancelResponseStatus = "EXPIRED"

type FileCompleteResponse struct{…}

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status FileCompleteResponseStatus

Current upload status of the file.

One of the following:

const FileCompleteResponseStatusPending FileCompleteResponseStatus = "PENDING"

const FileCompleteResponseStatusCompleted FileCompleteResponseStatus = "COMPLETED"

const FileCompleteResponseStatusCancelled FileCompleteResponseStatus = "CANCELLED"

const FileCompleteResponseStatusExpired FileCompleteResponseStatus = "EXPIRED"

type FileCreateResponse struct{…}

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status FileCreateResponseStatus

Current upload status of the file.

One of the following:

const FileCreateResponseStatusPending FileCreateResponseStatus = "PENDING"

const FileCreateResponseStatusCompleted FileCreateResponseStatus = "COMPLETED"

const FileCreateResponseStatusCancelled FileCreateResponseStatus = "CANCELLED"

const FileCreateResponseStatusExpired FileCreateResponseStatus = "EXPIRED"

UploadHeaders map[string, string]

Headers to include in the upload request.

UploadURL string

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

type FileListResponse struct{…}

Data []FileListResponseData

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status string

Current upload status of the file.

One of the following:

const FileListResponseDataStatusPending FileListResponseDataStatus = "PENDING"

const FileListResponseDataStatusCompleted FileListResponseDataStatus = "COMPLETED"

const FileListResponseDataStatusCancelled FileListResponseDataStatus = "CANCELLED"

const FileListResponseDataStatusExpired FileListResponseDataStatus = "EXPIRED"

Object string

The object type, always "list".

TotalCount int64

Total number of matching files.

minimum0

maximum9007199254740991

type FileRetrieveResponse struct{…}

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status FileRetrieveResponseStatus

Current upload status of the file.

One of the following:

const FileRetrieveResponseStatusPending FileRetrieveResponseStatus = "PENDING"

const FileRetrieveResponseStatusCompleted FileRetrieveResponseStatus = "COMPLETED"

const FileRetrieveResponseStatusCancelled FileRetrieveResponseStatus = "CANCELLED"

const FileRetrieveResponseStatusExpired FileRetrieveResponseStatus = "EXPIRED"

type FileURLResponse struct{…}

ExpiresAt string

When the download URL expires.

URL string

Temporary download URL for the file.