Skip to main content
POST
/
automations
Create Automation
curl --request POST \
  --url https://api.example.com/automations/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "current_version": {
    "steps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_type": "START",
        "prompt_template": {
          "type": "<string>"
        }
      }
    ],
    "step_transitions": [
      {
        "source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>"
      }
    ]
  }
}
'
{
  "name": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "<string>",
  "current_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "steps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_type": "START",
        "prompt_template": {
          "type": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "step_transitions": [
      {
        "source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Api-key
string | null

Body

application/json
​
name
string
required
​
description
string
required
​
current_version
AutomationVersionCreate · object
required

Response

Successful Response

​
name
string
required
​
description
string
required
​
id
string<uuid>
required
​
organisation_id
string
required
​
current_version
AutomationVersionRead · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required