Fetch a parse result

GET

/api/v1/documents/{documentId}

const url = 'https://api.langparse.dev/api/v1/documents/example?expand=model&fields%5Bmodel%5D=id%2Cname%2Cversion';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.langparse.dev/api/v1/documents/example?expand=model&fields%5Bmodel%5D=id%2Cname%2Cversion' \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

apiKey
bearerAuth

Parameters

Path Parameters

documentId

required

string

Query Parameters

expand

string

Expand relations. model replaces the top-level model id string with {id,name}; documents.model expands split sub-documents. Shallow (one hop).

Example

model

fields[model]

string

Fields to return for an expanded model (allowed: id, name, version, geometry). Default: id,name.

Example

id,name,version

Responses

200

Document status and (when processed) structured result

application/json

object

string

model

Model id string, or { id, name } when ?expand=model.

string

nullable

status

string

Allowed values: queued processing processed failed

debugId

string

pageCount

integer

data

object

key

additional properties

any

fields

Array<object>

nullable

object

name

string

value

confidence

string

Allowed values: high medium low flagged

boxes

Array<object>

object

left

number

top

number

width

number

height

number

page

integer

Example

{
  "status": "queued",
  "fields": [
    {
      "confidence": "high"
    }
  ]
}

401

Missing or invalid API key

404

Document not found