API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Parse Jobs

client.Parsing.List(ctx, query) (*PaginatedCursor[ParsingListResponse], error)

GET/api/v2/parse

List parse jobs for the current project.

Filter by status or creation date range. Results are paginated — use page_token from the response to fetch subsequent pages.

ParametersExpand Collapse

query ParsingListParams

CreatedAtOnOrAfter param.Field[Time]optional

Include items created at or after this timestamp (inclusive)

formatdate-time

CreatedAtOnOrBefore param.Field[Time]optional

Include items created at or before this timestamp (inclusive)

formatdate-time

JobIDs param.Field[[]string]optional

Filter by specific job IDs

OrganizationID param.Field[string]optional

PageSize param.Field[int64]optional

Number of items per page

PageToken param.Field[string]optional

Token for pagination

ProjectID param.Field[string]optional

Status param.Field[ParsingListParamsStatus]optional

Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)

const ParsingListParamsStatusPending ParsingListParamsStatus = "PENDING"

const ParsingListParamsStatusRunning ParsingListParamsStatus = "RUNNING"

const ParsingListParamsStatusCompleted ParsingListParamsStatus = "COMPLETED"

const ParsingListParamsStatusFailed ParsingListParamsStatus = "FAILED"

const ParsingListParamsStatusCancelled ParsingListParamsStatus = "CANCELLED"

ReturnsExpand Collapse

type ParsingListResponse struct{…}

A parse job.

ID string

Unique parse job identifier

ProjectID string

Project this job belongs to

Status ParsingListResponseStatus

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:

const ParsingListResponseStatusPending ParsingListResponseStatus = "PENDING"

const ParsingListResponseStatusRunning ParsingListResponseStatus = "RUNNING"

const ParsingListResponseStatusCompleted ParsingListResponseStatus = "COMPLETED"

const ParsingListResponseStatusFailed ParsingListResponseStatus = "FAILED"

const ParsingListResponseStatusCancelled ParsingListResponseStatus = "CANCELLED"

CreatedAt Timeoptional

Creation datetime

formatdate-time

ErrorMessage stringoptional

Error details when status is FAILED

Name stringoptional

Optional display name for this parse job

Tier stringoptional

Parsing tier used for this job

UpdatedAt Timeoptional

Update datetime

formatdate-time

UserMetadata map[string, string]optional

Key/value tags associated with this job.

List Parse Jobs

Go

HTTP

TypeScript

Python

Java

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Parsing.List(context.TODO(), llamacloudprod.ParsingListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "items": [
    {
      "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "Q4 Financial Report",
      "tier": "fast",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "name": "Q4 Financial Report",
      "tier": "fast",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}