Get project processing status

Compact processing status for a project, intended for frequent polling (for example, every 15 seconds) while documents are being parsed or agents are running.

On this page

• HTTP request
• URI Parameters
• Request Header
• Responses
• Security
• Python example
• Definitions
  • NullEnum
  • ParsingStateEnum
  • SchemaStatusEnum
  • V1ProjectStatusResponse

HTTP request

GET https://api.parsewise.ai/api/v1/projects/{project_id}/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	V1ProjectStatusResponse	—

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}/status/",
    headers={"X-API-Key": API_KEY},
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

NullEnum

Type: any. One of:

• None

ParsingStateEnum

Type: string. One of:

• ready
• parsing
• not_started
• stuck

SchemaStatusEnum

Type: string. One of:

• pending
• success
• failed

V1ProjectStatusResponse

Name	Required	Type	Description
parsing_state	Yes	ParsingStateEnum	Current parsing state of the project. not_started before parsing begins, parsing while documents are being parsed, ready when all documents are parsed, and stuck when parsing has stalled and could not recover automatically.
pending_documents	Yes	array<string (uuid)>	IDs of documents that are still being parsed.
pipeline_running	Yes	boolean	True while the project’s agent extraction pipeline is currently running.
schema_status	Yes	SchemaStatusEnum | NullEnum	Status of the output mapping generation for the project’s target schema. Null when no schema is configured.