curl --request POST \
--url https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"idempotency_key": "<string>",
"mode": "shape",
"shape": "<string>",
"file_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions"
payload = {
"idempotency_key": "<string>",
"mode": "shape",
"shape": "<string>",
"file_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
idempotency_key: '<string>',
mode: 'shape',
shape: '<string>',
file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
collection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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([
'idempotency_key' => '<string>',
'mode' => 'shape',
'shape' => '<string>',
'file_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'collection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions"
payload := strings.NewReader("{\n \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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 \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace": {
"id": "<string>",
"creation_origin": "<string>",
"name": "<string>",
"description": "<string>",
"status": "open",
"revision": 0,
"item_count": 0,
"shape": {
"shape_id": "<string>",
"artifact_digest": "<string>"
},
"bindings": [
{
"shape_id": "<string>",
"artifact_digest": "<string>"
}
],
"bridge_set": {
"digest": "<string>",
"declaration_count": 0
},
"created_at": "<string>",
"updated_at": "<string>",
"applied_at": "<string>",
"replaced_by": "<string>"
},
"run_id": "<string>",
"replayed": true,
"expected_revision": 0,
"execution_state": "<string>",
"shape": {
"shape_id": "<string>",
"artifact_digest": "<string>"
},
"source_count": 0,
"level": "fast",
"estimate": {
"schema": "penumbra.extraction-estimate",
"version": 1,
"expected_credit_micros": 123,
"high_credit_micros": 123,
"source_bytes": 123,
"calls": 123,
"billing": "elsewhere"
},
"lens": {
"kind": "<string>",
"lens_digest": "<string>",
"source_ontology_revision": "<string>",
"artifact_bindings": [
{
"shape_id": "<string>",
"artifact_digest": "<string>"
}
],
"bridge_set_digest": "<string>",
"project_bridge_set_digest": "<string>",
"type_count": 0,
"relationship_count": 0
},
"collection": {
"id": "<string>",
"revision": 0
}
}
}Start extraction
Start an extraction run over Files. It opens its own review workspace and returns it.
curl --request POST \
--url https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"idempotency_key": "<string>",
"mode": "shape",
"shape": "<string>",
"file_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions"
payload = {
"idempotency_key": "<string>",
"mode": "shape",
"shape": "<string>",
"file_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
idempotency_key: '<string>',
mode: 'shape',
shape: '<string>',
file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
collection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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([
'idempotency_key' => '<string>',
'mode' => 'shape',
'shape' => '<string>',
'file_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'collection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions"
payload := strings.NewReader("{\n \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.pnbr.io/v1/orgs/{org}/projects/{project}/graph/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnbr.io/v1/orgs/{org}/projects/{project}/graph/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 \"idempotency_key\": \"<string>\",\n \"mode\": \"shape\",\n \"shape\": \"<string>\",\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"collection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace": {
"id": "<string>",
"creation_origin": "<string>",
"name": "<string>",
"description": "<string>",
"status": "open",
"revision": 0,
"item_count": 0,
"shape": {
"shape_id": "<string>",
"artifact_digest": "<string>"
},
"bindings": [
{
"shape_id": "<string>",
"artifact_digest": "<string>"
}
],
"bridge_set": {
"digest": "<string>",
"declaration_count": 0
},
"created_at": "<string>",
"updated_at": "<string>",
"applied_at": "<string>",
"replaced_by": "<string>"
},
"run_id": "<string>",
"replayed": true,
"expected_revision": 0,
"execution_state": "<string>",
"shape": {
"shape_id": "<string>",
"artifact_digest": "<string>"
},
"source_count": 0,
"level": "fast",
"estimate": {
"schema": "penumbra.extraction-estimate",
"version": 1,
"expected_credit_micros": 123,
"high_credit_micros": 123,
"source_bytes": 123,
"calls": 123,
"billing": "elsewhere"
},
"lens": {
"kind": "<string>",
"lens_digest": "<string>",
"source_ontology_revision": "<string>",
"artifact_bindings": [
{
"shape_id": "<string>",
"artifact_digest": "<string>"
}
],
"bridge_set_digest": "<string>",
"project_bridge_set_digest": "<string>",
"type_count": 0,
"relationship_count": 0
},
"collection": {
"id": "<string>",
"revision": 0
}
}
}http.graph.extractions.start
POST /v1/orgs/{org}/projects/{project}/graph/extractions
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- Option 1
- Option 2
Caller-chosen key for this extraction. Repeating the same key replays the same admitted run instead of paying for a second one.
1 - 200"shape"The one published Shape name or id whose complete analytical perspective governs this operation.
1 - 200Native File UUIDs from list_files or search_files. Each File's current version and extracted text are pinned at admission; never a Workspace path. Give exactly one of file_ids or collection_id.
1 - 256 elements^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$A Files collection to extract from, in place of file_ids. The collection's Files and their current versions are read once when the extraction starts; Files added or changed later are not part of this run. Give exactly one of file_ids or collection_id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$How thorough: standard (items are double-checked before you review them) or fast (one read, no double-check). Omit for the project's default.
standard, fast, deep Response
Success.
- Option 1
- Option 2
Show child attributes
Show child attributes