Create a job with a UUID

cURL

curl --request PUT \
  --url https://api.invopop.com/transform/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_id": "<string>",
  "args": {},
  "data": {},
  "key": "<string>",
  "silo_entry_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.invopop.com/transform/v1/jobs/{id}"

payload = {
    "workflow_id": "<string>",
    "args": {},
    "data": {},
    "key": "<string>",
    "silo_entry_id": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflow_id: '<string>',
    args: {},
    data: {},
    key: '<string>',
    silo_entry_id: '<string>',
    tags: ['<string>']
  })
};

fetch('https://api.invopop.com/transform/v1/jobs/{id}', 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.invopop.com/transform/v1/jobs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'workflow_id' => '<string>',
    'args' => [
        
    ],
    'data' => [
        
    ],
    'key' => '<string>',
    'silo_entry_id' => '<string>',
    'tags' => [
        '<string>'
    ]
  ]),
  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.invopop.com/transform/v1/jobs/{id}"

	payload := strings.NewReader("{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.invopop.com/transform/v1/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.invopop.com/transform/v1/jobs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "args": {},
  "attachments": [
    {
      "category": "version",
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "key": "pdf",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

{
  "args": {},
  "attachments": [
    {
      "category": "version",
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "key": "pdf",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

PUT

transform

jobs

{id}

cURL

curl --request PUT \
  --url https://api.invopop.com/transform/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_id": "<string>",
  "args": {},
  "data": {},
  "key": "<string>",
  "silo_entry_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.invopop.com/transform/v1/jobs/{id}"

payload = {
    "workflow_id": "<string>",
    "args": {},
    "data": {},
    "key": "<string>",
    "silo_entry_id": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflow_id: '<string>',
    args: {},
    data: {},
    key: '<string>',
    silo_entry_id: '<string>',
    tags: ['<string>']
  })
};

fetch('https://api.invopop.com/transform/v1/jobs/{id}', 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.invopop.com/transform/v1/jobs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'workflow_id' => '<string>',
    'args' => [
        
    ],
    'data' => [
        
    ],
    'key' => '<string>',
    'silo_entry_id' => '<string>',
    'tags' => [
        '<string>'
    ]
  ]),
  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.invopop.com/transform/v1/jobs/{id}"

	payload := strings.NewReader("{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.invopop.com/transform/v1/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.invopop.com/transform/v1/jobs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflow_id\": \"<string>\",\n  \"args\": {},\n  \"data\": {},\n  \"key\": \"<string>\",\n  \"silo_entry_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "args": {},
  "attachments": [
    {
      "category": "version",
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "key": "pdf",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

{
  "args": {},
  "attachments": [
    {
      "category": "version",
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "key": "pdf",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

Use this endpoint to execute a workflow with a specific time-based UUID, v7 or v1. If the key property is provided, it will be checked for uniqueness within the current workspace and is valid for up to 2 years. To execute a job, provide one of the following fields:

silo_entry_id - preferred, the UUID of the silo entry to process with the workflow.
data - raw GOBL data of the job, which will be persisted to the silo before processing.
args - a data object containing application-specific data used in the workflow’s initial actions to prepare and upload a silo entry.

Without wait, the response is 202 Accepted with the job’s initial state (status: "NA" and no intents yet); poll fetch a job until completed_at is set, or better, add a webhook step to the workflow. The wait query parameter can cause the server to block the incoming HTTP request and wait for up to the specified number of seconds. If the job completes within that time the response is 200 OK with the finished job, including its intents, faults and attachments; otherwise the 202 response is returned as usual. Typically, a workflow executes in under a second, but some actions may take longer. We recommend using the wait query parameter only in sandbox or testing environments, as workflows can sometimes exceed expected durations due to network failures or other temporary issues. Arguments (args) are composed of string key-value pairs tailored to specific applications. Binary data can be included using Data URIs (data:), which must specify the content type and include a name parameter. For example: data:text/plain;name=example.txt;base64,ZGF0YQ==. Any data provided via this method will be automatically uploaded to the Silo Spool service and will remain accessible only through tokens issued for the corresponding workspace.

Authorizations

Authorization

string

header

required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Path Parameters

string<uuid>

required

ID of the job to create.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

Query Parameters

wait

integer

Only for testing. Maximum number of seconds to block the http request waiting for the job to complete. When the job finishes within this time the response is 200 OK with the complete job; otherwise 202 Accepted is returned with the job's initial state. Do not use this in production.

Example:

60

Body

application/json

workflow_id

string

required

UUID of the workflow to execute for this job.

args

Args · object

Additional arguments that may be used by workflow actions. Binary data may be provided inside a Data URI, including the 'name' parameter.

data

Data · object

Raw JSON data of the GOBL Envelope or Object when the Silo Entry ID is empty.

key

string

Key to associate with the job for idempotency.

silo_entry_id

string

ID for the entry in the silo as an alternative for the raw data object.

Response

OK. Returned only when the wait parameter was provided and the job completed in time; the body is the finished job with its intents, faults and attachments.

args

Args · object

Any additional arguments that might be used by workflow actions.

Show child attributes

attachments

Attachments · object[]

Any files that have been generated while processing the job in the workflow will be here.

Show child attributes

completed_at

string

When this job was completed, will be nil if still ongoing.

created_at

string

When the job was created.

envelope

GOBL Envelope · object

Raw JSON data of the complete GOBL Envelope.

faults

Faults · object[]

Array of fault objects that represent errors that occurred during the processing of the job.

Show child attributes

string

The UUID v7 or v1 of the job

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

intents

Intents · object[]

Array of intent objects following the execution of each of the steps of the associated workflow.

Show child attributes

key

string

Key assigned to the job, used to identify it in the system.

silo_entry_id

string

Example:

"75fa764a-cdd0-11ed-afa1-0242ac120002"

status

string

Last known status text for this job.

API

Silo

Transform

Sequences

Access

Apps

Utils

Create a job with a UUID

Authorizations

Path Parameters

Query Parameters

Body

Response