Add file
curl --request POST \
--url https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"upload_id": "<string>",
"name": "<string>",
"description": "<unknown>",
"tags": "<unknown>",
"metadata": "<unknown>",
"external_key": "<unknown>",
"upload_batch_id": "<unknown>",
"source_date": "<unknown>"
}
'import requests
url = "https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files"
payload = {
"upload_id": "<string>",
"name": "<string>",
"description": "<unknown>",
"tags": "<unknown>",
"metadata": "<unknown>",
"external_key": "<unknown>",
"upload_batch_id": "<unknown>",
"source_date": "<unknown>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
upload_id: '<string>',
name: '<string>',
description: '<unknown>',
tags: '<unknown>',
metadata: '<unknown>',
external_key: '<unknown>',
upload_batch_id: '<unknown>',
source_date: '<unknown>'
})
};
fetch('https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files', 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}/files",
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([
'upload_id' => '<string>',
'name' => '<string>',
'description' => '<unknown>',
'tags' => '<unknown>',
'metadata' => '<unknown>',
'external_key' => '<unknown>',
'upload_batch_id' => '<unknown>',
'source_date' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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}/files"
payload := strings.NewReader("{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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}/files")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "<string>",
"outcome": "queued",
"replayed": true,
"data": {
"kind": "file_ingest",
"mode": "managed_admission",
"outcome": "queued",
"replayed": true,
"request_id": "<string>",
"upload_id": "<string>",
"file_operation_id": "<string>",
"filename": "<string>",
"media_type": "<string>",
"operation": {
"kind": "ingest_file",
"status": "queued",
"stage": "validate_input"
},
"timings_ms": {}
}
}Files
Add file
Admit an uploaded File into the project.
Add file
curl --request POST \
--url https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"upload_id": "<string>",
"name": "<string>",
"description": "<unknown>",
"tags": "<unknown>",
"metadata": "<unknown>",
"external_key": "<unknown>",
"upload_batch_id": "<unknown>",
"source_date": "<unknown>"
}
'import requests
url = "https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files"
payload = {
"upload_id": "<string>",
"name": "<string>",
"description": "<unknown>",
"tags": "<unknown>",
"metadata": "<unknown>",
"external_key": "<unknown>",
"upload_batch_id": "<unknown>",
"source_date": "<unknown>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
upload_id: '<string>',
name: '<string>',
description: '<unknown>',
tags: '<unknown>',
metadata: '<unknown>',
external_key: '<unknown>',
upload_batch_id: '<unknown>',
source_date: '<unknown>'
})
};
fetch('https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files', 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}/files",
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([
'upload_id' => '<string>',
'name' => '<string>',
'description' => '<unknown>',
'tags' => '<unknown>',
'metadata' => '<unknown>',
'external_key' => '<unknown>',
'upload_batch_id' => '<unknown>',
'source_date' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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}/files"
payload := strings.NewReader("{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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}/files")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnbr.io/v1/orgs/{org}/projects/{project}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upload_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<unknown>\",\n \"tags\": \"<unknown>\",\n \"metadata\": \"<unknown>\",\n \"external_key\": \"<unknown>\",\n \"upload_batch_id\": \"<unknown>\",\n \"source_date\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "<string>",
"outcome": "queued",
"replayed": true,
"data": {
"kind": "file_ingest",
"mode": "managed_admission",
"outcome": "queued",
"replayed": true,
"request_id": "<string>",
"upload_id": "<string>",
"file_operation_id": "<string>",
"filename": "<string>",
"media_type": "<string>",
"operation": {
"kind": "ingest_file",
"status": "queued",
"stage": "validate_input"
},
"timings_ms": {}
}
}Operation ID:
http.files.admit
POST /v1/orgs/{org}/projects/{project}/files
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
1–200 printable ASCII characters, no surrounding spaces; '.' and '..' are reserved. Reuse this key with the same request when retrying an uncertain outcome.
Required string length:
1 - 200Pattern:
^(?!\.{1,2}$)[!-~](?:[ -~]*[!-~])?$Body
application/json
Text of at most 4096 bytes, or null.
At most 64 strings of 1 to 128 characters.
A JSON object of at most 16 KiB.
1 to 512 characters, or null.
The upload batch (one drop of files) this File belongs to, from POST …/files/upload-batches. The batch holds the drop's note.
YYYY, YYYY-MM, YYYY-MM-DD or an RFC 3339 date-time with an offset.