Skip to content

CyclesController_create

POST
/api/cycles/streams/{streamId}/cycles
curl --request POST \
--url https://api.streams.chat/api/cycles/streams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cycles \
--header 'Content-Type: application/json' \
--data '{ "triggerName": "example", "description": "example", "phasesTemplate": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "agentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "goal": "example", "instructions": "example", "autoAdvance": true, "loopUntilGoalMet": true, "phaseName": "example", "operatorPool": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "operatorScope": "phase", "operatorStrategy": "random", "operatorAgentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "operatorAgentPrompt": "example", "assetIds": [], "sourcePhaseId": null } ], "source": { "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateVersion": 1 }, "graph": { "version": 1, "startNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultTarget": { "kind": "complete" }, "nodes": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "phase", "phaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "next": { "kind": "node", "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } } ] }, "expectedRevision": 1, "automatedTriggers": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "type": "time", "freq": "daily", "every": 1, "days": [ 1 ], "time": "example", "timezone": "example", "monthDay": 1, "monthDays": [], "month": 1, "active": true, "assigneePool": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "assignStrategy": "random", "agentId": null, "agentPrompt": null, "sourceTriggerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "message": "example" } ] }'
streamId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Media typeapplication/json
object
triggerName
required
string
/^[a-z0-9][a-z0-9-]{0,63}$/
description
required
string
nullable <= 5000 characters
phasesTemplate
required
Array<object>
<= 20 items
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
agentId
required
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
goal
required
string
<= 2000 characters
instructions
required
string
nullable <= 2000 characters
autoAdvance
required
boolean
loopUntilGoalMet
boolean
phaseName
required
string
nullable <= 80 characters
operatorPool
required
Array<string>
<= 100 items
operatorScope
string
default: phase
Allowed values: phase rest
operatorStrategy
string
Allowed values: random turns capacity agent
operatorAgentId
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
operatorAgentPrompt
string
nullable <= 1000 characters
assetIds
Array<string>
default: <= 10 items
sourcePhaseId
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
source
object
templateId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
templateVersion
required
integer
>= 1 <= 9007199254740991
graph
object
version
required
number
Allowed values: 1
startNodeId
required
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
defaultTarget
required
object
kind
required
string
Allowed values: complete
nodes
required
Array<object>
<= 40 items
One of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: phase
phaseId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
next
required
One of:
object
kind
required
string
Allowed values: node
nodeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
expectedRevision
integer
<= 9007199254740991
automatedTriggers
Array<object>
<= 10 items
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed values: time
freq
required
string
Allowed values: daily weekly monthly yearly
every
required
integer
>= 1 <= 99
days
required
Array<integer>
<= 7 items
time
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
timezone
required
string
>= 1 characters <= 64 characters
monthDay
required
integer
>= 1 <= 31
monthDays
Array<integer>
default: <= 31 items
month
required
integer
<= 11
active
required
boolean
assigneePool
required
Array<string>
<= 100 items
assignStrategy
required
string
Allowed values: random turns capacity agent
agentId
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
agentPrompt
string
nullable <= 1000 characters
sourceTriggerId
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
message
string
<= 40000 characters