cURL
curl --request POST \
--url https://app.getpaperjet.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"configuration": {
"objects": [
{
"name": "<string>",
"description": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"tables": [
{
"name": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
]
}
]
},
"description": ""
}
'import requests
url = "https://app.getpaperjet.com/api/v1/workflows"
payload = {
"name": "<string>",
"configuration": { "objects": [
{
"name": "<string>",
"description": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"tables": [
{
"name": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
]
}
] },
"description": ""
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
configuration: {
objects: [
{
name: '<string>',
description: '<string>',
fields: [{name: '<string>', type: '<string>', description: '<string>'}],
tables: [
{
name: '<string>',
columns: [{name: '<string>', type: '<string>', description: '<string>'}],
description: '<string>'
}
]
}
]
},
description: ''
})
};
fetch('https://app.getpaperjet.com/api/v1/workflows', 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://app.getpaperjet.com/api/v1/workflows",
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([
'name' => '<string>',
'configuration' => [
'objects' => [
[
'name' => '<string>',
'description' => '<string>',
'fields' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>'
]
],
'tables' => [
[
'name' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>'
]
],
'description' => '<string>'
]
]
]
]
],
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://app.getpaperjet.com/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.getpaperjet.com/api/v1/workflows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.getpaperjet.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"workflowId": "<string>",
"message": "<string>"
}{
"error": "<string>"
}Workflows
Create a new workflow
Create a new workflow
POST
/
api
/
v1
/
workflows
cURL
curl --request POST \
--url https://app.getpaperjet.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"configuration": {
"objects": [
{
"name": "<string>",
"description": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"tables": [
{
"name": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
]
}
]
},
"description": ""
}
'import requests
url = "https://app.getpaperjet.com/api/v1/workflows"
payload = {
"name": "<string>",
"configuration": { "objects": [
{
"name": "<string>",
"description": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"tables": [
{
"name": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>"
}
]
}
] },
"description": ""
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
configuration: {
objects: [
{
name: '<string>',
description: '<string>',
fields: [{name: '<string>', type: '<string>', description: '<string>'}],
tables: [
{
name: '<string>',
columns: [{name: '<string>', type: '<string>', description: '<string>'}],
description: '<string>'
}
]
}
]
},
description: ''
})
};
fetch('https://app.getpaperjet.com/api/v1/workflows', 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://app.getpaperjet.com/api/v1/workflows",
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([
'name' => '<string>',
'configuration' => [
'objects' => [
[
'name' => '<string>',
'description' => '<string>',
'fields' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>'
]
],
'tables' => [
[
'name' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>'
]
],
'description' => '<string>'
]
]
]
]
],
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://app.getpaperjet.com/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.getpaperjet.com/api/v1/workflows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.getpaperjet.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"configuration\": {\n \"objects\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"tables\": [\n {\n \"name\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"workflowId": "<string>",
"message": "<string>"
}{
"error": "<string>"
}Was this page helpful?
⌘I
