List the hosted gateway endpoints.

Index of the public hosted gateway surface, returned so a client that lands on the base URL learns what is served here without guessing. The machine-readable form of the same information is this document; the response advertises it with `Link: <https://b3iq.org/openapi.json>; rel="service-desc"` (RFC 8631).

GET /v1/api

Responses

200 Endpoint index.

application/json

name string REQUIRED

base_url string (uri) REQUIRED

endpoints string[] REQUIRED

Method + path, relative to `base_url`.

Array of:

openapi_url string (uri)

This document.

documentation_url string (uri)

default B3IQ-native problem response.

curl -X GET 'https://{controlPlaneHost}/v1/api'

const response = await fetch('https://{controlPlaneHost}/v1/api', {  method: 'GET'});const data = await response.json();console.log(data);

200 Response

{  "name": "<string>",  "base_url": "<uri>",  "endpoints": [    "<string>"  ],  "openapi_url": "<uri>",  "documentation_url": "<uri>"}

default Response

{  "error": {    "status": 123,    "title": "<string>",    "detail": "<string>",    "code": "<string>"  }}

GET /v1/api

Base URL

Response

Was this page helpful?

Previous Read public settlement state.

Next Queue a direct encrypted private-inference job.