API docs by Redocly

SGRS API (0.1.0)

Download OpenAPI specification:

Canonical OpenAPI contract for SGRS API tiers. Public routes live under /api, admin routes under /admin, and internal godlike routes under /internals.

public

Tenant-facing public API routes.

Public health check

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Queue a document for the headless governed swarm

header Parameters
X-Tenant-ID
required
string
Request Body schema: application/json
required
scope_id
required
string (ScopeId) [ 1 .. 120 ] characters ^[a-z0-9][a-z0-9-]*$
name
required
string [ 1 .. 500 ] characters
type
string <= 50 characters
Default: "txt"
text
required
string [ 1 .. 100000 ] characters
document_id
string [ 1 .. 200 ] characters
source
string [ 1 .. 500 ] characters
idempotency_key
string [ 1 .. 200 ] characters

Responses

Request samples

Content type
application/json
{
  • "scope_id": "string",
  • "name": "string",
  • "type": "txt",
  • "text": "string",
  • "document_id": "string",
  • "source": "string",
  • "idempotency_key": "string"
}

Response samples

Content type
application/json
{
  • "scope_id": "string",
  • "name": "string",
  • "type": "string",
  • "document_id": "string",
  • "idempotency_key": "string",
  • "queued": true,
  • "seq": 0,
  • "integration_version": "v1",
  • "message": "string"
}

admin

Admin control surface. Requires admin or godlike key.

Admin tier health

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "tier": "string",
  • "authTier": "string"
}

Kernel control-plane health through admin proxy

Authorizations:
BearerAuth

Responses

Create tenant and first key

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "tenant_id": "string",
  • "api_key": "string",
  • "key_prefix": "string",
  • "message": "string"
}

List scopes for a tenant key

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Create scope for a tenant key

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Attach document to scope

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Trigger ingest for scope documents

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Get scope summary

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Get scope metrics

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Stream scope events

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Reset scope data

Authorizations:
BearerAuth
path Parameters
scopeId
required
string
header Parameters
X-Tenant-API-Key
required
string

Responses

Start runtime for a scope

Authorizations:
BearerAuth

Responses

Pause runtime

Authorizations:
BearerAuth

Responses

Resume runtime

Authorizations:
BearerAuth

Responses

Stop runtime

Authorizations:
BearerAuth

Responses

Restart runtime for a scope

Authorizations:
BearerAuth

Responses

internals

Godlike-only operational and kernel internals routes.

Godlike tier health

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "tier": "string",
  • "authTier": "string"
}

Kernel feed health

Authorizations:
BearerAuth

Responses

Fetch hatchery snapshot

Authorizations:
BearerAuth

Responses

Legacy internals events stream alias Deprecated

Authorizations:
BearerAuth

Responses

Legacy internals convergence alias Deprecated

Authorizations:
BearerAuth

Responses

Legacy internals hatchery snapshot alias Deprecated

Authorizations:
BearerAuth

Responses

Legacy internals control-plane health alias Deprecated

Authorizations:
BearerAuth

Responses

Stream kernel events

Authorizations:
BearerAuth

Responses

Get kernel convergence payload

Authorizations:
BearerAuth

Responses

Get kernel control-plane health

Authorizations:
BearerAuth

Responses

Godlike runtime start

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Godlike runtime pause

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Godlike runtime resume

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Godlike runtime stop

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses

Godlike runtime restart

Authorizations:
BearerAuth
header Parameters
X-Tenant-API-Key
required
string

Responses