from retab import Retab
client = Retab()
parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)
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);
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)
}
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
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
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
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->parses()->get(
parseId: 'parse_01G34H8J2K',
);
print_r($result);
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);
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 -X GET \
'https://api.retab.com/v1/parses/parse_01G34H8J2K' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "parse_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "document.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"table_parsing_format": "markdown",
"image_resolution_dpi": 192,
"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"
}
{
"detail": "Parse not found"
}
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.
from retab import Retab
client = Retab()
parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)
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);
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)
}
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
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
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
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->parses()->get(
parseId: 'parse_01G34H8J2K',
);
print_r($result);
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);
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 -X GET \
'https://api.retab.com/v1/parses/parse_01G34H8J2K' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "parse_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "document.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"table_parsing_format": "markdown",
"image_resolution_dpi": 192,
"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"
}
{
"detail": "Parse not found"
}
from retab import Retab
client = Retab()
parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)
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);
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)
}
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
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
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
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->parses()->get(
parseId: 'parse_01G34H8J2K',
);
print_r($result);
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);
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 -X GET \
'https://api.retab.com/v1/parses/parse_01G34H8J2K' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "parse_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "document.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"table_parsing_format": "markdown",
"image_resolution_dpi": 192,
"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"
}
{
"detail": "Parse not found"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.
Response
Successful Response
A parse result: the per-page and full-document text extracted from a document.
Unique identifier of the parse
Information about the parsed file
Show child attributes
Show child attributes
Model used for parsing
Format used to render tables extracted from the document
markdown, yaml, html, json DPI used when rasterizing pages for the parser
The parsed document content
Show child attributes
Show child attributes
Free-form instructions supplied with the parse request.
Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.
pending, queued, in_progress, completed, failed, cancelled Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.
Show child attributes
Show child attributes
Usage information for the parse operation
Show child attributes
Show child attributes