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

QStash Messages API

Publish and manage messages

QStash Messages API is one of 7 APIs that QStash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://qstash.upstash.io/v2.

3 operations 3 paths 4 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://qstash.upstash.io/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

QStash Messages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token obtained from the Upstash console at https://console.upstash.com/qstash. Alternatively, pass as query parameter qstashtoken.

Paths & Operations 3

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

Messages 3

Publish and manage messages

POST
/publish/{destination}
Publish a message
publishMessage 13 params body → 201202400401429
POST
/batch
Publish multiple messages in a single request
batchPublish body → 200400401
POST
/enqueue/{queueName}/{destination}
Enqueue a message to a FIFO queue
enqueueMessage 5 params body → 201401429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are BatchMessage (7 properties), BatchResponseItem (3 properties), PublishResponse (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

BatchMessage
object
7 properties 1 required
ErrorResponse
object
1 property
PublishResponse
object
2 properties
BatchResponseItem
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qstash-messages-api-openapi.yml Raw ↑

Other APIs QStash publishes across the network.

QStash Dead Letter Queue API
QStash Flow Control API
QStash Logs API
QStash Queues API
QStash Schedules API
QStash URL Groups API