curl --request POST \
--url https://api.example.com/api/v2/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<unknown>",
"instructions": "<unknown>",
"metadata": "<unknown>",
"schema": "<unknown>"
}
'import requests
url = "https://api.example.com/api/v2/extractions"
payload = {
"document_id": "<unknown>",
"instructions": "<unknown>",
"metadata": "<unknown>",
"schema": "<unknown>"
}
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: '<unknown>',
instructions: '<unknown>',
metadata: '<unknown>',
schema: '<unknown>'
})
};
fetch('https://api.example.com/api/v2/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.example.com/api/v2/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' => '<unknown>',
'instructions' => '<unknown>',
'metadata' => '<unknown>',
'schema' => '<unknown>'
]),
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.example.com/api/v2/extractions"
payload := strings.NewReader("{\n \"document_id\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\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.example.com/api/v2/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/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\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}Post apiv2extractions
POST /api/v2/extractions and GET /api/v2/extractions (§9).
Required scope: extractions:create. A key without it is a 403 naming the scope; the endpoint is never silently skipped.
Idempotency. Send Idempotency-Key to make a retry safe.
- Same key, same body → the stored response, byte for byte, including its status. Some resources therefore replay 200 where the first call answered 201 or 202: the second call created nothing, and saying otherwise would be a lie a client acts on.
Idempotent-Replay: trueis on the replay, which is how a client answers “did my retry actually run?” from the response alone. The header is not spelled the same on every endpoint — this one usesIdempotent-Replay. Read each operation rather than assuming one name across the surface. - Same key, different body → 409
idempotency_conflict. Never a replay: returning the earlier answer for a request that does not match it turns a client-side key collision into a silently wrong result.
A key is scoped by endpoint, environment and caller identity — never by tenant alone, so two end users of one embedded application both sending Idempotency-Key: 1 cannot meet.
curl --request POST \
--url https://api.example.com/api/v2/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<unknown>",
"instructions": "<unknown>",
"metadata": "<unknown>",
"schema": "<unknown>"
}
'import requests
url = "https://api.example.com/api/v2/extractions"
payload = {
"document_id": "<unknown>",
"instructions": "<unknown>",
"metadata": "<unknown>",
"schema": "<unknown>"
}
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: '<unknown>',
instructions: '<unknown>',
metadata: '<unknown>',
schema: '<unknown>'
})
};
fetch('https://api.example.com/api/v2/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.example.com/api/v2/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' => '<unknown>',
'instructions' => '<unknown>',
'metadata' => '<unknown>',
'schema' => '<unknown>'
]),
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.example.com/api/v2/extractions"
payload := strings.NewReader("{\n \"document_id\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\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.example.com/api/v2/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/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\": \"<unknown>\",\n \"instructions\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"schema\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}Authorizations
A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.
Headers
A key of your own choosing, so a retry cannot create a second of anything. Replayable for 24 hours. An unfinished claim is released after 15 minutes, so a request that died mid-flight does not block its own retry.
255Body
The keys below are the ones this handler reads, taken from its source rather than from a serializer — these endpoints validate by hand and have no serializer to generate from. Their types and which are required are not pinned by this document; the endpoint answers 400 with a message naming the problem. Treat that as a gap to be closed by the owning batch, not as licence to send anything.
Response
Accepted. The work is queued: poll the job or the resource for its status rather than treating this as completion.

