Application workflows
Complete your first import and retrieval, then choose a task below. If you use an existing agent, start with Connect Agents. If you are writing an application, choose a client through the SDK, HTTP and CLI conventions.
| Task | Reading order | Check the result |
|---|---|---|
| Retrieve documents or code in an application | Import resources → Retrieve → Read content | Ask a question with a known answer, read the returned URI and compare it with the source |
| Reuse memory across sessions | Session and memory model → Session API → Memory API | Commit a session, confirm background completion, then inspect the memories and their ownership |
| Reuse agent skills | Skills API → Privacy model | Inspect the installed skill, its visibility and how it is invoked |
| Produce a wiki, graph or report from sources | Context compilation → choose an output tutorial | Check task status, output files and how the output relates to the input sources |
| Sync or migrate existing context | Project asset sync, OVPack or version recovery | Follow the relevant guide to verify sync state, imported data or restored content |
Verify retrieval before wiring it into an application
Use a small document with known content. Import it, wait for processing, retrieve a match and read the source. A successful health check only confirms the service can respond; an empty search result alone does not prove ingestion failed. Use background tasks and diagnostic tools to distinguish processing state from retrieval results.
Add Resource Watches when remote sources need recurring updates. To change content processing, see prompt customization.
Verify memory across sessions
Decide the user, Peer and shared-context boundaries before recording messages and committing sessions. Extraction depends on configuration and policy; a successful commit does not guarantee a particular memory will be created. Inspect the output through the Session API and Memory API. For existing tools, check the integration capability comparison to learn which steps the plugin automates.
Add access control and operations before rollout
Shared services need authentication and ACLs. Find deployment, monitoring and upgrade paths in Deploy & Operate. For parameters, responses and errors, use the reference index.