from retab import Retab
client = Retab()
partition = client.partitions.create_partition_cancel("prtn_01G34H8J2K")
print(partition.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const partition = await client.partitions.create_partition_cancel("prtn_01G34H8J2K");
console.log(partition.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)
}
partition, err := client.Partitions.CreateCancel(context.Background(), "prtn_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(partition.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 partition = client.partitions().createCancel("prtn_01G34H8J2K");
System.out.println(partition.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
partition = client.partitions.create_partition_cancel(partition_id: 'prtn_01G34H8J2K')
puts partition.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 partition = client.partitions().create_partition_cancel("prtn_01G34H8J2K").await?;
println!("{:?}", partition.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$partition = $client->partitions()->createPartitionCancel('prtn_01G34H8J2K');
echo $partition->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var partition = await client.Partitions.CreateCancelAsync("prtn_01G34H8J2K");
Console.WriteLine(partition.Status);
curl -X POST \
'https://api.retab.com/v1/partitions/prtn_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "prtn_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "partition 'prtn_01G34H8J2K' not found"
}
Cancel Partition
from retab import Retab
client = Retab()
partition = client.partitions.create_partition_cancel("prtn_01G34H8J2K")
print(partition.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const partition = await client.partitions.create_partition_cancel("prtn_01G34H8J2K");
console.log(partition.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)
}
partition, err := client.Partitions.CreateCancel(context.Background(), "prtn_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(partition.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 partition = client.partitions().createCancel("prtn_01G34H8J2K");
System.out.println(partition.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
partition = client.partitions.create_partition_cancel(partition_id: 'prtn_01G34H8J2K')
puts partition.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 partition = client.partitions().create_partition_cancel("prtn_01G34H8J2K").await?;
println!("{:?}", partition.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$partition = $client->partitions()->createPartitionCancel('prtn_01G34H8J2K');
echo $partition->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var partition = await client.Partitions.CreateCancelAsync("prtn_01G34H8J2K");
Console.WriteLine(partition.Status);
curl -X POST \
'https://api.retab.com/v1/partitions/prtn_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "prtn_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "partition 'prtn_01G34H8J2K' not found"
}
Partition 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()
partition = client.partitions.create_partition_cancel("prtn_01G34H8J2K")
print(partition.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const partition = await client.partitions.create_partition_cancel("prtn_01G34H8J2K");
console.log(partition.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)
}
partition, err := client.Partitions.CreateCancel(context.Background(), "prtn_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(partition.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 partition = client.partitions().createCancel("prtn_01G34H8J2K");
System.out.println(partition.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
partition = client.partitions.create_partition_cancel(partition_id: 'prtn_01G34H8J2K')
puts partition.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 partition = client.partitions().create_partition_cancel("prtn_01G34H8J2K").await?;
println!("{:?}", partition.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$partition = $client->partitions()->createPartitionCancel('prtn_01G34H8J2K');
echo $partition->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var partition = await client.Partitions.CreateCancelAsync("prtn_01G34H8J2K");
Console.WriteLine(partition.Status);
curl -X POST \
'https://api.retab.com/v1/partitions/prtn_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "prtn_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "partition 'prtn_01G34H8J2K' not found"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
A partition result: a document segmented into chunks along the requested key.
Unique identifier of the partition
Information about the partitioned file
Show child attributes
Show child attributes
Model used for the partition operation
Partition key used for the run
Free-form instructions supplied with the partition request
Number of consensus votes used
Whether pages were allowed to appear in more than one partition chunk
The list of partition chunks with their assigned pages. Empty [] until status == 'completed'.
Show child attributes
Show child attributes
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 partition runs
Show child attributes
Show child attributes
Usage information for the partition operation
Show child attributes
Show child attributes