API
- Introduction
- Authentication
- Idempotency
- Versioning
- Silo
- Transform
- Workflows
- Jobs
- Sequences
- Access
- Utils
Jobs
Create a job (non-idempotent)
Create a new job non-idempotently without an explicit UUID. Only recommended for testing purposes, production environments should use the PUT method.
POST
/
transform
/
v1
/
jobs
curl --request POST \
--url https://api.invopop.com/transform/v1/jobs \
--header 'Content-Type: application/json' \
--data '{
"data": {},
"silo_entry_id": "<string>",
"tags": [
"<string>"
],
"workflow_id": "<string>"
}'
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"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": [
{
"at": "2021-09-15T15:04:05.999Z",
"code": "<string>",
"index": 0,
"message": "<string>",
"status": "ERR"
}
],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "<string>"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}
This is a non-idempotent endpoint. It must be used for developing and testing only. In production, please use the idempotent version. More info here.
Query Parameters
Number of seconds to wait for the job to complete and provide a response.
Example:
60
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.invopop.com/transform/v1/jobs \
--header 'Content-Type: application/json' \
--data '{
"data": {},
"silo_entry_id": "<string>",
"tags": [
"<string>"
],
"workflow_id": "<string>"
}'
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"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": [
{
"at": "2021-09-15T15:04:05.999Z",
"code": "<string>",
"index": 0,
"message": "<string>",
"status": "ERR"
}
],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "<string>"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}
Assistant
Responses are generated using AI and may contain mistakes.