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 Orchestration API API

The Agent Orchestration API API from Coveo — 2 operation(s) for agent orchestration api.

Coveo Agent Orchestration 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 Orchestration 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 2 operations across 2 paths, and defines 14 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.

2 operations 2 paths 14 schemas 2 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 Orchestration 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 2

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

Agent Orchestration API 2
POST
/api/preview/organizations/{organizationId}/agents/{agentId}/follow-up
Generates an Answer to the Follow-Up Question for the Given Configuration
followUp 2 params body → 200
POST
/api/preview/organizations/{organizationId}/agents/{agentId}/answer
Generates an Answer for the Given Configuration
answer 2 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Analytics_Request (16 properties), HierarchicalFacetRequest_Request (14 properties), NumericalRangeFacetRequest_Request (14 properties), CompositeModelAnswerPayload_Request (13 properties). Each schema is shown below with its type and property counts.

HierarchicalFacetValue_Request
object
A hierarchical facet value.
7 properties
HierarchicalFacetRequest_Request
object
Request facet values representing hierarchically structured categories.
14 properties
NumericalRangeFacetValue_Request
object
A numerical range facet value.
6 properties
DateRangeFacetRequest_Request
object
Request facet values representing ranges of dates.
13 properties
AnalyticsCommerce_Request
objectnull
Commerce context for the analytics.
2 properties 2 required
Analytics_Request
objectnull
Analytics parameters to forward to the search API.
16 properties
SpecificFacetRequest_Request
object
Request facet values representing specific values (e.g., Alice Smith, Bob Jones, etc.).
13 properties
SpecificFacetValue_Request
object
A specific facet value.
4 properties
DateRangeFacetValue_Request
object
A date range facet value.
6 properties
SseEmitter_Response
object
1 property
CompositeModelFollowUpPayload_Request
object
Payload for sending a follow-up question to the agent.
4 properties 3 required
NumericalRangeFacetRequest_Request
object
Request facet values representing ranges of numbers.
14 properties
FacetRequest_Request
object
A facet request. The type property determines the kind of facet values to request.
1 property 1 required
CompositeModelAnswerPayload_Request
object
Payload for getting an answer from an agent.
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-agent-orchestration-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 Configuration 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 Orchestration 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.