Rivier/ Reference/ agents

The agents

get/workspace/agents

Before you call

Credential
Authorization: Bearer $KEY
Scope
agents:read
Graphql
Query.agentsAgentList
Sdk
agents.agent.list
Cli
agents agent list

Responses

  • 200application/json
    Success
    • agentslist of objectrequired
      • idstringrequired
      • namestringrequired
      • jobstringrequired
      • remitstringrequired
      • mailboxstring or nullrequired
      • connectionIdstring or nullrequired
      • phoneConnectionIdstring or nullrequired
      • voicestring or nullrequired
      • tonestringrequired
      • signaturestringrequired
      • serviceslist of stringrequired
      • modestringrequired
      • dailyCapnumber or nullrequired
      • confidenceFloornumber or nullrequired
      • initialsstringrequired
      • accentstring or nullrequired
      • createdAtstringrequired
      • updatedAtstringrequired
  • 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

This page as Markdown