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

The Rest API from Coveo — 6 operation(s) for rest.

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

This API exposes 6 operations across 6 paths, and defines 9 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.

6 operations 6 paths 9 schemas 5 GET1 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 Rest API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — This API uses OAuth 2 with the implicit grant flow

Paths & Operations 6

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

Rest 6
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/html
Retrieve Search Page Interface
get-search-page-interface-html 2 params → 200404
POST
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/manifest
Retrieve Search Page Manifest
get-search-page-manifest-v1 2 params body → 200404
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/token
Get Search Page Search Token
get-search-page-interface-token 2 params → 200
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/edit
Get Search Page Interface Builder
get-search-page-interface-edit 2 params → 200
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/loader
Get Search Page Interface Loader
get-search-page-interface-loader 2 params → 200404
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/login
Get Search Page Interface Login
get-search-page-interface-login 1 param → 200404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are interface-config (7 properties), interface-access (4 properties), interface-manifest (4 properties), interface-manifest-results (3 properties). Each schema is shown below with its type and property counts.

interface-config
object
7 properties 1 required
interface-manifest-results
object
The Atomic results configuration information.
3 properties
interface-manifest-result-template
object
The Atomic result template configuration information.
2 properties
interface-content
object
2 properties
interface-manifest
object
4 properties 4 required
interface-user-list
array
The list of users that are allowed to access the search interface.
interface-manifest-request
object
1 property
interface-access
object
4 properties
interface-manifest-style
object
The Atomic related styling in CSS format.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-rest-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 Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

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