Get agent processing status

Per-agent progress and consistency counts for the active extraction pipeline. More expensive than GET /projects/{project_id}/status/; we recommend polling this endpoint only while pipeline_running is true.

On this page

• HTTP request
• URI Parameters
• Request Header
• Responses
• Security
• Python example
• Definitions
  • V1AgentConsistencyEntry
  • V1AgentProgressEntry
  • V1AgentStageProgressExtraction
  • V1AgentStageProgressParsing
  • V1AgentStageProgressResolution
  • V1AgentStageProgressWebSearch
  • V1AgentStatusResponse

HTTP request

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

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

Definitions

V1AgentConsistencyEntry

Name	Required	Type	Description
consistent_count	Yes	integer	Number of resolved values that are fully consistent across documents.
missing_count	Yes	integer	Number of expected values that could not be extracted from any document.
inconsistent_count	Yes	integer	Number of resolved values where document sources disagree and could not be reconciled automatically.
ignored_count	Yes	integer	Number of values explicitly marked as ignored by the user.
total_count	Yes	integer	Total number of resolved values for this agent.

V1AgentProgressEntry

Name	Required	Type	Description
parsing	Yes	V1AgentStageProgressParsing
extraction	Yes	V1AgentStageProgressExtraction
web_search	Yes	V1AgentStageProgressWebSearch
resolution	Yes	V1AgentStageProgressResolution
is_running	Yes	boolean	Whether this agent has active work in the current pipeline run. True only while the agent is actively processing (extraction, web search, or resolution). False for agents that are already up-to-date, even if the project-wide pipeline_running is true. Use this to decide when to show a progress indicator.
is_pending	Yes	boolean	Whether this agent has outstanding work that has not yet been processed. True when new documents have been uploaded, when the agent was never launched, or when extraction/resolution is incomplete. False once the agent is fully resolved against the project’s current documents.

V1AgentStageProgressExtraction

Name	Required	Type	Description
total	Yes	integer	Total units of work for this stage.
completed	Yes	integer	Units of work completed so far.
percentage	Yes	integer	Completion percentage (0–100), rounded to integer.

V1AgentStageProgressParsing

Name	Required	Type	Description
total	Yes	integer	Total units of work for this stage.
completed	Yes	integer	Units of work completed so far.
percentage	Yes	integer	Completion percentage (0–100), rounded to integer.

V1AgentStageProgressResolution

Name	Required	Type	Description
total	Yes	integer	Total units of work for this stage.
completed	Yes	integer	Units of work completed so far.
percentage	Yes	integer	Completion percentage (0–100), rounded to integer.

V1AgentStageProgressWebSearch

Name	Required	Type	Description
total	Yes	integer	Total units of work for this stage.
completed	Yes	integer	Units of work completed so far.
percentage	Yes	integer	Completion percentage (0–100), rounded to integer.

V1AgentStatusResponse

Name	Required	Type	Description
progress	Yes	object<string, V1AgentProgressEntry>	Per-agent pipeline progress, keyed by agent ID (UUID). Each value reports completion of the four pipeline stages: parsing (of the project’s documents), extraction (running the agent against each document), web_search (supplementary web lookups, when enabled on the agent), and resolution (consolidating extracted values into final results).
consistency	Yes	object<string, V1AgentConsistencyEntry>	Per-agent consistency counts, keyed by agent ID (UUID). Surfaces how many resolved values across the project are consistent, missing, inconsistent, or ignored.
pipeline_running	Yes	boolean	True while the project’s agent extraction pipeline is currently running.