Beta
Files

Get File

Changed on

Get file metadata by ID.

get/api/v1/beta/files/{file_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

file_idstring uuid required

Query parameters

expandstring[] nullable

Fields to expand.

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique file identifier

namestring required

File name including extension

external_file_idstring nullable

Optional ID for correlating with an external system

file_typestring nullable

File extension (pdf, docx, png, etc.)

project_idstring uuid required

Project this file belongs to

last_modified_atstring date-time nullable

When the file was last modified (ISO 8601)

expires_atstring date-time nullable

When the file expires and may be automatically removed. Null means no expiration.

purposestring nullable

How the file will be used: user_data, parse, extract, classify, split, sheet, or agent_app

Example response

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "external_file_id": "ext-12345",
  "file_type": "pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "purpose": "parse"
}

Changes

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 34da5826db1cRevision changes
    • info

      added the new optional query request parameter expand

    • info

      added the optional property to the response with the status