Read the Cloud integration and lifecycle guide

GET

/v1/docs

const url = 'https://example.com/v1/docs';
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/docs

Public and unauthenticated, served as text/markdown — send an Accept header that admits text/markdown or text/plain or the request is refused with 406. This is the prose companion to the machine contract: the end-to-end integration order, the Session lifecycle, and the webhook-versus-event-log repair rules that individual operations only reference. Cacheable for 300 seconds.

Responses

200

Markdown integration guide

text/markdown

string

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"
}