Create an extraction job
curl --request POST \
--url https://api.trycactus.com/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<string>"
}
'import requests
url = "https://api.trycactus.com/v1/extractions"
payload = { "document_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_id: '<string>'})
};
fetch('https://api.trycactus.com/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trycactus.com/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trycactus.com/v1/extractions"
payload := strings.NewReader("{\n \"document_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trycactus.com/v1/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trycactus.com/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ext_01J9ZJYA",
"object": "<string>",
"documents": [
{
"document_id": "<string>",
"schema_version": "rent_roll.v1",
"billed": {
"rate_code": "rent_roll",
"units": 1,
"amount_usd": "12.00"
},
"error": {
"code": "<string>",
"message": "<string>"
}
}
],
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"billed_total_usd": "12.00",
"completed_at": "2023-11-07T05:31:56Z",
"result_url": "<string>"
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Extractions
Create an extraction job
Validates, accepts, and bills the referenced document(s), then starts
extraction. Submit either a single document_id or a bundle of
offering memorandum + rent roll + T-12 (billed at the bundle rate).
Validation failures for the document (size cap, unreadable file,
unresolvable type) reject the request with 422 and no charge.
POST
/
v1
/
extractions
Create an extraction job
curl --request POST \
--url https://api.trycactus.com/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<string>"
}
'import requests
url = "https://api.trycactus.com/v1/extractions"
payload = { "document_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_id: '<string>'})
};
fetch('https://api.trycactus.com/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trycactus.com/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trycactus.com/v1/extractions"
payload := strings.NewReader("{\n \"document_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trycactus.com/v1/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trycactus.com/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ext_01J9ZJYA",
"object": "<string>",
"documents": [
{
"document_id": "<string>",
"schema_version": "rent_roll.v1",
"billed": {
"rate_code": "rent_roll",
"units": 1,
"amount_usd": "12.00"
},
"error": {
"code": "<string>",
"message": "<string>"
}
}
],
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"billed_total_usd": "12.00",
"completed_at": "2023-11-07T05:31:56Z",
"result_url": "<string>"
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"title": "Document exceeds the size limit",
"status": 422,
"code": "document_over_size_cap",
"request_id": "<string>",
"type": "https://docs.trycactus.com/errors/document_over_size_cap",
"detail": "Files over 500 pages or 100 MB are rejected and not charged.",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Partner API key issued by Cactus.
Headers
Unique key making the request safely retryable.
Maximum string length:
255Body
application/json
Response
Accepted and billed; processing started.
Example:
"ext_01J9ZJYA"
Allowed value:
"extraction"Available options:
processing, completed, failed Show child attributes
Show child attributes
Example:
"12.00"
Convenience link to /v1/extractions/{id}/result; present when completed.
⌘I