v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Create a file upload session

Creates a new file upload session and returns an upload URL.

After uploading the file bytes to uploadUrl, call POST /v1/files/{id}/complete to finalize the upload. Optionally pass purpose to validate MIME type and size constraints at creation time. See <u>File uploads</u> for the full upload flow, supported purposes, and size limits. If you are uploading a meeting transcript, see <u>Uploading meeting transcripts</u> for the follow-up meeting attachment flow.

Required scope: files:create

Rate limit category: Write

post/v1/files

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Request body

purpose'meeting_transcript' | 'knowledge_user' | 'knowledge_workspace' | 'email_attachment'

Optional validation hint. When provided, the server enforces purpose-specific MIME type and file size constraints. Use meeting_transcript for files that will be attached to a meeting as its transcript. Use knowledge_user or knowledge_workspace to add the file to the authenticated user's or workspace's Knowledge, making it available to the AI assistant. Not persisted or returned in responses.

filenamestring required

Original filename.

mimeTypestring required

MIME type of the file. Must be allowed for the given purpose (if specified).

sizeBytesinteger required

Expected file size in bytes. Maximum 512 MB.

Response

idstring required

Unique identifier for the file.

status'PENDING' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' required

Current upload status of the file.

filenamestring required

Original filename.

mimeTypestring required

MIME type of the file.

sizeBytesinteger required

File size in bytes.

createdAtstring required

When the file upload session was created.

completedAtstring nullable required

When the file upload was completed.

expiresAtstring nullable required

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

uploadUrlstring required

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

uploadHeadersobject required

Headers to include in the upload request.