Download this OpenAPI contract

GET

/v1/openapi.json

const url = 'https://example.com/v1/openapi.json';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/openapi.json

Public and unauthenticated — no bearer, no installation. This document is the machine contract the SDKs are generated from; fetch it at build time rather than pinning a copy, because event types, enum members and response fields evolve additively. Responses are cacheable for 300 seconds.

Responses

200

OpenAPI 3.1 document

application/json

object

Example

{
  "openapi": "3.1.0",
  "info": {
    "title": "WAMP Cloud API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "/",
      "description": "The WAMP API origin serving this document"
    }
  ],
  "paths": {
    "/v1/sessions/{sessionId}": {
      "put": {
        "operationId": "createSession",
        "summary": "Create a caller-owned Session idempotently"
      }
    }
  },
  "components": {
    "schemas": {
      "Uuid": {
        "type": "string",
        "format": "uuid"
      }
    }
  }
}

406

The requested representation is not available

application/json

Failure body returned with every non-2xx JSON response; branch on the machine code, never on prose or on the HTTP status alone.

object

error

required

Stable machine code

string

requiredScope

The installation capability the presented credential lacks, returned with insufficient_scope so an integrator knows exactly which capability to request

string

retryAfterSeconds

Advisory seconds to wait before retrying; returned on rate-limit denials, where the Retry-After header carries the same value

integer

>= 1

key

additional properties

any

Example

{
  "error": "representation_not_acceptable"
}