Skip to main content
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"
    }
  }
}
'
{
  "job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.deck.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-deck-client-id
string
header
required

Enter your client id

​
x-deck-secret
string
header
required

Enter your secret

Headers

​
x-deck-correlation-id
string<uuid>
​
x-deck-sandbox
string

Enterprise only. Can be used against the sandbox API with special values to test error use cases.

Body

application/json
​
job_code
string
required

The job type identifier

Example:

"FetchDocuments"

​
input
object
required

Dynamic input object - structure varies by job type

Example:
{
  "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
  "key1": "value1",
  "someNumber": 123.45,
  "someBoolean": true,
  "someArray": ["a", "b"],
  "nestedObject": { "k": "v" }
}

Response

Accepted

​
job_guid
string<uuid>
​
job_code
string