Skip to main content
GET
Get protocol document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Protocol local ID

Response

Protocol document

Full protocol specification document.

$id
string
Example:

"https://developer.hellgate.io/protocols/specter/v1"

$schema
string
Example:

"https://developer.hellgate.io/schemas/link-protocol/v1"

actions
object

The operations the protocol defines, keyed by action name. Each action declares its method, request schema (optionally discriminated into variants), and per-status response schemas.

Example:
components
object

Reusable schema definitions referenced by actions via $ref.

Example:
name
string
Example:

"Specter v1"

version
string
Example:

"1.0.0"