from retab import Retab
client = Retab()
classification = client.classifications.create_classification_cancel("clss_01G34H8J2K")
print(classification.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const classification = await client.classifications.create_classification_cancel("clss_01G34H8J2K");
console.log(classification.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)
}
classification, err := client.Classifications.CreateCancel(context.Background(), "clss_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(classification.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 classification = client.classifications().createCancel("clss_01G34H8J2K");
System.out.println(classification.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
classification = client.classifications.create_classification_cancel(classification_id: 'clss_01G34H8J2K')
puts classification.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 classification = client.classifications().create_classification_cancel("clss_01G34H8J2K").await?;
println!("{:?}", classification.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$classification = $client->classifications()->createClassificationCancel('clss_01G34H8J2K');
echo $classification->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var classification = await client.Classifications.CreateCancelAsync("clss_01G34H8J2K");
Console.WriteLine(classification.Status);
curl -X POST \
'https://api.retab.com/v1/classifications/clss_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "clss_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "classification 'clss_01G34H8J2K' not found"
}
Classifications
Cancel Classification
POST
/
v1
/
classifications
/
{classification_id}
/
cancel
from retab import Retab
client = Retab()
classification = client.classifications.create_classification_cancel("clss_01G34H8J2K")
print(classification.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const classification = await client.classifications.create_classification_cancel("clss_01G34H8J2K");
console.log(classification.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)
}
classification, err := client.Classifications.CreateCancel(context.Background(), "clss_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(classification.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 classification = client.classifications().createCancel("clss_01G34H8J2K");
System.out.println(classification.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
classification = client.classifications.create_classification_cancel(classification_id: 'clss_01G34H8J2K')
puts classification.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 classification = client.classifications().create_classification_cancel("clss_01G34H8J2K").await?;
println!("{:?}", classification.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$classification = $client->classifications()->createClassificationCancel('clss_01G34H8J2K');
echo $classification->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var classification = await client.Classifications.CreateCancelAsync("clss_01G34H8J2K");
Console.WriteLine(classification.Status);
curl -X POST \
'https://api.retab.com/v1/classifications/clss_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "clss_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "classification 'clss_01G34H8J2K' not found"
}
Cancel an in-flight background
Classification 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()
classification = client.classifications.create_classification_cancel("clss_01G34H8J2K")
print(classification.status)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const classification = await client.classifications.create_classification_cancel("clss_01G34H8J2K");
console.log(classification.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)
}
classification, err := client.Classifications.CreateCancel(context.Background(), "clss_01G34H8J2K")
if err != nil {
log.Fatal(err)
}
fmt.Println(classification.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 classification = client.classifications().createCancel("clss_01G34H8J2K");
System.out.println(classification.getStatus());
}
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
classification = client.classifications.create_classification_cancel(classification_id: 'clss_01G34H8J2K')
puts classification.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 classification = client.classifications().create_classification_cancel("clss_01G34H8J2K").await?;
println!("{:?}", classification.status);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$classification = $client->classifications()->createClassificationCancel('clss_01G34H8J2K');
echo $classification->status?->value . PHP_EOL;
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var classification = await client.Classifications.CreateCancelAsync("clss_01G34H8J2K");
Console.WriteLine(classification.Status);
curl -X POST \
'https://api.retab.com/v1/classifications/clss_01G34H8J2K/cancel' \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "clss_01G34H8J2K",
"status": "cancelled",
"error": null
}
{
"detail": "classification 'clss_01G34H8J2K' not found"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
A classification result: the categories a document was scored against and the chosen output decision.
Unique identifier of the classification
Information about the classified file
Show child attributes
Show child attributes
Model used for classification
Categories the document was classified against
Show child attributes
Show child attributes
Number of consensus votes used
Free-form instructions supplied with the classification request.
The classification result with reasoning. A degenerate empty decision until status == 'completed'; gate reads on status.
Show child attributes
Show child attributes
Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.
Available options:
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 classification runs
Show child attributes
Show child attributes
Usage information for the classification
Show child attributes
Show child attributes