API description

This API as an OpenAPI document, for code generators and tools.

API description #

GET /v1/openapi.json no auth

This document: an OpenAPI 3.1 description of every public route, the stream protocol and the webhook payloads.

More about this

No credential needed. Cached for five minutes; send If-None-Match with the last ETag to revalidate.

Parameters

If-None-Match header · string

An ETag from an earlier response.

GET

curl "https://cirrus.pocketful.in/v1/openapi.json"

import os

import requests

response = requests.get(
    "https://cirrus.pocketful.in/v1/openapi.json",
    timeout=10,
)
print(response.status_code, response.json())

const response = await fetch('https://cirrus.pocketful.in/v1/openapi.json', {
  method: 'GET',
});
const body = await response.json();
console.log(response.status, body);