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

Manage streams

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

This API exposes 12 operations across 12 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 2016-03-03T13:22:11Z.

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

12 operations 12 paths 4 schemas 8 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2016-03-03T13:22:11Z
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 12

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

Stream 12

Manage streams

POST
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/deleteolderthan/{epochMilliseconds}
Delete Old Documents
4 params → 201400401403404412415429
PUT
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/merge
Merge Entities of a Data Collection
3 params → 202400401403404412415429
POST
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/open
Open a Stream
2 params → 201400401403404412415429
PUT
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/update
Update Entities of a Data Collection
4 params → 202400401403404412415429
POST
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/{streamId}/chunk
Get a New Chunk for a Stream
3 params → 200400401403404412415429
POST
/organizations/{organizationId}/data-collections/{dataCollectionId}/stream/{streamId}/close
Close a Stream
3 params → 200400401403404412415429
POST
/organizations/{organizationId}/sources/{sourceId}/stream/deleteolderthan/{epochMilliseconds}
Delete Old Documents
4 params → 201400401403404412415429
PUT
/organizations/{organizationId}/sources/{sourceId}/stream/merge
Merge Documents of a Catalog Stream Source
3 params → 202400401403404412415429
POST
/organizations/{organizationId}/sources/{sourceId}/stream/open
Open a Stream
2 params → 201400401403404412415429
PUT
/organizations/{organizationId}/sources/{sourceId}/stream/update
Update a Catalog Stream Source
4 params → 202400401403404412415429
POST
/organizations/{organizationId}/sources/{sourceId}/stream/{streamId}/chunk
Get a New Chunk for a Stream
3 params → 200400401403404412415429
POST
/organizations/{organizationId}/sources/{sourceId}/stream/{streamId}/close
Close a Stream
3 params → 200400401403404412415429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are OpenStreamOutArgs (4 properties), ChunkOutArgs (3 properties), CatalogStreamOutArgs (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

ChunkOutArgs
object
3 properties
Error
object
2 properties
OpenStreamOutArgs
object
4 properties
CatalogStreamOutArgs
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-stream-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 Stream 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.