EPepilot
File

getFileSummary

Changed on

Get summary text for a file entity together with the current summary job status when available.

get/v1/files/{id}/summary

Request

  • Base URL
    https://file.sls.epilot.io
  • URL
    https://file.sls.epilot.io/v1/files/{id}/summary
  • Auth
    • HTTP bearer
    • or API key in cookie token

Path parameters

string required

Empty string (used when file ID not yet assigned)

OR
string uuid required

Valid UUID v4

The UUID of the file entity

Response

Current file summary state

status'queued' | 'waiting_for_extraction' | 'processing' | 'completed' | 'failed' | 'unsupported' | 'stale'

Current state of a file summary job.

job_idstring uuid

Current summary job ID when available.

feedback_availableboolean

Whether the current summary can receive user feedback.

preview_summary_destring nullable

Compact German summary for hover and list preview surfaces.

short_summary_destring nullable

Short German paragraph summary for file preview surfaces.

preview_summary_enstring nullable

Compact English summary for hover and list preview surfaces.

short_summary_enstring nullable

Short English paragraph summary for file preview surfaces.

Changes