Get file edit job status

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

On this page

HTTP request 

GET https://api.parsewise.ai/api/v1/projects/{project_id}/file-edit/status/

URI Parameters

Name In Required Type Description
project_id path Yes string (uuid)  

Request Header

Name Required Type Description
X-API-Key Yes string API key with the pw_live_ prefix. See Authentication.

Responses

Status Type Description
200 V1FileEditStatusResponse —

Security

  • ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example 

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

project_id = "<uuid>"

resp = requests.get(
    f"{BASE_URL}/projects/{project_id}/file-edit/status/",
    headers={"X-API-Key": API_KEY},
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

V1FileEditStatusResponse

Name Required Type Description
id Yes string (uuid) File edit job ID.
status Yes V1FileEditStatusResponseStatusEnum Current status of the file edit job.
original_filename Yes string Name of the uploaded file.
file_type Yes string (nullable) DocumentType string (PDF, Word Document, Excel, PPT) derived from the filename, matching the document table convention. null if the extension is not recognised.
instructions Yes string User-provided editing instructions.
error_message Yes string Error details if status is “failed”.
created_at Yes string (date-time)  
updated_at Yes string (date-time)  

V1FileEditStatusResponseStatusEnum

Type: string. One of:

  • pending
  • extracting_text
  • editing
  • completed
  • failed