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

Coveo Agent Configuration API API

The Agent Configuration API API from Coveo — 2 operation(s) for agent configuration api.

Coveo Agent Configuration API API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Agent Configuration API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

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

Requests are made against a single base URL, https://platform.cloud.coveo.com.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Agent Configuration API API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

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

Agent Configuration API 5
GET
/api/preview/organizations/{organizationId}/agents
List Agents
getByPage 3 params → 200
POST
/api/preview/organizations/{organizationId}/agents
Create an Agent
create 2 params body → 200
GET
/api/preview/organizations/{organizationId}/agents/{agentId}
Get an Agent by agentId
get 2 params → 200
DELETE
/api/preview/organizations/{organizationId}/agents/{agentId}
Delete an Agent
delete 2 params → 204
PATCH
/api/preview/organizations/{organizationId}/agents/{agentId}
Update an Agent
update 3 params body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Agent_Response (13 properties), Agent_Request (9 properties), Pagination_Response (4 properties), PaginatedResponseAgent_Response (2 properties). Each schema is shown below with its type and property counts.

Agent_Response
object
An agent configuration
13 properties 4 required
Agent_Request
object
An agent configuration
9 properties 4 required
Behavior_Request
object
A behavior that the agent should follow.
2 properties 2 required
AgentUpdate_Response
object
A partial agent update containing only the mutable metadata fields
2 properties
Behavior_Response
object
A behavior that the agent should follow.
2 properties 2 required
PaginatedResponseAgent_Response
object
2 properties
Pagination_Response
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-agent-configuration-api-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Coveo Built-in Groups API
Where this information came from

This is an independent, third-party profile of Coveo Agent Configuration API 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.