from retab import Retab
client = Retab()
extraction = client.extractions.create_extraction_cancel("extr_01G34H8J2K")
print(extraction.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const extraction = await client.extractions.create_extraction_cancel("extr_01G34H8J2K");
console.log(extraction.status);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
extraction, err := client.Extractions.CreateCancel(context.Background(), "extr_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(extraction.Status)
}
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 extraction = client.extractions().createCancel("extr_01G34H8J2K");
System.out.println(extraction.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
extraction = client.extractions.create_extraction_cancel(extraction_id: 'extr_01G34H8J2K')
puts extraction.status
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 extraction = client.extractions().create_extraction_cancel("extr_01G34H8J2K").await?;
println!("{:?}", extraction.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$extraction = $client->extractions()->createExtractionCancel('extr_01G34H8J2K');
echo $extraction->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var extraction = await client.Extractions.CreateCancelAsync("extr_01G34H8J2K");
Console.WriteLine(extraction.Status);
curl -X POST \
'https://api.retab.com/v1/extractions/extr_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "extr_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "extraction 'extr_01G34H8J2K' not found"
}
Cancel Extraction
from retab import Retab
client = Retab()
extraction = client.extractions.create_extraction_cancel("extr_01G34H8J2K")
print(extraction.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const extraction = await client.extractions.create_extraction_cancel("extr_01G34H8J2K");
console.log(extraction.status);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
extraction, err := client.Extractions.CreateCancel(context.Background(), "extr_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(extraction.Status)
}
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 extraction = client.extractions().createCancel("extr_01G34H8J2K");
System.out.println(extraction.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
extraction = client.extractions.create_extraction_cancel(extraction_id: 'extr_01G34H8J2K')
puts extraction.status
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 extraction = client.extractions().create_extraction_cancel("extr_01G34H8J2K").await?;
println!("{:?}", extraction.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$extraction = $client->extractions()->createExtractionCancel('extr_01G34H8J2K');
echo $extraction->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var extraction = await client.Extractions.CreateCancelAsync("extr_01G34H8J2K");
Console.WriteLine(extraction.Status);
curl -X POST \
'https://api.retab.com/v1/extractions/extr_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "extr_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "extraction 'extr_01G34H8J2K' not found"
}
Extraction run (one created with background: true). Cancellation is idempotent: a run that has already reached a terminal state (completed, failed, or cancelled) is returned unchanged rather than erroring.
from retab import Retab
client = Retab()
extraction = client.extractions.create_extraction_cancel("extr_01G34H8J2K")
print(extraction.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const extraction = await client.extractions.create_extraction_cancel("extr_01G34H8J2K");
console.log(extraction.status);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
extraction, err := client.Extractions.CreateCancel(context.Background(), "extr_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(extraction.Status)
}
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 extraction = client.extractions().createCancel("extr_01G34H8J2K");
System.out.println(extraction.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
extraction = client.extractions.create_extraction_cancel(extraction_id: 'extr_01G34H8J2K')
puts extraction.status
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 extraction = client.extractions().create_extraction_cancel("extr_01G34H8J2K").await?;
println!("{:?}", extraction.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$extraction = $client->extractions()->createExtractionCancel('extr_01G34H8J2K');
echo $extraction->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var extraction = await client.Extractions.CreateCancelAsync("extr_01G34H8J2K");
Console.WriteLine(extraction.Status);
curl -X POST \
'https://api.retab.com/v1/extractions/extr_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "extr_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "extraction 'extr_01G34H8J2K' not found"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
A stored extraction record from the Retab API.
Unique identifier of the extraction
Information about the extracted file
Show child attributes
Show child attributes
Model used for the extraction
JSON schema used for the extraction
The extracted structured data
Number of consensus votes used
DPI used to render document images
Free-form instructions supplied with the extraction 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
Consensus metadata for multi-vote extraction runs
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Usage information for the extraction
Show child attributes
Show child attributes