File Edit

Get file edit job status

Returns the current status of the file edit job for this project.

get/projects/{project_id}/file-edit/status/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

project_idstring uuid required

Response

idstring uuid required

File edit job ID.

status'pending' | 'extracting_text' | 'editing' | 'completed' | 'failed' required
  • pending - pending
  • extracting_text - extracting_text
  • editing - editing
  • completed - completed
  • failed - failed
original_filenamestring required

Name of the uploaded file.

file_typestring nullable required

DocumentType string (PDF, Word Document, Excel, PPT) derived from the filename, matching the document table convention. null if the extension is not recognised.

instructionsstring required

User-provided editing instructions.

error_messagestring required

Error details if status is "failed".

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.