from retab import Retab
client = Retab()
splits = client.splits.list(limit=20, order="desc")
for s in splits.data:
print(f"{s.id}: {s.file.filename}")
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const splits = await client.splits.list({ limit: 20, order: "desc" });
for (const s of splits.data) {
console.log(`${s.id}: ${s.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)
}
splits, err := client.Splits.List(ctx, &retab.SplitsListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20), Order: ptr("desc")},
})
if err != nil {
log.Fatal(err)
}
for _, s := range splits.Data {
fmt.Printf("%s: %s\n", s.ID, s.File.Filename)
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
splits = client.splits.list(limit: 20, order: 'desc')
splits.data.each do |s|
puts "#{s.id}: #{s.file.filename}"
end
use retab::enums::SplitsOrder;
use retab::resources::splits::ListParams;
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 splits = client
.splits()
.list(ListParams {
limit: Some(20),
order: Some(SplitsOrder::Desc),
..Default::default()
})
.await?;
for s in &splits.data {
println!("{}: {}", s.id, s.file.filename);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->splits()->list();
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.Splits.ListAsync(new SplitsListOptions());
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.splits().list(null, null, 10L, null, "invoice.pdf", null, null, null);
System.out.println(result);
}
}
curl -X GET \
'https://api.retab.com/v1/splits?limit=20&order=desc' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "split_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "invoice_batch.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"subdocuments": [
{
"name": "invoice",
"description": "Invoice documents",
"allow_multiple_instances": true
}
],
"n_consensus": 1,
"instructions": null,
"output": [{ "name": "invoice", "pages": [1, 2, 3] }],
"consensus": null,
"usage": {
"credits": 1.0
},
"created_at": "2024-03-15T10:30:00Z"
}
],
"list_metadata": {
"before": null,
"after": "split_01G34H8J2K",
"total_count": 12
}
}
Splits
List Splits
List splits.
Returns a paginated list of splits for the authenticated environment, newest first by
default. Filter by filename prefix (case-insensitive) and by a created_at window
using from_date/to_date (YYYY-MM-DD). Page through results with before/after,
limit, and order.
GET
/
v1
/
splits
from retab import Retab
client = Retab()
splits = client.splits.list(limit=20, order="desc")
for s in splits.data:
print(f"{s.id}: {s.file.filename}")
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const splits = await client.splits.list({ limit: 20, order: "desc" });
for (const s of splits.data) {
console.log(`${s.id}: ${s.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)
}
splits, err := client.Splits.List(ctx, &retab.SplitsListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20), Order: ptr("desc")},
})
if err != nil {
log.Fatal(err)
}
for _, s := range splits.Data {
fmt.Printf("%s: %s\n", s.ID, s.File.Filename)
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
splits = client.splits.list(limit: 20, order: 'desc')
splits.data.each do |s|
puts "#{s.id}: #{s.file.filename}"
end
use retab::enums::SplitsOrder;
use retab::resources::splits::ListParams;
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 splits = client
.splits()
.list(ListParams {
limit: Some(20),
order: Some(SplitsOrder::Desc),
..Default::default()
})
.await?;
for s in &splits.data {
println!("{}: {}", s.id, s.file.filename);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->splits()->list();
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.Splits.ListAsync(new SplitsListOptions());
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.splits().list(null, null, 10L, null, "invoice.pdf", null, null, null);
System.out.println(result);
}
}
curl -X GET \
'https://api.retab.com/v1/splits?limit=20&order=desc' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "split_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "invoice_batch.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"subdocuments": [
{
"name": "invoice",
"description": "Invoice documents",
"allow_multiple_instances": true
}
],
"n_consensus": 1,
"instructions": null,
"output": [{ "name": "invoice", "pages": [1, 2, 3] }],
"consensus": null,
"usage": {
"credits": 1.0
},
"created_at": "2024-03-15T10:30:00Z"
}
],
"list_metadata": {
"before": null,
"after": "split_01G34H8J2K",
"total_count": 12
}
}
List persisted splits for your organization, with id-based pagination.
from retab import Retab
client = Retab()
splits = client.splits.list(limit=20, order="desc")
for s in splits.data:
print(f"{s.id}: {s.file.filename}")
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const splits = await client.splits.list({ limit: 20, order: "desc" });
for (const s of splits.data) {
console.log(`${s.id}: ${s.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)
}
splits, err := client.Splits.List(ctx, &retab.SplitsListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20), Order: ptr("desc")},
})
if err != nil {
log.Fatal(err)
}
for _, s := range splits.Data {
fmt.Printf("%s: %s\n", s.ID, s.File.Filename)
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
splits = client.splits.list(limit: 20, order: 'desc')
splits.data.each do |s|
puts "#{s.id}: #{s.file.filename}"
end
use retab::enums::SplitsOrder;
use retab::resources::splits::ListParams;
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 splits = client
.splits()
.list(ListParams {
limit: Some(20),
order: Some(SplitsOrder::Desc),
..Default::default()
})
.await?;
for s in &splits.data {
println!("{}: {}", s.id, s.file.filename);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->splits()->list();
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.Splits.ListAsync(new SplitsListOptions());
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.splits().list(null, null, 10L, null, "invoice.pdf", null, null, null);
System.out.println(result);
}
}
curl -X GET \
'https://api.retab.com/v1/splits?limit=20&order=desc' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "split_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "invoice_batch.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"subdocuments": [
{
"name": "invoice",
"description": "Invoice documents",
"allow_multiple_instances": true
}
],
"n_consensus": 1,
"instructions": null,
"output": [{ "name": "invoice", "pages": [1, 2, 3] }],
"consensus": null,
"usage": {
"credits": 1.0
},
"created_at": "2024-03-15T10:30:00Z"
}
],
"list_metadata": {
"before": null,
"after": "split_01G34H8J2K",
"total_count": 12
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Required range:
1 <= x <= 100Available options:
asc, desc Available options:
pending, queued, in_progress, completed, failed, cancelled Response
Successful Response
⌘I