Skip to content
SealpostSealpostSealpost docs

This specification as JSON

GET
/openapi.json
curl --request GET \
  --url https://api.sealpost.app/v1/openapi.json

Responses

Section titled “Responses”

200

Section titled “200”

The OpenAPI 3.1 document.

Media typeapplication/json

An OpenAPI 3.1 document.

object

Example generated

{}

Headers

Section titled “Headers”
Sign-Request-Id
string

Unique id of this request (req_…). Quote it in support requests.

500

Section titled “500”

Something failed on our side. The request_id is in our logs.

Media typeapplication/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object
type
required

https://sealpost.app/errors/{code}

string format: uri
title
required
string
status
required
integer
detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string
instance

The request path.

string
code
required

Stable machine-readable code from the catalogue (docs/errors.md).

string
request_id
required
string
errors

Field-level detail on validation_failed.

Array<object>
object
param
required

JSON pointer-ish path, e.g. scopes[2].

string
message
required
string

Example 

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Section titled “Headers”
Sign-Request-Id
string

Unique id of this request (req_…). Quote it in support requests.