Info

Discover this cluster’s API version, storage schemes, Search modes, Answer efforts, and event capabilities.

GET/info

PermissionAny active Engine API key. Key scopes and actions.

Use this response before choosing a source URI scheme, a Search mode, or an Answer effort.
events.webhooks counts the webhooks that this key can see. It shows no receiver URL or secret.

Request

https://engine.example.com/info

GET /info HTTP/1.1
Host: engine.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

Replace engine.example.com with your cluster host. Examples use a key placeholder.

Response

200

The capabilities reported by this example cluster. Your cluster may report different capabilities.

{
  "name": "graphon-engine",
  "api_version": "1",
  "auth": {
    "required": true
  },
  "storage": {
    "primary": "graphon",
    "schemes": [
      "gs",
      "graphon"
    ]
  },
  "search": {
    "modes": [
      "keyword",
      "hybrid"
    ]
  },
  "answer": {
    "efforts": [
      "medium",
      "high"
    ]
  },
  "events": {
    "webhooks": 1,
    "types": [
      "job.updated",
      "file.status_changed",
      "collection.status_changed"
    ]
  }
}

Responses

200Success

The capabilities reported by this example cluster. Your cluster may report different capabilities.

application/json

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

answerobjectrequired

Supported Answer efforts.

api_versionstringrequired

Major API version served by this cluster. Routes have no version prefix.

authobjectrequired

Authentication requirement for this cluster.

eventsobjectrequired

Supported event types, and the number of webhooks this key can see.

namestringrequired

Cluster name. Events from this cluster include the same name.

searchobjectrequired

Supported Search modes.

storageobjectrequired

Primary storage identifier and readable URI schemes.

Errors

Select an error in the response example to see its JSON body. See error handling for the common error format.

401unauthenticated

The API key is missing, invalid, or revoked.

What to do: Send an active key in Authorization: Bearer or X-API-Key.

503temporarily_unavailable

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

500internal_error

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?

View as Markdown