Workers AI targeted single-node edit of an automation definition

Requires ADMIN. Returns either a modifiedDefinition to adopt or a clarify question; never writes journeys/versions or auto-publishes. 503 when AI binding absent.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

required

string

Automation (journey) identifier.

Request Body^required

application/json

object

instruction

required

string

>= 1 characters <= 500 characters

baseDefinition

required

Journey/automation graph definition. Nodes are typed (trigger/action/branch/wait/waitForEvent/timeWindow).

object

nodes

required

Array<object>

>= 1 items

object

key

additional properties

any

key

additional properties

any

targetNodeIdHint

string

>= 1 characters <= 80 characters

Example^generated

1
{
2
  "instruction": "example",
3
  "baseDefinition": {
4
    "nodes": [
5
      {}
6
    ]
7
  },
8
  "targetNodeIdHint": "example"
9
}

Responses

200

Either an edit result or a clarify question (discriminated by action).

application/json

object

action

string

Allowed values: edit clarify

draftId

string

targetNodeId

string

modifiedDefinition

Journey/automation graph definition. Nodes are typed (trigger/action/branch/wait/waitForEvent/timeWindow).

object

nodes

required

Array<object>

>= 1 items

object

key

additional properties

any

key

additional properties

any

changeSummary

string

diff

warnings

Array<string>

question

string

candidates

Array

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

404

Resource not found (or cross-tenant — same 404).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Param validation failed or edit invalid (error in [invalid_request, edit_invalid]); may include draftId.

application/json

object

error

required

string

message

string

errors

Array<string>

issues

Array<object>

object

key

additional properties

any

draftId

string

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "message": "example",
4
  "errors": [
5
    "example"
6
  ],
7
  "issues": [
8
    {}
9
  ],
10
  "draftId": "example"
11
}

503

Workers AI unavailable (error=ai_unavailable).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/projects/{projectId}/automations/{id}/ai-edit

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/ai-edit \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "instruction": "<string>",
7
  "baseDefinition": {
8
    "nodes": [
9
      {}
10
    ]
11
  },
12
  "targetNodeIdHint": "<string>"
13
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/ai-edit';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"instruction":"<string>","baseDefinition":{"nodes":[{}]},"targetNodeIdHint":"<string>"}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/ai-edit"
4

5
payload = {
6
    "instruction": "<string>",
7
    "baseDefinition": { "nodes": [{}] },
8
    "targetNodeIdHint": "<string>"
9
}
10
headers = {
11
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
12
    "Content-Type": "application/json"
13
}
14

15
response = requests.post(url, json=payload, headers=headers)
16

17
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/ai-edit"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"instruction\": \"<string>\",\n  \"baseDefinition\": {\n    \"nodes\": [\n      {}\n    ]\n  },\n  \"targetNodeIdHint\": \"<string>\"\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/ai-edit"
13

14
  payload := strings.NewReader("{\n  \"instruction\": \"<string>\",\n  \"baseDefinition\": {\n    \"nodes\": [\n      {}\n    ]\n  },\n  \"targetNodeIdHint\": \"<string>\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

200Either an edit result or a clarify question (discriminated by action ).

1
{
2
  "action": "edit"
3
}

Workers AI targeted single-node edit of an automation definition

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

403

Examplegenerated

404

Examplegenerated

422

Examplegenerated

503

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated