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

Use the Conversation API after the escalate request

Pypestream Conversations 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.

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

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

Requests are made against 2 base URLs: http://middleware.pypestream.com/, http://middleware-sandbox.pypestream.com/.

7 operations 6 paths 12 schemas 3 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://reporting.pypestream.com/api/v2/
Authentication
HTTP Basic, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Pypestream Conversations API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as X-Pypestream-Token (TokenHeader).

Paths & Operations 7

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

Conversations API 7

Use the Conversation API after the escalate request

POST
/contactCenter/v1/conversations/{conversationId}/end
End Chat
sendEnd 1 param body → 204400500
GET
/contactCenter/v2/conversations/{conversationId}/history
Retrieve Conversation History
conversationHistory 3 params → 200
PUT
/contactCenter/v1/conversations/{conversationId}/messages/{messageId}
Send Message
sendMessage 2 params body → 204400500
GET
/contactCenter/v1/conversations/{conversationId}/metadata
Retrieve Metadata
getMetadata 1 param → 200
PATCH
/contactCenter/v1/conversations/{conversationId}/metadata
Update Metadata
updateMetadata 1 param body → 200
POST
/contactCenter/v1/conversations/{conversationId}/type
Send Typing Status
sendTypingIndicator 1 param body → 204400500
GET
/contactCenter/v1/conversations/{conversationId}/history
Get the chat conversation history
conversationHistory 3 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are MessageSent (5 properties), MessageSent_2 (5 properties), Error (3 properties), Message (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties 3 required
AgentMetadata
object
1 property 1 required
End
object
1 property 1 required
Metadata
object
3 properties 3 required
MessageSent
object
5 properties 5 required
BadRequest
object
2 properties 2 required
Message
object
3 properties 3 required
Typing
object
1 property 1 required
InternalError
object
1 property 1 required
History
object
2 properties 2 required
MessageSent_2
object
5 properties 5 required
Message_2
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pypestream-conversations-api-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 Dashboards API
Pypestream Datasets API
Pypestream Display Control API
Pypestream Endpoints API
Pypestream Event Definitions API
Where this information came from

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