Skip to content
NaironNairon Docs

/v1/projects/{projectId}/web-sessions/agents (POST)

POST
/v1/projects/{projectId}/web-sessions/agents
curl --request POST \
  --url https://service.testing.nairon.cloud/v1/projects/example/web-sessions/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "conversationId": "example", "channel": "widget", "scopes": [ "voice" ], "allowedOrigins": [] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 200 characters
conversationId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
channel
string
default: widget
Allowed values: widget api
scopes
required
Array<string>
>= 1 items
Allowed values: voice chat
allowedOrigins
Array<string>
default:

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
id
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
projectId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
name
required
string
channel
required
string
Allowed values: widget api
scopes
required
Array<string>
Allowed values: voice chat
allowedOrigins
required
Array<string>
conversationId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
status
required
string
Allowed values: active disabled
Example
{
  "channel": "widget",
  "scopes": [
    "voice"
  ],
  "status": "active"
}