Get the OpenAPI document

GET

/api/openapi.json

curl --request GET \
  --url http://127.0.0.1:8765/api/openapi.json

This API as an OpenAPI 3.1 document (generated from the server’s route table). Every route with params, response schema_version, example, error codes, x-gigai-effect and x-gigai-external.

Responses

200

Success.

Media typeapplication/json

object

key

additional properties

any

Example

{
  "info": {
    "title": "GigAI Scout local API",
    "version": "0.1.10"
  },
  "openapi": "3.1.0",
  "paths": {}
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}