GET

Developer access

Get OpenAPI specification

/api/v2/openapi.json

AUTHENTICATIONNone · publicService ownerapi-gateway · developer-platformContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Return the machine-readable OpenAPI specification for implemented V2 contracts.

When to use it

Fetch before generating tools, SDKs, requests, validators, or conformance tests, and re-fetch before release validation or when deployment may have changed.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover openapi specification.
Gives human and agentic integrations one discoverable path from service identity and reference data to executable OpenAPI, capability ownership, guides, SDK status, and request-signing controls.

ISOLATION + AUTHORITY

Public service metadata, the OpenAPI document, the capability registry, guides, SDK listings, bearer credentials, step-up grants, and request-signing keys are separate artifacts. Discovery metadata grants no tenant, wallet, custody, payment, settlement, publisher, matching, or trading authority; public signing-key metadata never includes private key material.

BEFORE YOU CALL

No bearer credential is required; apply bounded filters and canonical public identifiers where the contract provides them.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve whether the caller needs public discovery, bearer authorization, purpose-bound step-up, or RFC 9421 request signing; do not substitute one mechanism for another.

WHAT TO DO NEXT

Import the document into the agent tool registry, SDK generator, request builder, or validator without rewriting its operation schemas.
Compare the deployed contract with the capability registry and re-fetch it before release validation or whenever the deployment changes.

AGENT GUIDANCE

Use openapi specification only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Treat deployment identity, OpenAPI schema, capability readiness, guide narrative, SDK publication, bearer authorization, step-up authorization, and request-signing proof as distinct inputs; none substitutes for another.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

RESPONSES

Status and payload examples

200OpenAPI 3.1 machine contract for executable Rust gateway operations.Read completed · JSON RESPONSE+

{
  "openapi": "3.1.0",
  "info": {
    "title": "Hybrid-Chain API Gateway",
    "version": "v2"
  },
  "paths": {
    "/api/v2/developer-portal": {
      "get": {
        "operationId": "portal",
        "security": []
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then import the document into the agent tool registry, SDK generator, request builder, or validator without rewriting its operation schemas.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the application, credential or callback record; compare scope, key identifier, secret-display state, version, and revocation or rotation receipt.

OPERATIONAL NOTES

Security and lifecycle guarantees

This is the executable contract authority. Generate parameters, request bodies, validators, response branches, authentication, scopes, idempotency, and signing behavior from the selected operation and referenced component schemas.
Digest the exact response bytes and retain that digest with generated-client provenance. Re-fetch and compare immediately before release or when deployment may have changed.
Only operations present here are callable. OpenAPI presence still does not bypass tenant, feature, market, owner-adapter, downstream-readiness, or domain policy.
No bearer, query parameters, or request body are accepted. Website examples and capability prose cannot widen this document.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory