Get Configuration
Get a single product configuration by ID.
ParametersExpand Collapse
ReturnsExpand Collapse
type ConfigurationResponse struct{…}
Response schema for a single product configuration.
Parameters ConfigurationResponseParametersUnion
Product-specific configuration parameters.
type SplitV1ParametersResp struct{…}
Typed parameters for a split v1 product configuration.
Categories []SplitCategory
SplittingStrategy SplitV1ParametersSplittingStrategyRespoptional
Strategy for splitting documents.
AllowUncategorized stringoptional
Controls handling of pages that don’t match any category. ‘include’: pages can be grouped as ‘uncategorized’ and included in results. ‘forbid’: all pages must be assigned to a defined category. ‘omit’: pages can be classified as ‘uncategorized’ but are excluded from results.
type ExtractV2ParametersResp struct{…}
Typed parameters for an extract v2 product configuration.
ExtractVersion stringoptional
Extract algorithm version. Use ‘latest’ for the default pipeline or a date string (e.g. ‘2026-01-08’) to pin to a specific release.
ExtractionTarget ExtractV2ParametersExtractionTargetoptional
Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row
ParseConfigID stringoptional
Saved parse configuration ID to control how the document is parsed before extraction
ParseTier stringoptional
Parse tier to use before extraction. Defaults to the extract tier if not specified.
type ClassifyV2ParametersResp struct{…}
type ParseV2ParametersResp struct{…}
Configuration for LlamaParse v2 document parsing.
Includes tier selection, processing options, output formatting, page targeting, and webhook delivery. Refer to the LlamaParse documentation for details on each field.
Tier ParseV2ParametersTier
Parsing tier: ‘fast’ (rule-based, cheapest), ‘cost_effective’ (balanced), ‘agentic’ (AI-powered with custom prompts), or ‘agentic_plus’ (premium AI with highest accuracy)
Version ParseV2ParametersVersion
Tier version. Use ‘latest’ for the current stable version, or specify a specific version (e.g., ‘1.0’, ‘2.0’) for reproducible results
AgenticOptions ParseV2ParametersAgenticOptionsRespoptional
Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus).
These options customize how the AI processes and interprets document content. Only applicable when using non-fast tiers.
ClientName stringoptional
Identifier for the client/application making the request. Used for analytics and debugging. Example: ‘my-app-v2’
CropBox ParseV2ParametersCropBoxRespoptional
Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges
Bottom float64optional
Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded
Left float64optional
Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded
DisableCache booloptional
Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results
FastOptions anyoptional
Options for fast tier parsing (rule-based, no AI).
Fast tier uses deterministic algorithms for text extraction without AI enhancement. It’s the fastest and most cost-effective option, best suited for simple documents with standard layouts. Currently has no configurable options but reserved for future expansion.
InputOptions ParseV2ParametersInputOptionsRespoptional
Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type
HTML ParseV2ParametersInputOptionsHTMLRespoptional
HTML/web page parsing options (applies to .html, .htm files)
MakeAllElementsVisible booloptional
Force all HTML elements to be visible by overriding CSS display/visibility properties. Useful for parsing pages with hidden content or collapsed sections
Presentation ParseV2ParametersInputOptionsPresentationRespoptional
Spreadsheet ParseV2ParametersInputOptionsSpreadsheetRespoptional
Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)
DetectSubTablesInSheets booloptional
Detect and extract multiple tables within a single sheet. Useful when spreadsheets contain several data regions separated by blank rows/columns
OutputOptions ParseV2ParametersOutputOptionsRespoptional
Output formatting options for markdown, text, and extracted images
ExtractPrintedPageNumber booloptional
Extract the printed page number as it appears in the document (e.g., ‘Page 5 of 10’, ‘v’, ‘A-3’). Useful for referencing original page numbers
ImagesToSave []stringoptional
Image categories to extract and save. Options: ‘screenshot’ (full page renders useful for visual QA), ‘embedded’ (images found within the document), ‘layout’ (cropped regions from layout detection like figures and diagrams). Empty list saves no images
Markdown ParseV2ParametersOutputOptionsMarkdownRespoptional
Markdown formatting options including table styles and link annotations
AnnotateLinks booloptional
Add link annotations to markdown output in the format text. When false, only the link text is included
InlineImages booloptional
Embed images directly in markdown as base64 data URIs instead of extracting them as separate files. Useful for self-contained markdown output
Tables ParseV2ParametersOutputOptionsMarkdownTablesRespoptional
Table formatting options including markdown vs HTML format and merging behavior
CompactMarkdownTables booloptional
Remove extra whitespace padding in markdown table cells for more compact output
MarkdownTableMultilineSeparator stringoptional
Separator string for multiline cell content in markdown tables. Example: ‘<br>’ to preserve line breaks, ’ ’ to join with spaces
SpatialText ParseV2ParametersOutputOptionsSpatialTextRespoptional
Spatial text output options for preserving document layout structure
DoNotUnrollColumns booloptional
Keep multi-column layouts intact instead of linearizing columns into sequential text. Automatically enabled for non-fast tiers
PageRanges ParseV2ParametersPageRangesRespoptional
Page selection: limit total pages or specify exact pages to process
MaxPages int64optional
Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence
TargetPages stringoptional
Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: ‘1,3,5’ (pages 1, 3, 5), ‘1-5’ (pages 1 through 5 inclusive), ‘1,3,5-8,10’ (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error
ProcessingControl ParseV2ParametersProcessingControlRespoptional
Job execution controls including timeouts and failure thresholds
JobFailureConditions ParseV2ParametersProcessingControlJobFailureConditionsRespoptional
Quality thresholds that determine when a job should fail vs complete with partial results
AllowedPageFailureRatio float64optional
Maximum ratio of pages allowed to fail before the job fails (0-1). Example: 0.1 means job fails if more than 10% of pages fail. Default is 0.05 (5%)
FailOnBuggyFont booloptional
Fail the job if a problematic font is detected that may cause incorrect text extraction. Buggy fonts can produce garbled or missing characters
FailOnImageExtractionError booloptional
Fail the entire job if any embedded image cannot be extracted. By default, image extraction errors are logged but don’t fail the job
Timeouts ParseV2ParametersProcessingControlTimeoutsRespoptional
ProcessingOptions ParseV2ParametersProcessingOptionsRespoptional
Document processing options including OCR, table extraction, and chart parsing
AggressiveTableExtraction booloptional
Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables
AutoModeConfiguration []ParseV2ParametersProcessingOptionsAutoModeConfigurationRespoptional
Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered
ParsingConf ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfResp
Parsing configuration to apply when trigger conditions are met
CropBox ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfCropBoxRespoptional
Crop box options for auto mode parsing configuration.
CustomPrompt stringoptional
Custom AI instructions for matched pages. Overrides the base custom_prompt
Presentation ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfPresentationRespoptional
SpatialText ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpatialTextRespoptional
Spatial text options for auto mode parsing configuration.
SpecializedChartParsing stringoptional
Enable specialized chart parsing with the specified mode
Tier stringoptional
Override the parsing tier for matched pages. Must be paired with version
Version stringoptional
Tier version when overriding tier. Required when tier is specified
string
FullPageImageInPageThreshold ParseV2ParametersProcessingOptionsAutoModeConfigurationFullPageImageInPageThresholdUnionRespoptional
LayoutElementInPageConfidenceThreshold ParseV2ParametersProcessingOptionsAutoModeConfigurationLayoutElementInPageConfidenceThresholdUnionRespoptional
PageContainsAtLeastNCharts ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNChartsUnionRespoptional
PageContainsAtLeastNImages ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNImagesUnionRespoptional
PageContainsAtLeastNLayoutElements ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLayoutElementsUnionRespoptional
PageContainsAtLeastNLines ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLinesUnionRespoptional
PageContainsAtLeastNLinks ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLinksUnionRespoptional
PageContainsAtLeastNNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNNumbersUnionRespoptional
PageContainsAtLeastNPercentNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNPercentNumbersUnionRespoptional
PageContainsAtLeastNTables ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNTablesUnionRespoptional
PageContainsAtLeastNWords ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNWordsUnionRespoptional
PageContainsAtMostNCharts ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNChartsUnionRespoptional
PageContainsAtMostNImages ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNImagesUnionRespoptional
PageContainsAtMostNLayoutElements ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLayoutElementsUnionRespoptional
PageContainsAtMostNLines ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLinesUnionRespoptional
PageContainsAtMostNLinks ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLinksUnionRespoptional
PageContainsAtMostNNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNNumbersUnionRespoptional
PageContainsAtMostNPercentNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNPercentNumbersUnionRespoptional
PageContainsAtMostNTables ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNTablesUnionRespoptional
PageContainsAtMostNWords ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNWordsUnionRespoptional
PageLongerThanNChars ParseV2ParametersProcessingOptionsAutoModeConfigurationPageLongerThanNCharsUnionRespoptional
CostOptimizer ParseV2ParametersProcessingOptionsCostOptimizerRespoptional
Cost optimizer configuration for reducing parsing costs on simpler pages.
When enabled, the parser analyzes each page and routes simpler pages to faster, cheaper processing while preserving quality for complex pages. Only works with ‘agentic’ or ‘agentic_plus’ tiers.
DisableHeuristics booloptional
Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results
Ignore ParseV2ParametersProcessingOptionsIgnoreRespoptional
Options for ignoring specific text types (diagonal, hidden, text in images)
IgnoreDiagonalText booloptional
Skip text rotated at an angle (not horizontal/vertical). Useful for ignoring watermarks or decorative angled text
OcrParameters ParseV2ParametersProcessingOptionsOcrParametersRespoptional
SpecializedChartParsing stringoptional
Enable AI-powered chart analysis. Modes: ‘efficient’ (fast, lower cost), ‘agentic’ (balanced), ‘agentic_plus’ (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set
WebhookConfigurations []ParseV2ParametersWebhookConfigurationRespoptional
Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services
WebhookEvents []stringoptional
Events that trigger this webhook. Options: ‘parse.success’ (job completed), ‘parse.failure’ (job failed), ‘parse.partial’ (some pages failed). If not specified, webhook fires for all events
type ConfigurationResponseParametersSpreadsheetV1 struct{…}
Typed parameters for a spreadsheet v1 product configuration.
ExtractionRange stringoptional
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
FlattenHierarchicalTables booloptional
Return a flattened dataframe when a detected table is recognized as hierarchical.
GenerateAdditionalMetadata booloptional
Whether to generate additional metadata (title, description) for each extracted region.
IncludeHiddenCells booloptional
Whether to include hidden cells when extracting regions from the spreadsheet.
SheetNames []stringoptional
The names of the sheets to extract regions from. If empty, all sheets will be processed.
Specialization stringoptional
Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.
TableMergeSensitivity stringoptional
Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).
Get Configuration
package main
import (
"context"
"fmt"
"github.com/stainless-sdks/llamacloud-prod-go"
"github.com/stainless-sdks/llamacloud-prod-go/option"
)
func main() {
client := llamacloudprod.NewClient(
option.WithAPIKey("My API Key"),
)
configurationResponse, err := client.Configurations.Get(
context.TODO(),
"config_id",
llamacloudprod.ConfigurationGetParams{
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", configurationResponse.ID)
}
{
"id": "id",
"name": "name",
"parameters": {
"categories": [
{
"name": "x",
"description": "x"
}
],
"product_type": "split_v1",
"splitting_strategy": {
"allow_uncategorized": "include"
}
},
"product_type": "split_v1",
"version": "version",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
}Returns Examples
{
"id": "id",
"name": "name",
"parameters": {
"categories": [
{
"name": "x",
"description": "x"
}
],
"product_type": "split_v1",
"splitting_strategy": {
"allow_uncategorized": "include"
}
},
"product_type": "split_v1",
"version": "version",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
}