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

Oracle Stream API

The stream API from Oracle — 6 operation(s) for stream.

Oracle Stream API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Stream. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 20180418.

Requests are made against a single base URL, https://streaming.{region}.oci.oraclecloud.com/20180418.

8 operations 6 paths 12 schemas 2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20180418
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 8

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

stream 8
POST
/streams/{streamId}/commit
Commits processed offsets to consumer group state.
ConsumerCommit 3 params → 200400401404429500default
POST
/streams/{streamId}/cursors
Creates a cursor for the specified stream. A cursor is used to consume a stream.
CreateCursor 2 params body → 200400401429500default
POST
/streams/{streamId}/groupCursors
Creates a group-cursor for the specified stream. A cursor is used to consume a stream.
CreateGroupCursor 2 params body → 200400401404429500default
GET
/streams/{streamId}/groups/{groupName}
Returns the current state of a consumer group.
GetGroup 3 params → 200400401404429500default
PUT
/streams/{streamId}/groups/{groupName}
Forcefully changes the committed location of a group on a stream.
UpdateGroup 3 params body → 200400401429500default
POST
/streams/{streamId}/heartbeat
Extends the reservation timeout on partitions reserved by the provided cursor.
ConsumerHeartbeat 3 params → 200400401404429500default
GET
/streams/{streamId}/messages
Gets messages from a stream.
GetMessages 4 params → 200400401404429500default
POST
/streams/{streamId}/messages
Puts messages in a stream.
PutMessages 2 params body → 200400401404429500default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Message (6 properties), CreateGroupCursorDetails (6 properties), PutMessagesResultEntry (5 properties), CreateCursorDetails (4 properties). Each schema is shown below with its type and property counts.

PartitionReservation
object
Represents the state of a single partition reservation.
4 properties
PutMessagesDetails
object
Object that represents an array of messages to emit to a stream.
1 property 1 required
PutMessagesResult
object
The response to a [PutMessages](/en/streaming/20180418/methods/PutMessages) request. It indicates the number of failed messages as well as an array of results…
2 properties 2 required
CreateCursorDetails
object
Object used to create a cursor to consume messages in a stream.
4 properties 2 required
CreateGroupCursorDetails
object
Object used to create a group cursor.
6 properties 2 required
Group
object
Represents the current state of a consumer group, including partition reservations and committed offsets.
3 properties 2 required
PutMessagesResultEntry
object
Represents the result of a [PutMessages](/en/streaming/20180418/methods/PutMessages) request, whether it was successful or not. If a message was successfully a…
5 properties
Cursor
object
A cursor that indicates the position in the stream from which you want to begin consuming messages and which is required by the [GetMessages](/en/streaming/201…
1 property 1 required
PutMessagesDetailsEntry
object
Object that represents a message to emit to a stream.
2 properties 1 required
Error
object
The representation of an error.
2 properties 2 required
UpdateGroupDetails
object
Request body for operationally managing a group.
2 properties
Message
object
A message in a stream.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-stream-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

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