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

Zulip bots API

The bots API from Zulip — 1 operation(s) for bots.

Zulip bots API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include bots. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.

3 operations 1 paths 6 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Servers
https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1
http://localhost:9991/api/v1
http://{subdomain}.testserver/json
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Zulip bots API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

bots 3
GET
/bot_storage
Get a bot's stored data
get-bot-storage 1 param → 200400
PUT
/bot_storage
Update a bot's stored data
update-bot-storage body → 200400
DELETE
/bot_storage
Remove a bot's stored data
remove-bot-storage body → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed is JsonResponseBase (1 property). Each schema is shown below with its type and property counts.

JsonSuccessBase
Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include…
JsonSuccess
IgnoredParametersUnsupported
array
An array of any parameters sent in the request that are not supported by the endpoint. See [error handling](/api/rest-error-handlingignored-parameters) documen…
JsonResponseBase
object
1 property
CodedError
CodedErrorBase

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-bots-api-openapi.yml Raw ↑

Other APIs Zulip publishes across the network.

Zulip REST API
Zulip Events API
Zulip Webhooks
Zulip authentication API
Zulip channels API
Zulip drafts API
Zulip invites API
Zulip messages API
Zulip mobile API
Zulip navigation_views API
Zulip real_time_events API
Zulip reminders API