Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
Represents a file uploaded to an organization for use in vector stores, file search, or AI conversations.

Attributes

id string

Unique identifier for the file (format: file_*).

name string

Original filename of the uploaded file.

organizationId string

ID of the organization that owns this file.

size integer

File size in bytes.

mimeType string

MIME type of the file (e.g., application/pdf, text/plain).

purpose string

Purpose of the file. Common values:

  • vector_store - For semantic search
  • user_upload - User-uploaded content
  • assistant - Assistant file attachment

status string

Processing status of the file:

  • uploading - Upload in progress
  • uploaded - Successfully uploaded
  • processing - Being processed for vector search
  • completed - Ready for use
  • failed - Processing failed
  • deleted - Marked for deletion

createdAt string (ISO 8601)

Timestamp when the file was uploaded.

createdBy string

User ID of the person who uploaded the file.


Example

{
  "id": "file_abc123",
  "name": "product_documentation.pdf",
  "organizationId": "org_abc123",
  "size": 2457600,
  "mimeType": "application/pdf",
  "purpose": "vector_store",
  "status": "completed",
  "createdAt": "2025-01-20T15:30:00Z",
  "createdBy": "uid_user123"
}