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

GET

/v1/projects/{projectId}/web-sessions/agents

const url = 'https://service.testing.nairon.cloud/v1/projects/example/web-sessions/agents';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://service.testing.nairon.cloud/v1/projects/example/web-sessions/agents \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyHeader

Parameters

Path Parameters

projectId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

Responses

200

Default Response

application/json

object

webAgents

required

Array<object>

object

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

{
  "webAgents": [
    {
      "channel": "widget",
      "scopes": [
        "voice"
      ],
      "status": "active"
    }
  ]
}