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

Pypestream Endpoints API

API to be consumed by the 3rd party apps.

Pypestream Endpoints API is one of 27 APIs that Pypestream publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 7 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://engagement-api.pypestream.com/, https://engagement-api-sandbox.pypestream.com/.

7 operations 7 paths 16 schemas 7 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://reporting.pypestream.com/api/v2/
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Pypestream Endpoints API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

  • BearerAuth — accesstoken received with the Create User response must be provided via Authorization: Bearer header

Paths & Operations 7

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

Endpoints 7

API to be consumed by the 3rd party apps.

POST
/messaging/v1/consumers/anonymous_session
Create User
anonymous_session 1 param body → 201400404500
POST
/messaging/v1/chats/{chat_id}/start
Start Engagement
start 1 param body → 202400404409428500
POST
/messaging/v1/chats/{chat_id}/message
Send Message
message 1 param body → 204400404500
POST
/messaging/v1/chats/{chat_id}/ping
Keep alive Engagement
ping 1 param body → 201400404500
POST
/messaging/v1/chats/{chat_id}/type
Typing Indicator
type 1 param body → 204400404500
POST
/messaging/v1/chats/{chat_id}/snapshot
Generate Snapshot
snapshot 1 param body → 201400404500
POST
/messaging/v1/chats/{chat_id}/end
End Engagement
end 1 param body → 204400404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SnapshotResponse (47 properties), AnonymousSessionResponse (26 properties), AnonymousSession (15 properties), SendMessage (15 properties). Each schema is shown below with its type and property counts.

Type
object
4 properties 4 required
Ping
object
2 properties 1 required
EndChat
object
5 properties 5 required
Error
object
3 properties 3 required
SnapshotResponse
object
47 properties 2 required
PreconditionRequired
object
2 properties 2 required
ExistingActiveConversation
object
2 properties 2 required
AnonymousSessionResponse
object
26 properties 5 required
NotFound
object
2 properties 2 required
Snapshot
object
1 property 1 required
BadRequest
object
2 properties 2 required
SendMessage
object
15 properties 7 required
AnonymousSession
object
15 properties 4 required
StartChat
object
6 properties 6 required
Pong
object
3 properties 2 required
InternalError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pypestream-endpoints-api-openapi.yml Raw ↑

Other APIs Pypestream publishes across the network.

Pypestream Actions API
Pypestream Advanced API
Pypestream Agent API
Pypestream Annotations API
Pypestream Batch Exports API
Pypestream Cohorts API
Pypestream Configuration API
Pypestream Conversations API
Pypestream Dashboards API
Pypestream Datasets API
Pypestream Display Control API
Pypestream Event Definitions API
Where this information came from

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