CyclesController_update

PUT

/api/cycles/streams/{streamId}/cycles/{cycleId}

curl --request PUT \
  --url https://api.streams-ai.com/api/cycles/streams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cycles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --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, "phaseName": "example", "operatorPool": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "assetIds": [], "sourcePhaseId": null } ], "source": { "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateVersion": 1 } }'

Parameters

Path Parameters

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)$/

cycleId

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)$/

Request Body^required

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

phaseName

required

string

nullable <= 80 characters

operatorPool

required

Array<string>

<= 100 items

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

Responses

200