Run a Job
curl --request POST \
--url https://live.deck.co/api/v1/jobs/submit \
--header 'Content-Type: application/json' \
--header 'x-deck-client-id: <api-key>' \
--header 'x-deck-secret: <api-key>' \
--data '
{
"job_code": "FetchDocuments",
"input": {
"access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
"key1": "value1",
"someNumber": 123.45,
"someBoolean": true,
"someArray": [
"a",
"b"
],
"nestedObject": {
"k": "v"
}
}
}
'import requests
url = "https://live.deck.co/api/v1/jobs/submit"
payload = {
"job_code": "FetchDocuments",
"input": {
"access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
"key1": "value1",
"someNumber": 123.45,
"someBoolean": True,
"someArray": ["a", "b"],
"nestedObject": { "k": "v" }
}
}
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-deck-client-id': '<api-key>',
'x-deck-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
job_code: 'FetchDocuments',
input: {
access_token: 'access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7',
key1: 'value1',
someNumber: 123.45,
someBoolean: true,
someArray: ['a', 'b'],
nestedObject: {k: 'v'}
}
})
};
fetch('https://live.deck.co/api/v1/jobs/submit', 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://live.deck.co/api/v1/jobs/submit",
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([
'job_code' => 'FetchDocuments',
'input' => [
'access_token' => 'access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7',
'key1' => 'value1',
'someNumber' => 123.45,
'someBoolean' => true,
'someArray' => [
'a',
'b'
],
'nestedObject' => [
'k' => 'v'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-deck-client-id: <api-key>",
"x-deck-secret: <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://live.deck.co/api/v1/jobs/submit"
payload := strings.NewReader("{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<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://live.deck.co/api/v1/jobs/submit")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/jobs/submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_code": "<string>"
}{
"error_message": "<string>",
"message": "<string>"
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"error_message": "<string>"
}Jobs
Run a Job
Runs a job with the specified parameters and returns a job ID for tracking its status.
POST
/
jobs
/
submit
Run a Job
curl --request POST \
--url https://live.deck.co/api/v1/jobs/submit \
--header 'Content-Type: application/json' \
--header 'x-deck-client-id: <api-key>' \
--header 'x-deck-secret: <api-key>' \
--data '
{
"job_code": "FetchDocuments",
"input": {
"access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
"key1": "value1",
"someNumber": 123.45,
"someBoolean": true,
"someArray": [
"a",
"b"
],
"nestedObject": {
"k": "v"
}
}
}
'import requests
url = "https://live.deck.co/api/v1/jobs/submit"
payload = {
"job_code": "FetchDocuments",
"input": {
"access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
"key1": "value1",
"someNumber": 123.45,
"someBoolean": True,
"someArray": ["a", "b"],
"nestedObject": { "k": "v" }
}
}
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-deck-client-id': '<api-key>',
'x-deck-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
job_code: 'FetchDocuments',
input: {
access_token: 'access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7',
key1: 'value1',
someNumber: 123.45,
someBoolean: true,
someArray: ['a', 'b'],
nestedObject: {k: 'v'}
}
})
};
fetch('https://live.deck.co/api/v1/jobs/submit', 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://live.deck.co/api/v1/jobs/submit",
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([
'job_code' => 'FetchDocuments',
'input' => [
'access_token' => 'access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7',
'key1' => 'value1',
'someNumber' => 123.45,
'someBoolean' => true,
'someArray' => [
'a',
'b'
],
'nestedObject' => [
'k' => 'v'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-deck-client-id: <api-key>",
"x-deck-secret: <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://live.deck.co/api/v1/jobs/submit"
payload := strings.NewReader("{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<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://live.deck.co/api/v1/jobs/submit")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/jobs/submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"job_code\": \"FetchDocuments\",\n \"input\": {\n \"access_token\": \"access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7\",\n \"key1\": \"value1\",\n \"someNumber\": 123.45,\n \"someBoolean\": true,\n \"someArray\": [\n \"a\",\n \"b\"\n ],\n \"nestedObject\": {\n \"k\": \"v\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_code": "<string>"
}{
"error_message": "<string>",
"message": "<string>"
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"error_message": "<string>"
}Authorizations
Enter your client id
Enter your secret
Headers
Enterprise only. Can be used against the sandbox API with special values to test error use cases.
Body
application/json
The job type identifier
Example:
"FetchDocuments"
Dynamic input object - structure varies by job type
Show child attributes
Show child attributes
Example:
{
"access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
"key1": "value1",
"someNumber": 123.45,
"someBoolean": true,
"someArray": ["a", "b"],
"nestedObject": { "k": "v" }
}
Was this page helpful?
⌘I