Skip to main content
POST
Import by spec

Authorizations

Authorization
string
header
required

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

Body

application/json

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"

Response

Protocol created

Summary of an imported or created protocol.

id
string<uuid>
required
Example:

"c4a1f2d0-5b3e-4f6a-8d29-1e7b9c0a2d43"

inserted_at
string<date-time>
required
Example:

"2026-04-02T10:15:00Z"

local_id
string
required
Example:

"specter-v1"

name
string
required
Example:

"Specter v1"

url
string
required
Example:

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

version
string
required
Example:

"1.0.0"