Skip to content

Get File Page Screenshot

JsonValue pipelines().images().getPageScreenshot(ImageGetPageScreenshotParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/files/{id}/page_screenshots/{page_index}

Get screenshot of a page from a file.

ParametersExpand Collapse
ImageGetPageScreenshotParams params
String id
Optional<Long> pageIndex
Optional<String> organizationId
Optional<String> projectId
ReturnsExpand Collapse
class ImageGetPageScreenshotResponse:

Get File Page Screenshot

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.pipelines.images.ImageGetPageScreenshotParams;
import com.llamacloud_prod.api.models.pipelines.images.ImageGetPageScreenshotResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        ImageGetPageScreenshotParams params = ImageGetPageScreenshotParams.builder()
            .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .pageIndex(0L)
            .build();
        ImageGetPageScreenshotResponse response = client.pipelines().images().getPageScreenshot(params);
    }
}
{}
Returns Examples
{}
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/