Skip to content
Embabel Worlds

Overview

Realms and queries 0.2.0-SNAPSHOT

Section titled “Realms and queries 0.2.0-SNAPSHOT”

Install and inspect realms, run Virtual Cypher, and keep saved views and the watches on them.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/watches
POST
/api/v1/watches
GET
/api/v1/watches/{watchId}
DELETE
/api/v1/watches/{watchId}
PATCH
/api/v1/watches/{watchId}
GET
/api/v1/watches/{watchId}/changes
GET
/api/v1/watches/{watchId}/deliveries
GET
/api/v1/watches/{watchId}/diff
GET
/api/v1/watches/{watchId}/diffs/{diffId}
GET
/api/v1/watches/{watchId}/runs
POST
/api/v1/watches/{watchId}/runs
GET
/api/v1/watches/{watchId}/runs/{runId}
GET
/api/v1/watches/{watchId}/runs/{runId}/snapshot
GET
/api/v1/watches/{watchId}/runs/{runId}/subjects/{source}/{entityId}
GET
/api/v1/sources/{kind}/{id}
GET
/api/v1/kg/studio/examples
PUT
/api/v1/kg/studio/examples/dismissed
POST
/api/v1/kg/studio/execute
POST
/api/v1/kg/studio/generate
POST
/api/v1/kg/studio/kill/{runId}
POST
/api/v1/kg/studio/refine
GET
/api/v1/kg/studio/runs
GET
/api/v1/kg/studio/schema
GET
/api/v1/kg/studio/scopes
DELETE
/api/v1/kg/studio/scopes/{name}
POST
/api/v1/kg/studio/scopes/{name}/pin
POST
/api/v1/kg/studio/validate
GET
/api/v1/kg/studio/views
POST
/api/v1/kg/studio/views
DELETE
/api/v1/kg/studio/views/{name}
POST
/api/v1/kg/studio/views/{name}/invocation
POST
/api/v1/kg/studio/views/{name}/refresh
GET
/api/v1/realms
POST
/api/v1/realms
GET
/api/v1/realms/gaps
POST
/api/v1/realms/refresh
POST
/api/v1/realms/update-all
GET
/api/v1/realms/updates
DELETE
/api/v1/realms/{name}
GET
/api/v1/realms/{name}/icon
GET
/api/v1/realms/{name}/problems
POST
/api/v1/realms/{name}/update
GET
/api/v1/discovery
POST
/api/v1/discovery
GET
/api/v1/discovery/cache
POST
/api/v1/discovery/install
GET
/api/v1/lenses
PUT
/api/v1/lenses
POST
/api/v1/lenses/briefing
POST
/api/v1/lenses/chat
POST
/api/v1/lenses/{id}/present
POST
/api/v1/lenses/{id}/run
POST
/api/v1/lenses/{id}/views
POST
/api/v1/lenses/{id}/views/{view}
GET
/api/v1/webhooks
POST
/api/v1/webhooks/{source}
POST
/api/v1/webhooks/{source}/{token}
GET
/api/v1/admin/realms/observability/logs
GET
/api/v1/admin/realms/observability/metrics
POST
/api/v1/admin/kg/ask
GET
/api/v1/admin/kg/ask/scopes
POST
/api/v1/admin/kg/ask/scopes
DELETE
/api/v1/admin/kg/ask/scopes/{name}
POST
/api/v1/admin/kg/derive
POST
/api/v1/admin/kg/execute
POST
/api/v1/admin/kg/generate
POST
/api/v1/admin/kg/kill/{runId}
POST
/api/v1/admin/kg/plan
POST
/api/v1/admin/kg/plan/run
POST
/api/v1/admin/kg/refine
GET
/api/v1/admin/kg/runs
GET
/api/v1/admin/kg/runs/{runId}
POST
/api/v1/admin/kg/runs/{runId}/answer
GET
/api/v1/admin/kg/schema
GET
/api/v1/admin/kg/schema/{label}/{property}/values
POST
/api/v1/admin/kg/validate
GET
/api/v1/admin/kg/views
POST
/api/v1/admin/kg/views
DELETE
/api/v1/admin/kg/views/{name}
POST
/api/v1/admin/kg/views/{name}/contract
POST
/api/v1/admin/kg/views/{name}/invocation
POST
/api/v1/admin/kg/views/{name}/refresh
POST
/api/v1/admin/kg/views/{name}/replan
POST
/api/v1/admin/kg/views/{name}/run
GET
/api/v1/requests
GET
/api/v1/requests/{id}
POST
/api/v1/requests/{id}/decision
POST
/api/v1/admin/handlers/delete
POST
/api/v1/admin/handlers/dry-run
POST
/api/v1/admin/handlers/generate
POST
/api/v1/admin/handlers/list
POST
/api/v1/admin/handlers/open
POST
/api/v1/admin/handlers/save
POST
/api/v1/admin/handlers/set-enabled
POST
/api/v1/admin/handlers/set-schedule
POST
/api/v1/admin/handlers/validate
GET
/api/v1/handlers
POST
/api/v1/handlers/set-enabled

Authentication

Section titled “Authentication”

apiKeyAuth

Section titled “apiKeyAuth”

An API key minted in the console under Settings → API keys. Also accepted as Authorization: Bearer <key>.

Security scheme type: apiKey

Header parameter name: X-Embabel-Api-Key

basicAuth

Section titled “basicAuth”

The appliance’s own user accounts. The Worlds console proxies these on the same origin.

Security scheme type: http