Skip to content
Embabel Worlds
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guide
Realm spec
API
Blog
Overview
Realms and queries
Overview
Watches
Overview
List watches
GET
Create a watch
POST
Get a watch
GET
Delete a watch
DELETE
Update a watch
PATCH
List changes since a run
GET
List delivery attempts for a watch
GET
Compare two runs
GET
Get a persisted diff
GET
List a watch's runs
GET
Run a watch now
POST
Get one watch run
GET
Get a run's canonical snapshot
GET
Get one subject from a run's snapshot
GET
Sources
Overview
Redirect to the external URL of a cited source
GET
Virtual Cypher (user)
Overview
Query Studio's starter queries, and whether to offer them
GET
Stop offering the examples to this person, or offer them again
PUT
Execute verbatim Cypher through the virtual-cypher engine, synchronously
POST
Generate Cypher and an execution explanation for a question, without running it
POST
Cancel an in-flight run by id (owner-guarded)
POST
Revise existing Cypher per an instruction, without running it
POST
List the caller's in-flight virtual-cypher runs
GET
The caller's own graph schema — labels, properties, relationship triples
GET
List the caller's live captured scopes, newest first
GET
Delete one of the caller's captured scopes
DELETE
Pin one of the caller's captured scopes
POST
Validate Cypher against the schema without executing it
POST
List the caller's saved views with their cache state
GET
Save a user-authored view (optionally parameterized) into the caller's world
POST
Delete a user-authored view from the caller's world
DELETE
Return the runnable Cypher for a saved view invoked with the given arguments
POST
Force-recompute a materialised view's cache now, ignoring its TTL
POST
Realms
Overview
List installed realms
GET
Install a realm
POST
Capability gaps
GET
Refresh the world's realms
POST
Update all realms
POST
Which installed realms have a newer version upstream
GET
Remove a realm
DELETE
A realm's icon
GET
A realm's problems
GET
Update a realm
POST
API Discovery
Overview
Get a cached discovery by name
GET
Discover an API from a description or URL
POST
List cached API discoveries
GET
Install a discovered API
POST
Lenses
Overview
List saved lenses
GET
Create or update a saved lens
PUT
Render the briefing lens over a chosen time window
POST
Ask a question grounded in a lens's focused entities
POST
Return a saved lens's presented content
POST
Open a saved lens and return how many entities it focused
POST
List the views available for a saved lens
POST
Render one named view of a saved lens
POST
Webhooks
Overview
Webhook status
GET
Receive a webhook event
POST
Receive a webhook event
POST
Realm observability
Overview
Guest runtime log tail, optionally filtered to one realm
GET
Realm runtime and JVM metrics
GET
Virtual Cypher
Overview
Answer a natural-language question by generating and executing scoped Cypher
POST
List the named scopes the acting user's asks can be narrowed to
GET
Create a named scope (a world-tier focus) asks can be narrowed to
POST
Delete a world-tier named scope
DELETE
Execute Cypher with a caller-supplied DERIVE rule set evaluated for this query only
POST
Execute verbatim Cypher through the virtual-cypher engine, synchronously, watched, or in the background
POST
Generate Cypher and an execution explanation for a question, without running it
POST
Cancel an in-flight run by id (owner-guarded)
POST
Plan a goal over the acting user's views and rules, without running anything
POST
Plan a goal and run the compiled statement as the acting user
POST
Revise existing Cypher per an instruction, without running it
POST
List the acting user's in-flight virtual-cypher runs
GET
Get the state and, once settled, the result of a background run
GET
Answer a run parked awaiting input: proceed, narrow, background or cancel
POST
The acting user's graph schema — labels, properties, relationship triples
GET
The legal values of a property: the set, or its size when too wide, or why it cannot be enumerated
GET
Validate Cypher against the schema without executing it
POST
List the acting user's saved views with their cache state
GET
Save a user-authored view (optionally parameterized) into the acting user's world
POST
Delete a user-authored view from the acting user's world
DELETE
Draft an ODCS contract for a saved view, optionally sampling, saving and binding it
POST
Return the runnable Cypher for a saved view invoked with the given arguments
POST
Force-recompute a materialised view's cache now, ignoring its TTL
POST
Replan a goal view over the world's current steps and pin the compiled statement
POST
Run a saved view with the given arguments and return its rows
POST
Requests
Overview
Every request raised in your world, newest first
GET
One request
GET
Approve or reject a request
POST
Handlers
Overview
Delete a user-authored handler (realm handlers can only be disabled)
POST
Run a TypeScript handler observe-only against a sample or the most recent matching signal
POST
Generate (or, with `current`, refine) a TypeScript handler from English, with the tsc verdict
POST
List the user's handlers plus inactive realm-shipped handlers available to adopt
POST
Return one handler's source and metadata
POST
Create or update a handler, gated on TypeScript compilation
POST
Enable (adopt) or disable a handler for this user
POST
Set or clear a per-user cron schedule for a handler
POST
Type-check a handler body without saving or running it
POST
List the handlers in your world and whether each is switched on
GET
Switch a handler in your own world on or off
POST
Knowledge graph
Overview
Identity Link Proposals
Overview
Accept an identity-link proposal
POST
Reject an identity-link proposal
POST
Artifacts
Overview
List all artifacts
GET
Serve an app artifact
GET
List artifacts of a type
GET
Read an artifact's content
GET
Create or update an artifact
POST
Delete an artifact
DELETE
KG Reprojection
Overview
Re-project a user's stored propositions into graph edges without re-extracting from source
POST
Documents
Overview
List documents
GET
Delete a document
DELETE
Ask a question of your documents
POST
Embed a document's missing chunks as a job
POST
List ingest jobs
GET
Upload a file to ingest as a job
POST
Ingest a page by URL as a job
POST
Read an ingest job
GET
A document's sections, in reading order
GET
One section of a document, with its text
GET
Replace a document's tags
PUT
Ingest text
POST
Upload and ingest a file
POST
Ingest from URL
POST
Directory
Overview
Search the directory
GET
Browse all realms
GET
Install a directory entry
POST
Evict the directory caches so the next browse re-scans the sources
POST
List directory sources
GET
Embeddings
Overview
Whether documents can be embedded, and with what
GET
Change the embedding model
POST
KG Decoration
Overview
List the registered node decorators and their tick, batch and staleness settings
GET
Run one tick of a decorator now over its stale candidates
POST
Force a decorator to run against one specific node, bypassing the staleness check
POST
KG Scopes
Overview
List the acting user's live captured scopes, newest first
GET
Delete a captured scope
DELETE
Pin a captured scope: clear its expiry so it survives until explicitly deleted
POST
Enrichment
Overview
Run persisted virtual-join enrichment for a user now, synchronously
POST
Learning
Overview
Connect an API to this world, so it can be learned
POST
API auth modes this appliance can connect with, and their fields
GET
Change a connected API. The spec is fetched first; a failed fetch changes nothing
PUT
Connect a database to this world, so it can be learned
POST
Database engines this appliance carries a driver for, and their connection fields
GET
Change a connected database. Tested first; a failed test changes nothing
PUT
Sources this appliance can reach, described from metadata alone
GET
Disconnect a source: its connection, stored secret and provisional realm, with the nodes that realm seeded
DELETE
How a connected source is connected, for an edit form. Secrets are never returned
GET
What to write about a connected database, and the schema to write it from
GET
Hold a connected database's current state so reviewed wording can be saved
POST
Uninstall a source's provisional realm, with the nodes it seeded. The connection stays
DELETE
Mine, curate and probe a source. Writes nothing — returns the proposal to review
POST
A proposal already learned in this session
GET
Discard a held review. It wrote nothing, so this undoes nothing
DELETE
Answer one open question — keep, reverse, or fall back to what the store asserted
POST
Approve displayed decisions against the current draft digest. Recorded, not yet enforced
POST
Change one displayed name or description to a person's words, and re-emit the draft
POST
Install the reviewed proposal: a PROVISIONAL realm, queryable immediately, or a database description
POST
Promote a reviewed provisional realm to a name you stand behind
POST
Graph facts
Overview
Bring one graph fact up to date for the signed-in user, under its recompute policy
POST
KG Fills
Overview
The acting user's fills, newest first, with key coverage, tick and live-call progress
GET
Start a slow, resumable fill of an expensive materialization
POST
Cancel a fill — completed chunks stay cached; nothing is rolled back
DELETE
Memory
Overview
Remember a fact
POST
Context
Overview
This user's active context and every context name they've used
GET
Switch this user's active context, creating a new one if the name hasn't been used before
PUT
Push the current browser geolocation for the authenticated user
POST
Sync the browser's IANA timezone for the authenticated user
POST
KG Annotations
Overview
Freeze an annotation plan: validate and select matching nodes, writing nothing
POST
Apply a frozen annotation plan once, returning committed counts and post-images
POST
Conditionally undo an applied plan; a later edit wins and reports as a conflict
POST
Chat and models
Overview
Threads
Overview
Your threads, most recently active first
GET
Start a thread
POST
A thread, its messages, and the agents still answering
GET
Post in a thread; every agent you @mention answers in it
POST
Voice
Overview
Open a voice session
GET
Chat
Overview
Send a chat message
POST
Attach a file to the conversation
POST
Answer a question about an attachment
POST
What has been done with the files attached to this world
GET
Run a slash command
POST
Record thumbs up/down on an assistant reply
POST
Get conversation history
GET
Send an image (with optional caption) to the assistant
POST
Get memories relevant to current conversation
GET
Search memories
POST
Kill a running process
DELETE
List all agent processes
GET
End chat session
DELETE
Get session and process status
GET
Open SSE stream
GET
Get aggregated usage
GET
Warm the conversation path
POST
Models
Overview
Which models are actually in use, and whether any is hosted
GET
OpenAI-compatible
Overview
Talk to the world itself (model world) or an agent: the one named as the model, or the one whose base URL this is
POST
One agent, as the only OpenAI model at its own base URL
GET
Talk to the world itself (model world) or an agent: the one named as the model, or the one whose base URL this is
POST
The world itself and the agents you can talk to now, as OpenAI models
GET
Catchup
Overview
Run catchup now for a user (refreshes meeting-prep notes)
POST
Model Router
Overview
The whole routing chain for this world
GET
Point a context at a role, or pin it to a model
PUT
Add a custom role
POST
Choose the model a role uses in this world
PUT
Delete a custom role
DELETE
Chat sessions
Overview
List the user's chat sessions
GET
Delete a chat session
DELETE
Agents
Overview
Sensor
Overview
Publish what this machine can be asked to do
POST
Ingest a batch of sensor events for the authenticated user
POST
Long-poll for the next sensor command
GET
Report a command's result
POST
Agent reflection
Overview
An agent's proposals, newest first
GET
Write a proposal into the world as the agent's next version, for its sponsor to sign
POST
Dismiss a proposal
POST
Ask an agent to propose a better version of itself from its own record
POST
Audience
Overview
Channels this world's content declares, with what each unlocks
GET
Join or leave channels
PUT
Principles
Overview
Read the effective principles
GET
Set the operator's principles
PUT
Drop the operator's override
DELETE
Surface
Overview
Declare what this screen can be told to do
POST
Agent suggestions
Overview
Suggested colleagues, best first
GET
Record a suggested colleague
POST
Mark a suggestion settled by adopting the realm agent it names
POST
Dismiss a suggestion
POST
Draft a suggested colleague into the world, unsigned and off duty
POST
Signals
Overview
List the signal types this world has received, with their fields and how often
GET
Backfill signals from the trailing window
POST
Commands
Overview
List commands
GET
Create or update a command
POST
Delete a command
DELETE
Agent platform
Overview
List agents
GET
List goals
GET
A2A
Overview
The A2A cards of the agents you can talk to now
GET
A2A JSON-RPC to one agent: message/send, tasks/get, tasks/cancel
POST
One agent's A2A card
GET
One agent's A2A card
GET
Agents
Overview
List the agents in your world
GET
One agent in your world
GET
Check one of an agent's duties now
POST
Sign the agent as its next version
POST
Move an agent or one of its routines on the ladder
POST
Every signed version of an agent, newest first
GET
Whether every agent in your world is stopped
GET
Stop every agent in your world
POST
Lift the halt: every agent back as it was
DELETE
Code Actions
Overview
List every realm API operation available to a user, classified read-only vs write
GET
Approve or reject a write parked at a confirmation gate, by process id
POST
Plan and run (or dry-run) a code-action goal or natural-language question for a user
POST
Agent accounts
Overview
The secrets an agent has its own value for, by name
GET
Keep an agent's own value for a secret
PUT
Delete an agent's own value for a secret
DELETE
Retire an agent: off duty for good, its keys revoked and its own credentials deleted
POST
Actions
Overview
List actions in full
GET
List references available for action compilation (skills, RAG docs, memory)
GET
List tools available for action compilation
GET
List types available as action inputs/outputs
GET
Compile an action
POST
Get action details
GET
Update an action
POST
Delete an action
DELETE
Cron
Overview
List scheduled jobs
GET
Create or update a cron job
POST
Compile and schedule a cron job
POST
Compile a natural language schedule to a cron expression
POST
Delete a cron job
DELETE
Run a job immediately
POST
Agent runs
Overview
An agent's runs, newest first
GET
One run, with its receipts
GET
What an agent will do next
GET
Run one of an agent's scheduled jobs now, outside its schedule
POST
Skip an agent's next scheduled firing, or postpone it
POST
Check that every receipt still says what it said when it was written
GET
Skills
Overview
List the authenticated user's installed skills
GET
Headless Invocation
Overview
Poll a background lens run
GET
Kill a background lens run
POST
Invoke a named lens
POST
Invoke a named view
POST
Keys and sign-in
Overview
Auth
Overview
Start OAuth2 authorization flow
GET
OAuth2 callback — exchanges code for tokens
GET
Disconnect every connected account for this OAuth2 provider
POST
Disconnect one account by id from this OAuth2 provider
POST
List OAuth2 providers in this world and their status
GET
API keys
Overview
This user's API keys: names and prefixes, never the keys
GET
Mint a key; the response is the only time the key is shown
POST
Revoke a key immediately
DELETE
Your world
Overview
Themes
Overview
List available themes
GET
Get theme CSS
GET
Apply a theme for the current user's session
POST
Onboarding
Overview
Start the Get-to-Know-Me onboarding flow
POST
Get available onboarding sources
GET
Get onboarding job status
GET
World
Overview
World overview
GET
List actions
GET
List APIs
GET
Add an API
POST
Learn an API
POST
Remove an API
DELETE
List world documents
GET
Read a world document
GET
List MCP servers
GET
Remove an MCP server
DELETE
List available personalities
GET
Create a personality
POST
Read a personality's files
GET
Switch active personality
PUT
Delete a world-tier personality
DELETE
Save a personality's files
PUT
World provisioning progress
GET
List skills
GET
Create a local skill
POST
Refresh GitHub skills
POST
Remove a skill
DELETE
List all tools available to the LLM
GET
List dynamic types
GET
Images
Overview
Serve an image by filename
GET
Next steps
Overview
Every declared onboarding step, with whether it is already done
GET
Say this step is not going to be done, or take that back
PUT
Bootstrap
Overview
Bootstrap info
GET
Config
Overview
Get world config
GET
Get chat config
GET
Update chat config
PUT
Set the model chat uses
PUT
Get collector/dedup settings
GET
Update collector/dedup settings
PUT
Get per-world LLM role overrides
GET
Set or clear an LLM role override
PUT
Get all LLM configurations
GET
Update LLM config for a purpose
PUT
Where this server's MCP doors answer
GET
What a connected coding agent may do
GET
Set what a connected coding agent may do
PUT
List available models
GET
Get notification routing
GET
Update notification routing
PUT
Get storage configuration
GET
Tours
Overview
Every tour this world offers
GET
Store a tour somebody exported, or a client recorded
POST
Delete a tour this user saved
DELETE
One tour as the file it would be
GET
Is this step already satisfied?
POST
Worlds
Overview
List worlds
GET
Create world
POST
Delete world
DELETE
Factory reset world
POST
Switch world
POST
Notifications
Overview
List the authenticated user's notifications
GET
Create a notification for the authenticated user
POST
Dismiss all notifications
DELETE
Mark all notifications as read
POST
List the authenticated user's unread notifications
GET
Dismiss a notification
DELETE
Mark notification as read
POST
Diagnostics
Overview
Recent log lines from this appliance
GET
Memory, ingest queue and document conversion health
GET
Get diagnostic report (JSON)
GET
Get diagnostic report as plain text with LLM analysis
GET
Hints
Overview
Get all hints for the acting user and surface
GET
Get hints by category
GET
Get a random hint
GET
When a tip is posted to the acting user's inbox
GET
Change when a tip is posted to the acting user's inbox
PUT
Profile
Overview
This user's display name and home location
GET
This user's console preferences in their active world
GET
Change some of this user's console preferences
PUT
Rename this user — pushes to WorkOS and heals proposition prose, same as the Vaadin profile editor
PUT
Set or clear this user's home location
PUT
This user's greeting and login-hints preferences
GET
Set this user's greeting and login-hints preferences
PUT
This user's voice preferences, and whether voice is available at all in this deployment
GET
Set this user's preferred voice and effects
PUT
Sample data
Overview
What sample data is loaded
GET
Load a sample set
POST
Remove all sample data
DELETE
Read records out as a loadable sample set
POST
Remove one sample set
DELETE
About
Overview
Component versions, Bolt endpoints and the SQL door
GET
Activity
Overview
Work in progress, and work that just finished
GET
Dismiss a pinned failure
POST
How long each job takes
GET
Everything else
Overview
Calendar
Overview
Configured calendar providers and this user's connected accounts
GET
Disconnect one of this user's calendar accounts
DELETE
Calendar events across all connected accounts in a time window
GET
Email
Overview
Configured email providers and this user's connected accounts
GET
Disconnect one of this user's email accounts
DELETE
Recent email threads across all connected accounts
GET
GitHub
Select theme
Dark
Light
Auto
Overview
Surface
Section titled “Surface”
What a connected screen says it can be told to do
Operations
Section titled “Operations”
POST
/api/v1/ui/surface
