Get a service’s OpenAPI document

Part of Endpoints, 9 operations. The overview covers keys, scopes and errors.

GET /docs/services/{service_id}.json

One shipped service’s learned endpoints as an OpenAPI 3.1 document (x-path-templates, x-superbot-replay): endpoint shapes, header rule names and provenance, never an example value or a credential.

No credential needed; any live caller key (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session is also accepted.

Operation id getServiceDocument in Endpoints.

Path parameters

service_id string required
The service id, e.g. doordash.

Response 200

The service as OpenAPI 3.1.

application/json: object.

Errors

Status	Code	What to change
404	`not_found`	No such resource on this account; check the id.

view .md openapi

Request

curl

curl -sS -X GET "https://superbot.gg/docs/services/$SERVICE_ID.json"

JavaScript

const serviceId = 'SERVICE_ID';
const res = await fetch(`https://superbot.gg/docs/services/${serviceId}.json`, {
  method: 'GET',
});
console.log(res.status, await res.json());

Python

import os
import requests

service_id = "SERVICE_ID"
res = requests.request(
    "GET",
    f"https://superbot.gg/docs/services/{service_id}.json",
)
print(res.status_code, res.json())

Response

200 The service as OpenAPI 3.1.

{}

404 No such resource on this account.

{
  "error": "not_found",
  "message": "No such resource on this account; check the id.",
  "doc_url": "https://superbot.gg/developers#errors-not_found",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}