> ## Documentation Index
> Fetch the complete documentation index at: https://docs.retab.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Parse
> Retrieve a parse.
Fetches a single parse by its `parse_id` within the authenticated environment and
returns the full `Parse` including its `output`. Responds with `404` if no parse with
that id exists.
Retrieve a single persisted parse by ID.
```python Python theme={null}
from retab import Retab
client = Retab()
parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)
```
```typescript TypeScript theme={null}
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const parse = await client.parses.get("parse_01G34H8J2K");
console.log(parse.output.text);
console.log(parse.file.filename);
```
```go Go theme={null}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
parse, err := client.Parses.Get(ctx, "parse_01G34H8J2K", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(parse.Output.Text)
fmt.Println(parse.File)
}
```
```ruby Ruby theme={null}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
parse = client.parses.get(parse_id: 'parse_01G34H8J2K')
puts parse.output.text
puts parse.file.filename
```
```rust Rust theme={null}
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let parse = client.parses().get("parse_01G34H8J2K", Default::default()).await?;
println!("{}", parse.output.text);
println!("{}", parse.file.filename);
Ok(())
}
```
```php PHP theme={null}
parses()->get(
parseId: 'parse_01G34H8J2K',
);
print_r($result);
```
```csharp C# theme={null}
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Parses.GetAsync("parse_01G34H8J2K");
Console.WriteLine(result);
```
```java Java theme={null}
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.parses().get("parse_abc123", null);
System.out.println(result);
}
}
```
```curl cURL theme={null}
curl -X GET \
'https://api.retab.com/v1/parses/parse_01G34H8J2K' \
-H "Authorization: Bearer $RETAB_API_KEY"
```
```json 200 theme={null}
{
"id": "parse_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "document.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"table_parsing_format": "markdown",
"output": {
"pages": [
"# Document Title\n\nFirst page content...",
"Second page content..."
],
"text": "# Document Title\n\nFirst page content...\n\nSecond page content..."
},
"usage": {
"page_count": 2,
"credits": 1.0
},
"created_at": "2024-03-15T10:30:00Z"
}
```
```json 404 theme={null}
{
"detail": "Parse not found"
}
```
## OpenAPI
````yaml GET /v1/parses/{parse_id}
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
servers:
- url: https://api.retab.com
security: []
paths:
/v1/parses/{parse_id}:
get:
tags:
- Parses
summary: Get Parse
description: >-
Retrieve a parse.
Fetches a single parse by its `parse_id` within the authenticated
environment and
returns the full `Parse` including its `output`. Responds with `404` if
no parse with
that id exists.
operationId: get_parse
parameters:
- in: path
name: parse_id
required: true
schema:
type: string
title: Parse Id
- description: >-
When false, returns a cheap status-only projection (no output),
served from cache for in-flight background runs.
in: query
name: include_output
schema:
type: boolean
description: >-
When false, returns a cheap status-only projection (no output),
served from cache for in-flight background runs.
default: true
title: Include Output
required: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Parse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
Parse:
properties:
id:
type: string
title: Id
description: Unique identifier of the parse
file:
$ref: '#/components/schemas/FileRef'
description: Information about the parsed file
model:
type: string
title: Model
description: Model used for parsing
table_parsing_format:
type: string
enum:
- markdown
- yaml
- html
- json
title: Table Parsing Format
description: Format used to render tables extracted from the document
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Free-form instructions supplied with the parse request.
output:
$ref: '#/components/schemas/ParseOutput'
description: The parsed document content
status:
type: string
enum:
- pending
- queued
- in_progress
- completed
- failed
- cancelled
title: Status
description: >-
Lifecycle status. The synchronous path returns 'completed'.
Background runs progress pending -> queued -> in_progress ->
completed | failed | cancelled.
default: pending
error:
anyOf:
- $ref: '#/components/schemas/PrimitiveError'
- type: 'null'
description: >-
Error details when a background run fails; null otherwise. Always
present so consumers can read it without an existence check.
usage:
anyOf:
- $ref: '#/components/schemas/RetabUsage'
- type: 'null'
description: Usage information for the parse operation
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
type: object
required:
- file
- id
- model
- output
- table_parsing_format
title: Parse
description: >-
A parse result: the per-page and full-document text extracted from a
document.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
default: []
type: object
title: HTTPValidationError
FileRef:
properties:
id:
type: string
title: Id
description: ID of the file
filename:
type: string
title: Filename
description: Filename of the file
mime_type:
type: string
title: Mime Type
description: MIME type of the file
type: object
required:
- filename
- id
- mime_type
title: FileRef
description: Public/shared file reference used across SDK and customer-facing APIs.
ParseOutput:
properties:
pages:
items:
type: string
type: array
title: Pages
description: Text content of each page (1-indexed order)
text:
type: string
title: Text
description: Concatenated text content of the full document
type: object
required:
- pages
- text
title: ParseOutput
PrimitiveError:
properties:
code:
type: string
title: Code
description: Machine-readable error code.
message:
type: string
title: Message
description: Human-readable error message.
details:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Details
description: Optional structured error context.
type: object
required:
- code
- message
title: PrimitiveError
RetabUsage:
properties:
credits:
type: number
title: Credits
description: Credits consumed for processing
type: object
required:
- credits
title: RetabUsage
description: Usage information for document processing.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
default: null
ctx:
type: object
title: Context
default: {}
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
````