v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Files

Create file

Create a new file.

post/v1/files

Response

idstring required

File ID.

namestring required

File name.

type'pdf' | 'doc' | 'docx' | 'xls' | 'xlsx' | 'ppt' | 'pptx' | 'txt' | 'csv' | 'jpeg' | 'png' | 'gif' | 'svg' | 'json' | 'xml' required

File type based on the MIME type.

Supported file types:

pdf: PDF documents
doc: Microsoft Word documents (legacy)
docx: Microsoft Word documents
xls: Microsoft Excel spreadsheets (legacy)
xlsx: Microsoft Excel spreadsheets
ppt: Microsoft PowerPoint presentations (legacy)
pptx: Microsoft PowerPoint presentations
txt: Plain text files
csv: Comma-separated values files
jpeg: JPEG images
png: PNG images
gif: GIF images
svg: SVG vector images
json: JSON data files
xml: XML data files

mimetypestring required

MIME type of the file.

customer_idstring nullable required

ID of the customer linked to the file.

summarystring nullable required

AI-generated summary of the file content

created_atstring date-time required

Date when the file was created.

Example response

{
  "id": "fil_2QdJDDUej969ev",
  "name": "invoice_2024.pdf",
  "type": "pdf",
  "mimetype": "application/pdf",
  "customer_id": "cus_QalW2vTAdkR6IY",
  "created_at": "2024-11-12T07:38:39.222Z"
}