How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Agents API

The Agents API from Webex — 7 operation(s) for agents.

Webex Agents API is one of 192 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 11 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

11 operations 11 paths 14 schemas 2 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Webex Agents API declares 5 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It accepts HTTP bearer tokens (BEARER_TOKEN_FROM_CI). It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • Bearer — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — JWT bearer token authentication. Obtain your token from the Webex Developer Portal.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 2 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Agents 11
POST
/v1/agents/login
Login
loginRoute body → 202400401403500503
PUT
/v1/agents/logout
Logout
logoutRoute body → 202400401403500503
PUT
/v1/agents/session/state
State Change
stateRoute body → 202400401403500503
POST
/v1/agents/reload
Reload
reloadRoute → 202401403500503
POST
/v1/agents/buddyList
Buddy Agents List
buddyAgentsRoute body → 202400401403500503
GET
/v1/agents/activities
Get Agent Activities
getAgentActivities 9 params → 200400401403413422500503
GET
/v1/agents/statistics
Get Agent Statistics
getDocumentByQueryParam 6 params → 200400401403422500503
POST
/v2/agents/login
Login
LoginRoute 1 param body → 202400401403500503
PUT
/v2/agents/logout
Logout
LogoutRoute 1 param body → 202400401403500503
PUT
/v2/agents/session/state
State Change
StateRoute 1 param body → 202400401403500503
POST
/v2/agents/reload
Reload
ReloadRoute 1 param → 202401403500503

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are AgentActivity (25 properties), ChannelResponse (12 properties), LogInResourceRequest (6 properties), OutAgentStatistics (6 properties). Each schema is shown below with its type and property counts.

LogInResourceRequest
object
6 properties 2 required
OutAgentStatistics
object
List of Agent Statistics records retrieved according to query parameters.
6 properties 1 required
ErrorDetails
object
Details of an error.
2 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
BuddyAgentRequest
object
Request payload to retrieve buddy agents.
3 properties 2 required
StateResourceRequest
object
Request payload to update an agent state.
4 properties 2 required
AgentApiResponse
object
Response wrapper for agent statistics.
2 properties 2 required
AgentActivitiesApiResponse
object
Response wrapper for agent activities.
2 properties 2 required
AgentActivity
object
List of agent activities retrieved according to query parameters.
25 properties 25 required
ChannelResponse
object
Statistics for a specific channel.
12 properties
LogOutResourceRequest
object
2 properties 1 required
Meta
object
Response metadata.
1 property
OperationError
object
An error message providing details about the operation failure.
1 property
AgentChannelStateChangeResourceRequest
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-agents-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
Webex Auto CSAT API
Where this information came from

This is an independent, third-party profile of Webex Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.