AgentsController_update

PATCH

/api/agents/{id}

curl --request PATCH \
  --url https://api.streams-ai.com/api/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "avatarAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "streamBot": { "version": 1, "shape": "cloud", "color": "purple", "background": "blue" }, "endpointUrl": "https://example.com", "status": "active", "capabilities": { "streaming": false, "tools": [] }, "invitePolicy": "everyone", "interactPolicy": "everyone" }'

Parameters

Path Parameters

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

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 120 characters

avatarAssetId

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

streamBot

object

version

required

number

Allowed values: 1

shape

required

string

Allowed values: cloud splat heart triangle snowman dome worm spark archie fin peanut nub cubes clover kidney spider stream wave

color

required

string

Allowed values: purple blue coral teal yellow pink lavender orange eggWhite ink green red

background

required

string

Allowed values: blue orange yellow pink green lavender cream navy white

endpointUrl

string format: uri

<= 2048 characters

status

string

Allowed values: active paused

capabilities

object

streaming

boolean

tools

Array<string>

default: <= 50 items

invitePolicy

string

Allowed values: everyone owner_only approval_required

interactPolicy

string

Allowed values: everyone owner_only approval_required

Responses

200