File

generateFileSummary

Compatibility alias for creating or returning the current AI summary job for a file entity.

post/v1/files/{id}/summary:generate

Request

  • Base URL
    https://file.sls.epilot.io
  • URL
    https://file.sls.epilot.io/v1/files/{id}/summary:generate
  • 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

Summary generation accepted

job_idstring uuid required

File summary job ID.

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

Current state of a file summary job.

errorstring

Human-readable failure or unsupported reason when available.

created_atstring date-time required
updated_atstring date-time required
completed_atstring date-time

Changes

No recorded changes to this operation across all 10 revisions of this API.