State or change the business goal

put/agents/assistant/business-goal

State or change the business goal: one sentence, with an optional measure and day. Only a person who administers the project does this; a key or an agent is refused.

Before you call

Credential: Authorization: Bearer $KEY
Scope: agents:write
Sdk: agents.assistant.businessGoalSet
Cli: agents assistant business goal set

Request bodyapplication/json, required

outcomestringrequired
At most 280 characters.
measurestring
At most 160 characters.
bystring

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X PUT 'https://api.rivier.ai/agents/assistant/business-goal' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "outcome": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown