Documentation by ClonePartner

Start typing to search.

API Reference

Create a job template

View Markdown
POST /api/job-templates

Create a job template

Operation IDcreateJobTemplate

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject
3 properties
namestringrequired
descriptionstring
yaml_contentstringrequired

Job template definition in YAML format (DAG of tasks + connectors)

Success response body

201Template created with DAG

Template created with DAG

Content typeapplication/json

responseobject
9 properties
idinteger
namestring
descriptionstring | null
Nullable
yes
yaml_contentstring
statusstring
Allowed values
active, archived
created_atstring · date-time
updated_atstring · date-time
dagobject | null
Nullable
yes
2 properties
tasksobject

Additional properties are allowed.

levelsarray<array<string>>
Array items
itemarray<string>
Array items
itemstring
connectorsobject | null
Nullable
yes
Additional properties
valueobject
1 property
typestring

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}