Get a single extraction result

Full detail for one resolved value, including the resolved value itself, the resolution status and justification, the dimension instances it belongs to, and the document pages it was sourced from (with web supplement data when web search is enabled on the agent).

On this page

HTTP request 

GET https://api.parsewise.ai/api/v1/projects/{project_id}/results/{resolution_result_id}/

URI Parameters

Name In Required Type Description
project_id path Yes string (uuid)  
resolution_result_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 V1ResultDetailResponse —

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>"
resolution_result_id = "<uuid>"

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

Definitions

LatestReviewStatusEnum

Type: string. One of:

  • none
  • positive
  • negative

NullEnum

Type: any. One of:

  • None

ResolutionStatusEnum

Type: string. One of:

  • Not resolved
  • Requires attention
  • Resolved
  • Ignored
  • No result

SourceType629Enum

Type: string. One of:

  • document
  • web
  • document_and_web

V1ResultDetailResponse

Name Required Type Description
id Yes string (uuid) Stable identifier of the resolution result.
atomic_value_id Yes string (uuid) Identifier of the underlying atomic value (one per combination of agent and dimension values).
result_name Yes string Human-readable label for this result, typically a concatenation of its dimension values.
agent_name Yes string Name of the agent that produced this result.
value Yes any Resolved value. Shape depends on the agent’s value_type: string -> string; number -> number; bool -> boolean; date -> ISO 8601 date string YYYY-MM-DD; datetime -> ISO 8601 date-time string. May be null for missing values.
resolution_status Yes ResolutionStatusEnum Resolution outcome for this entity.
justification_for_resolution_status Yes string (nullable) AI-generated explanation of why this resolution status was chosen. Null when not applicable.
references Yes object<string, array<string | integer (nullable)>> Citation map keyed by reference_id (the same IDs referenced from justification_for_resolution_status and from extraction passages). Each value is a 2-element array [document_name, document_page]: document_page is the 1-based page number, or null for sources without pages (e.g. websites). Empty object {} when there are no citations.
source_type Yes SourceType629Enum Where the resolved value came from. document when the value was derived from uploaded documents only; web when it was derived from web-search results only; document_and_web when both contributed. The non-document values only appear when enable_web_search is set on the agent.
is_web_supplement Yes boolean True when this result was supplemented with web search data rather than derived purely from uploaded documents.
web_supplement No V1ResultWebSupplement Populated only when web search is enabled on the agent and web data contributed to the resolution; otherwise null.
updated_by_email Yes string (email) (nullable) Email of the last user to manually override this resolution, or null if never manually updated.
created_at Yes string (date-time) When the resolution was first produced.
updated_at Yes string (date-time) When the resolution was last updated.
dimension_instances Yes array<V1ResultDimensionInstance> Dimension instances this result is keyed by (one entry per dimension configured on the agent).
sources Yes array<V1ResultSource> Document pages cited by the resolution. Empty for web-only results.
latest_review_status No LatestReviewStatusEnum | NullEnum Review verdict from the latest review. Null when no review has ever been recorded.
latest_review_comment No string Free-text reviewer comment from the latest review. Empty string when no comment was given.
latest_review_at No string (date-time) (nullable) When the latest review was recorded. Null when no review has ever been recorded.
latest_review_by No string (email) (nullable) Email of the reviewer. Null when no review has ever been recorded.

V1ResultDimensionInstance

One dimension instance (dimension + value) attached to an extraction result.

Name Required Type Description
id Yes string (uuid) Identifier of this dimension instance.
dimension_id Yes string (uuid) Identifier of the dimension this instance belongs to.
dimension_value Yes string Value of the dimension (e.g. “EMEA”, “2024”).
name Yes string Name of the dimension (e.g. “Region”).

V1ResultSource

Name Required Type Description
document_name Yes string Stored filename of the source document.
page_number Yes integer 1-indexed page number within the source document.
document_id Yes string (uuid) Stable identifier of the source document.
atomic_value_ids Yes array<string (uuid)> Identifiers of the atomic values whose resolutions cite this source.

V1ResultWebSupplement

Name Required Type Description
text Yes string Web-sourced supplementary text.
sources Yes array<V1ResultWebSupplementSource> Web pages cited for the supplement.

V1ResultWebSupplementSource

Name Required Type Description
url Yes string (uri) URL of the web source.
title Yes string Title of the web source.