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

The Answer API from Coveo — 1 operation(s) for answer.

Coveo Answer 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 Answers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 1 operation across 1 path, 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.

1 operations 1 paths 14 schemas 1 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
support@coveo.com
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Answer API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope.

  • oauth2 — OAuth2

Paths & Operations 1

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

Answer 1
POST
/rest/organizations/{organizationId}/answer/v1/configs/{configId}/generate
Get Answer
getAnswer 2 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are AnswerSearchRequest (29 properties), AnalyticsRequestParameters (17 properties), GenQAResponse (5 properties), ActionHistory (3 properties). Each schema is shown below with its type and property counts.

Tab
stringnull
The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates. Co…
GenQAResponse
object
5 properties 2 required
Timezone
stringnull
The [tz database](https://en.wikipedia.org/wiki/Listoftzdatabasetimezones) identifier of the time zone to use to correctly interpret dates in the query express…
MlParameters
objectnull
A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters: - considerUserContext (boolean): Whe…
ActionHistory
object
3 properties 2 required
Context
objectnull
The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is eit…
Locale
stringnull
The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition. Coveo Machine Learning models use thi…
AnalyticsRequestParameters
objectnull
17 properties
SearchHub
stringnull
The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates. Coveo Machine Learning…
PipelineRuleParameters
objectnull
This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic…
AnswerSearchRequest
object
29 properties
Referrer
stringnull
The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScr…
MaximumAge
integernull
The maximum age of cached results, in milliseconds. If the results of a specific request are available in the cache, and if those results are no older than the…
Pipeline
stringnull
The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty pipeline value to use an empty query pi…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-answer-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 Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 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 Answer 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.