API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List File Page Screenshots

client.Pipelines.Images.ListPageScreenshots(ctx, id, query) (*[]PipelineImageListPageScreenshotsResponse, error)

GET/api/v1/files/{id}/page_screenshots

List metadata for all screenshots of pages from a file.

ParametersExpand Collapse

id string

query PipelineImageListPageScreenshotsParams

OrganizationID param.Field[string]optional

ProjectID param.Field[string]optional

ReturnsExpand Collapse

type PipelineImageListPageScreenshotsResponse []PipelineImageListPageScreenshotsResponse

FileID string

The ID of the file that the page screenshot was taken from

formatuuid

ImageSize int64

The size of the image in bytes

minimum0

PageIndex int64

The index of the page for which the screenshot is taken (0-indexed)

minimum0

Metadata map[string, any]optional

Metadata for the screenshot

List File Page Screenshots

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"),
  )
  response, err := client.Pipelines.Images.ListPageScreenshots(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    llamacloudprod.PipelineImageListPageScreenshotsParams{

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

200 example

[
  {
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "image_size": 0,
    "page_index": 0,
    "metadata": {
      "foo": "bar"
    }
  }
]

Returns Examples

200 example

[
  {
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "image_size": 0,
    "page_index": 0,
    "metadata": {
      "foo": "bar"
    }
  }
]