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 In-App API

The In-App API from Coveo — 6 operation(s) for in-app.

Coveo In-App 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 In-App. 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 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

6 operations 6 paths 13 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Coveo In-App API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the implicit flow, exposing 1 scope.

Paths & Operations 6

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

In-App 6
POST
/rest/organizations/{organizationID}/pages/inappwidget
Create InAppWidget
1 param body → 200400401500
PUT
/rest/organizations/{organizationID}/pages/inappwidget/{pageID}
Update InAppWidget
2 params body → 204400401500
GET
/rest/organizations/{organizationID}/pages/inappwidgets
List InAppWidgets
2 params → 200400401403500
POST
/rest/organizations/{organizationID}/pages/inappwidgets/ids
List InAppWidgets by Ids
1 param body → 200400401403500
GET
/rest/organizations/{organizationID}/pages/inappwidgets/projectid
List InAppWidgets by Project ID
2 params → 200400401403500
GET
/rest/organizations/{organizationID}/pages/{pageID}/inappwidget/loader
Get InAppWidget Loader
3 params → 200400403404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are swaggermodels.FullInAppWidgetRequestModel (18 properties), swaggermodels.InAppWidgetCreateResponseBody (7 properties), swaggermodels.searchTokenConfigurationResponseModel (7 properties), swaggermodels.JavaScriptResourceSharedModel (3 properties). Each schema is shown below with its type and property counts.

swaggermodels.userIDResponseModel
object
2 properties
swaggermodels.CSSResourceSharedModel
object
3 properties
swaggermodels.InAppWidgetCreateResponseBody
object
7 properties 2 required
swaggermodels.ResponseApplicationErrorInternalServerError
object
2 properties
swaggermodels.ResponseApplicationErrorForbidden
object
2 properties
swaggermodels.buttonJavaScriptResponseModel
object
3 properties
swaggermodels.buttonCSSResponseModel
object
3 properties
swaggermodels.searchTokenConfigurationResponseModel
object
7 properties 2 required
swaggermodels.JavaScriptResourceSharedModel
object
3 properties
swaggermodels.ResponseApplicationErrorBadRequest
object
2 properties
swaggermodels.ResponseApplicationErrorUnauthorized
object
2 properties
swaggermodels.ResponseApplicationErrorNotFound
object
2 properties
swaggermodels.FullInAppWidgetRequestModel
object
18 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-in-app-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 In-App 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.