Skip to main content

FileRead

A stored file (voice, image, or document) in object storage, optionally linked to a lead. May carry a derived LLM-facing variant (e.g. a transcript or extracted text).

idIdrequired

Unique numeric identifier of the record.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

lead_id objectrequired

ID of the lead this record relates to.

anyOf
integer
original_filenameOriginal Filenamerequired

The file's original name.

s3_keyS3 Keyrequired

Object-storage key of the original file.

file_typeFileTyperequired

Kind of file — voice, image, or document.

Possible values: [voice, image, document]

mime_typeMime Typerequired

MIME type of the original file.

file_sizeFile Sizerequired

Size of the original file in bytes.

llm_s3_key object

Object-storage key of the derived LLM-facing artifact, if any.

anyOf
string
llm_mime_type object

MIME type of the derived LLM-facing artifact, if any.

anyOf
string
llm_filename object

Filename of the derived LLM-facing artifact, if any.

anyOf
string
original_lostOriginal Lost

Whether the original file is no longer available.

Default value: false
meta_json objectrequired

Free-form metadata about the file.

property name*any

Free-form metadata about the file.

llm_description objectrequired

Model-generated description of the file (e.g. for images).

anyOf
string
voice_transcript objectrequired

Transcript text for voice files.

anyOf
string
origin_sideSide

Possible values: [bot, user]

Default value: bot
agent_sendableAgent Sendable
Default value: false
send_once_per_dialogueSend Once Per Dialogue
Default value: false
created_atdate-timerequired

Creation time (UTC, ISO 8601).

presigned_url object
anyOf
string
FileRead
{
  "id": 0,
  "product_id": 0,
  "lead_id": 0,
  "original_filename": "string",
  "s3_key": "string",
  "file_type": "voice",
  "mime_type": "string",
  "file_size": 0,
  "llm_s3_key": "string",
  "llm_mime_type": "string",
  "llm_filename": "string",
  "original_lost": false,
  "meta_json": {},
  "llm_description": "string",
  "voice_transcript": "string",
  "origin_side": "bot",
  "agent_sendable": false,
  "send_once_per_dialogue": false,
  "created_at": "2024-07-29T15:51:28.071Z",
  "presigned_url": "string"
}