from retab import Retab
client = Retab()
# List recent files
files = client.files.list(limit=20)
for f in files:
print(f"{f.id}: {f.filename}")
# Filter by filename prefix and MIME type
files = client.files.list(
filename="invoice",
mime_type="application/pdf",
limit=50
)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
// List recent files
const files = await client.files.list({ limit: 20 });
for (const f of files.data) {
console.log(`${f.id}: ${f.filename}`);
}
// Filter by filename prefix
const filtered = await client.files.list({
filename: "invoice",
mimeType: "application/pdf",
limit: 50,
});
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)
}
// List recent files
files, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20)},
})
if err != nil {
log.Fatal(err)
}
for _, f := range files.Data {
fmt.Printf("%s: %s\n", f.ID, f.Filename)
}
// Filter by filename prefix and MIME type
filtered, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(50)},
Filename: ptr("invoice"),
MIMEType: ptr("application/pdf"),
})
if err != nil {
log.Fatal(err)
}
_ = filtered
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
# List recent files
files = client.files.list(limit: 20)
files.data.each do |f|
puts "#{f.id}: #{f.filename}"
end
# Filter by filename prefix and MIME type
filtered = client.files.list(
filename: 'invoice',
mime_type: 'application/pdf',
limit: 50,
)
use retab::resources::files::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")?);
// List recent files
let files = client
.files()
.list(ListParams {
limit: Some(20),
..Default::default()
})
.await?;
for f in &files.data {
println!("{}: {}", f.id, f.filename);
}
// Filter by filename prefix and MIME type
let _filtered = client
.files()
.list(ListParams {
filename: Some("invoice".into()),
mime_type: Some("application/pdf".into()),
limit: Some(50),
..Default::default()
})
.await?;
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->files()->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.Files.ListAsync(new FilesListOptions());
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.files().list(null, null, 10L, null, "invoice.pdf", null, null, null, null, "created_at");
System.out.println(result);
}
}
# List all files
curl -X GET \
'https://api.retab.com/v1/files?limit=20' \
-H "Authorization: Bearer $RETAB_API_KEY"
# Filter by filename and MIME type
curl -X GET \
'https://api.retab.com/v1/files?filename=invoice&mime_type=application/pdf&limit=50' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "file_a1b2c3d4e5f6",
"object": "file",
"filename": "invoice.pdf",
"page_count": 3,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "file_g7h8i9j0k1l2",
"object": "file",
"filename": "receipt.png",
"page_count": 1,
"created_at": "2024-01-14T08:15:00Z",
"updated_at": "2024-01-14T08:15:00Z"
}
],
"list_metadata": {
"before": null,
"after": "file_g7h8i9j0k1l2"
}
}
{
"data": [],
"list_metadata": {
"before": null,
"after": null
}
}
Files
List Files
List files with pagination and optional filtering.
GET
/
v1
/
files
from retab import Retab
client = Retab()
# List recent files
files = client.files.list(limit=20)
for f in files:
print(f"{f.id}: {f.filename}")
# Filter by filename prefix and MIME type
files = client.files.list(
filename="invoice",
mime_type="application/pdf",
limit=50
)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
// List recent files
const files = await client.files.list({ limit: 20 });
for (const f of files.data) {
console.log(`${f.id}: ${f.filename}`);
}
// Filter by filename prefix
const filtered = await client.files.list({
filename: "invoice",
mimeType: "application/pdf",
limit: 50,
});
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)
}
// List recent files
files, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20)},
})
if err != nil {
log.Fatal(err)
}
for _, f := range files.Data {
fmt.Printf("%s: %s\n", f.ID, f.Filename)
}
// Filter by filename prefix and MIME type
filtered, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(50)},
Filename: ptr("invoice"),
MIMEType: ptr("application/pdf"),
})
if err != nil {
log.Fatal(err)
}
_ = filtered
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
# List recent files
files = client.files.list(limit: 20)
files.data.each do |f|
puts "#{f.id}: #{f.filename}"
end
# Filter by filename prefix and MIME type
filtered = client.files.list(
filename: 'invoice',
mime_type: 'application/pdf',
limit: 50,
)
use retab::resources::files::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")?);
// List recent files
let files = client
.files()
.list(ListParams {
limit: Some(20),
..Default::default()
})
.await?;
for f in &files.data {
println!("{}: {}", f.id, f.filename);
}
// Filter by filename prefix and MIME type
let _filtered = client
.files()
.list(ListParams {
filename: Some("invoice".into()),
mime_type: Some("application/pdf".into()),
limit: Some(50),
..Default::default()
})
.await?;
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->files()->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.Files.ListAsync(new FilesListOptions());
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.files().list(null, null, 10L, null, "invoice.pdf", null, null, null, null, "created_at");
System.out.println(result);
}
}
# List all files
curl -X GET \
'https://api.retab.com/v1/files?limit=20' \
-H "Authorization: Bearer $RETAB_API_KEY"
# Filter by filename and MIME type
curl -X GET \
'https://api.retab.com/v1/files?filename=invoice&mime_type=application/pdf&limit=50' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "file_a1b2c3d4e5f6",
"object": "file",
"filename": "invoice.pdf",
"page_count": 3,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "file_g7h8i9j0k1l2",
"object": "file",
"filename": "receipt.png",
"page_count": 1,
"created_at": "2024-01-14T08:15:00Z",
"updated_at": "2024-01-14T08:15:00Z"
}
],
"list_metadata": {
"before": null,
"after": "file_g7h8i9j0k1l2"
}
}
{
"data": [],
"list_metadata": {
"before": null,
"after": null
}
}
List uploaded files with pagination and optional filtering by filename or MIME type.
from retab import Retab
client = Retab()
# List recent files
files = client.files.list(limit=20)
for f in files:
print(f"{f.id}: {f.filename}")
# Filter by filename prefix and MIME type
files = client.files.list(
filename="invoice",
mime_type="application/pdf",
limit=50
)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
// List recent files
const files = await client.files.list({ limit: 20 });
for (const f of files.data) {
console.log(`${f.id}: ${f.filename}`);
}
// Filter by filename prefix
const filtered = await client.files.list({
filename: "invoice",
mimeType: "application/pdf",
limit: 50,
});
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)
}
// List recent files
files, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20)},
})
if err != nil {
log.Fatal(err)
}
for _, f := range files.Data {
fmt.Printf("%s: %s\n", f.ID, f.Filename)
}
// Filter by filename prefix and MIME type
filtered, err := client.Files.List(ctx, &retab.FilesListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(50)},
Filename: ptr("invoice"),
MIMEType: ptr("application/pdf"),
})
if err != nil {
log.Fatal(err)
}
_ = filtered
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
# List recent files
files = client.files.list(limit: 20)
files.data.each do |f|
puts "#{f.id}: #{f.filename}"
end
# Filter by filename prefix and MIME type
filtered = client.files.list(
filename: 'invoice',
mime_type: 'application/pdf',
limit: 50,
)
use retab::resources::files::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")?);
// List recent files
let files = client
.files()
.list(ListParams {
limit: Some(20),
..Default::default()
})
.await?;
for f in &files.data {
println!("{}: {}", f.id, f.filename);
}
// Filter by filename prefix and MIME type
let _filtered = client
.files()
.list(ListParams {
filename: Some("invoice".into()),
mime_type: Some("application/pdf".into()),
limit: Some(50),
..Default::default()
})
.await?;
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->files()->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.Files.ListAsync(new FilesListOptions());
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.files().list(null, null, 10L, null, "invoice.pdf", null, null, null, null, "created_at");
System.out.println(result);
}
}
# List all files
curl -X GET \
'https://api.retab.com/v1/files?limit=20' \
-H "Authorization: Bearer $RETAB_API_KEY"
# Filter by filename and MIME type
curl -X GET \
'https://api.retab.com/v1/files?filename=invoice&mime_type=application/pdf&limit=50' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"data": [
{
"id": "file_a1b2c3d4e5f6",
"object": "file",
"filename": "invoice.pdf",
"page_count": 3,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "file_g7h8i9j0k1l2",
"object": "file",
"filename": "receipt.png",
"page_count": 1,
"created_at": "2024-01-14T08:15:00Z",
"updated_at": "2024-01-14T08:15:00Z"
}
],
"list_metadata": {
"before": null,
"after": "file_g7h8i9j0k1l2"
}
}
{
"data": [],
"list_metadata": {
"before": null,
"after": null
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Items per page
Required range:
1 <= x <= 100Available options:
asc, desc Include embeddings in the response
Response
Successful Response
⌘I