Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

International Business Machines Messages API

Send messages to an assistant.

International Business Machines Messages API is one of 22 APIs that International Business Machines publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 8 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 3 base URLs: https://s3.us-south.cloud-object-storage.appdomain.cloud, https://s3.eu-de.cloud-object-storage.appdomain.cloud, https://s3.eu-gb.cloud-object-storage.appdomain.cloud.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Servers
https://s3.us-south.cloud-object-storage.appdomain.cloud
https://s3.eu-de.cloud-object-storage.appdomain.cloud
https://s3.eu-gb.cloud-object-storage.appdomain.cloud
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

International Business Machines Messages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (IAM Token) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Messages 2

Send messages to an assistant.

POST
/v2/assistants/{assistant_id}/sessions/{session_id}/message
International Business Machines Send user input to assistant
message 3 params body → 200
POST
/v2/assistants/{assistant_id}/message
International Business Machines Send user input to assistant (stateless)
messageStateless 2 params body → 200

Schemas 4

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

StatelessMessageRequest
object
2 properties
MessageResponse
object
2 properties
StatelessMessageResponse
object
3 properties
MessageRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

international-business-machines-messages-api-openapi.yml Raw ↑

Other APIs International Business Machines publishes across the network.

International Business Machines Analyze API
International Business Machines Buckets API
International Business Machines Clusters API
International Business Machines Custom Language Models API
International Business Machines Embeddings API
International Business Machines Environments API
International Business Machines Instances API
International Business Machines Models API
International Business Machines Objects API
International Business Machines Pronunciation API
International Business Machines Recognition API
International Business Machines Security Groups API