# Olane

## Docs

- [API keys](https://docs.copass.com/account/api-keys.md): Mint, list, and revoke the olk_… keys that authenticate your CLI, SDK, and direct API calls.
- [Billing](https://docs.copass.com/account/billing.md): Credit-based billing — top up, watch your balance, manage cards. OpenRouter-style: pay for what you use, no subscriptions.
- [Your Copass ID](https://docs.copass.com/account/handle.md): A public handle like @alice that other Copass users address you by — used in collaboration grants, agent shares, and the sharing surface.
- [Create Api Key](https://docs.copass.com/api-reference/api-keys/create-api-key.md): Create a new user-wide API key. The raw key is returned only once.
- [List Api Keys](https://docs.copass.com/api-reference/api-keys/list-api-keys.md): List all active API keys for the authenticated user.
- [Revoke Api Key](https://docs.copass.com/api-reference/api-keys/revoke-api-key.md): Revoke (soft-delete) an API key.
- [Discover a typed menu of related context](https://docs.copass.com/api-reference/query--discover/discover-a-typed-menu-of-related-context.md): Return a ranked menu of items — entities, neighborhoods, temporal regions, behaviors, co-occurrences — that are relevant to the current question. Use this as the first step of an agentic retrieval flow: the caller picks an item and proceeds to `/interpret` (for a macro-level brief) or `/search` (for…
- [Summarize one discovery item with a macro-level brief](https://docs.copass.com/api-reference/query--interpret/summarize-one-discovery-item-with-a-macro-level-brief.md): Given an item returned from `/discover`, run a focused retrieval pipeline pinned to that item's canonical id and synthesize a 1–2 paragraph brief. Cheaper than a full `/search` when you only want the high-level picture of a single context point.
- [Deep semantic search with synthesized answer](https://docs.copass.com/api-reference/query--search/deep-semantic-search-with-synthesized-answer.md): Run the full matrix retrieval pipeline — scope, search, rerank, format, interpret — and return a synthesized natural-language answer. This is the heavier end of the retrieval surface; reach for `/discover` or `/interpret` when you don't need a full answer.
- [Archive ephemeral sources inactive for >= threshold](https://docs.copass.com/api-reference/storage--data-sources/archive-ephemeral-sources-inactive-for->=-threshold.md): Flip ephemeral + active sources with no recent activity to archived.
- [Delete Source](https://docs.copass.com/api-reference/storage--data-sources/delete-source.md): Delete a data source.
- [Disconnect Source](https://docs.copass.com/api-reference/storage--data-sources/disconnect-source.md): Disconnect a data source.
- [Get Source](https://docs.copass.com/api-reference/storage--data-sources/get-source.md): Get data source details.
- [List Sources](https://docs.copass.com/api-reference/storage--data-sources/list-sources.md): List data sources in the sandbox.
- [Pause Source](https://docs.copass.com/api-reference/storage--data-sources/pause-source.md): Pause a data source.
- [Pull Data Source](https://docs.copass.com/api-reference/storage--data-sources/pull-data-source.md): Dispatch a `data_source_pull` job for this source.
- [Re-run the health check on a user_mcp source](https://docs.copass.com/api-reference/storage--data-sources/re-run-the-health-check-on-a-user_mcp-source.md): Verify the user's MCP server is still reachable.
- [Register a tenant-supplied MCP server as a user_mcp source](https://docs.copass.com/api-reference/storage--data-sources/register-a-tenant-supplied-mcp-server-as-a-user_mcp-source.md): Run the secret-aware user_mcp lifecycle.
- [Register Source](https://docs.copass.com/api-reference/storage--data-sources/register-source.md): Register a new data source in the sandbox.
- [Resume Source](https://docs.copass.com/api-reference/storage--data-sources/resume-source.md): Resume a data source.
- [Revoke a user_mcp source (vault-delete + bucket eviction)](https://docs.copass.com/api-reference/storage--data-sources/revoke-a-user_mcp-source-vault-delete-+-bucket-eviction.md): Disconnect a user_mcp source.
- [Update Source](https://docs.copass.com/api-reference/storage--data-sources/update-source.md): Update data source configuration.
- [Search entities in a sandbox](https://docs.copass.com/api-reference/storage--entities/search-entities-in-a-sandbox.md): Search for entities via vector similarity, scoped to a single sandbox. Supports optional project narrowing via `project_id`. Entities are matched only when their vector metadata carries the supplied `sandbox_id` (and `project_id` when provided).
- [Get Ingest Job Status Explicit](https://docs.copass.com/api-reference/storage--ingestion/get-ingest-job-status-explicit.md): Get the status of an ingestion job, including child job summary.
- [Get Ingest Job Status Shorthand](https://docs.copass.com/api-reference/storage--ingestion/get-ingest-job-status-shorthand.md): Get the status of an ingestion job, including child job summary.
- [Ingest Text Explicit](https://docs.copass.com/api-reference/storage--ingestion/ingest-text-explicit.md): Submit text for chunking and ontology ingestion in a specific sandbox.
- [Ingest Text Shorthand](https://docs.copass.com/api-reference/storage--ingestion/ingest-text-shorthand.md): Submit text for chunking and ontology ingestion.
- [Archive Project](https://docs.copass.com/api-reference/storage--projects/archive-project.md): Archive a project (soft-delete).
- [Create Project](https://docs.copass.com/api-reference/storage--projects/create-project.md): Create a new project in the sandbox.
- [Delete Project](https://docs.copass.com/api-reference/storage--projects/delete-project.md): Delete a project and its data source associations.
- [Get Project](https://docs.copass.com/api-reference/storage--projects/get-project.md): Get project details.
- [Link Data Source](https://docs.copass.com/api-reference/storage--projects/link-data-source.md): Link a data source to a project.
- [List Projects](https://docs.copass.com/api-reference/storage--projects/list-projects.md): List projects in the sandbox.
- [Unlink Data Source](https://docs.copass.com/api-reference/storage--projects/unlink-data-source.md): Unlink a data source from a project.
- [Update Project](https://docs.copass.com/api-reference/storage--projects/update-project.md): Update project fields.
- [Archive Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/archive-sandbox.md): Archive a sandbox (soft-delete).
- [Create Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/create-sandbox.md): Create a new sandbox.
- [Destroy Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/destroy-sandbox.md): Destroy a sandbox and all its data sources and projects.
- [Get Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/get-sandbox.md): Get sandbox details.
- [List Sandboxes](https://docs.copass.com/api-reference/storage--sandboxes/list-sandboxes.md): List sandboxes visible to the authenticated caller.
- [Reactivate Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/reactivate-sandbox.md): Reactivate a suspended sandbox.
- [Suspend Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/suspend-sandbox.md): Suspend a sandbox.
- [Update Sandbox](https://docs.copass.com/api-reference/storage--sandboxes/update-sandbox.md): Update sandbox fields.
- [Delete Object](https://docs.copass.com/api-reference/storage--vault/delete-object.md): Delete a single object from the vault.
- [List Objects](https://docs.copass.com/api-reference/storage--vault/list-objects.md): List object keys in the vault under a prefix.
- [Retrieve Object](https://docs.copass.com/api-reference/storage--vault/retrieve-object.md): Retrieve data from the vault.
- [Store Object](https://docs.copass.com/api-reference/storage--vault/store-object.md): Store data in the vault.
- [Get Token Balance](https://docs.copass.com/api-reference/usage/get-token-balance.md): Return the user's balance, computed only from the ``token_credits`` ledger.
- [Copass CLI](https://docs.copass.com/cli.md): Ingest data directly into your Copass vault from the terminal
- [Sharing agents](https://docs.copass.com/collaboration/agents.md): Give someone access to a specific agent — without sharing the whole sandbox. Two flavors: invoke (they bring their own integrations) and delegate (they use yours).
- [Sharing context](https://docs.copass.com/collaboration/context.md): Invite a teammate into your sandbox so you can build together — at viewer or editor role, with optional project scope and expiry.
- [Collaboration](https://docs.copass.com/collaboration/overview.md): Bring teammates into your Copass work. Share a whole sandbox, or share a single agent — owner-controlled, role-scoped, revocable anytime.
- [Data Sources](https://docs.copass.com/concepts/data-sources.md): Every byte that lands in a sandbox is tagged to a data source. Manage their lifecycle — provision, pause, resume, disconnect — across CLI, Concierge, and SDK.
- [Custom MCP](https://docs.copass.com/concepts/data-sources/custom-mcp.md): Register your own MCP server as a data source. Your tools become first-class agent tools alongside Slack, GitHub, and the rest of the catalog.
- [Ingestion](https://docs.copass.com/concepts/ingestion.md): Push content into a sandbox so retrieval and agents can use it. One-shot pushes, full project indexes, and continuous watching — all three paths.
- [Integrations](https://docs.copass.com/concepts/integrations.md): OAuth your sandbox into 3,000+ third-party apps via Pipedream — or register a custom data source you push to directly.
- [Multi-tenancy](https://docs.copass.com/concepts/multi-tenancy.md): One sandbox is your app. Every end user is an endUserId inside it. Connections, memory, and runs all scope to (sandbox, end user).
- [Portable Context](https://docs.copass.com/concepts/portable-context.md): Context is a resource, not a runtime. Copass stores it in your sandbox so every agent provider — Anthropic, Google, or whatever comes next — reads from the same tools, memory, and knowledge graph.
- [Progressive Disclosure](https://docs.copass.com/concepts/progressive-disclosure.md): A first-principles approach to context engineering for agents.
- [Projects](https://docs.copass.com/concepts/projects.md): Sandbox-scoped logical grouping. Retrieval scopes by project; collaboration grants can scope by project; one sandbox can hold many.
- [Retrieval](https://docs.copass.com/concepts/retrieval.md): Three calls — discover, interpret, search. Cheap menu, pinned brief, synthesized answer. Pick the right one for the job.
- [Sandboxes](https://docs.copass.com/concepts/secure-storage.md): Three primitives every Copass operation is scoped against — sandboxes, data sources, and projects.
- [Webhooks](https://docs.copass.com/concepts/webhooks.md): Push events into a Copass data source from your own systems. Public URL, signing secret, replay-dedup, rotation — all in.
- [Window-Aware Retrieval](https://docs.copass.com/concepts/window-aware-retrieval.md): Retrieval that knows what your agent has already seen — and won't deliver the same context twice.
- [Concierge](https://docs.copass.com/concierge.md): The default way to build with Copass. Describe what you want; the Concierge runs the right management calls for you.
- [Ship a feature across 3 repos](https://docs.copass.com/cookbooks/cross-repo-feature.md): Index three repos with the CLI, connect GitHub, and hand the agent a feature request. It figures out the schema change, the backend work, and the frontend work — then opens three coordinated PRs in the right order.
- [Customer health radar](https://docs.copass.com/cookbooks/customer-health.md): Six integrations in one sandbox track every signal your customers emit. Agent flags the ones going quiet, frustrated, or upsell-ready — before your success team notices.
- [Why does this code exist?](https://docs.copass.com/cookbooks/decision-archaeology.md): Paste a function. Get back the PR that shipped it, the Slack thread that argued for it, the Linear ticket it closed, the Notion design doc it came from, and the Drive spec that started it — all stitched across five sources.
- [Cookbooks](https://docs.copass.com/cookbooks/overview.md): Five recipes that maximize what the sandbox lets you federate. Every one pulls from 5+ integrations and produces something you could not build in a weekend without Copass.
- [Post-mortem in 60 seconds](https://docs.copass.com/cookbooks/post-mortem.md): Paste a time window + an incident channel. Agent weaves PagerDuty alerts, Slack threads, GitHub deploys, Datadog errors, and Linear tickets into a first-draft post-mortem with a reconstructed timeline.
- [Kill your standups](https://docs.copass.com/cookbooks/standup-killer.md): Agent watches GitHub commits, Linear moves, Slack threads, Google Calendar attendance, and Notion edits. Every morning, posts a per-person summary to #standup. Five sources in, one narrative out.
- [Agent Router](https://docs.copass.com/developer-tools/agent-router.md): One API for every agent provider. Hosted runtime, OAuth integrations in one call, swap Anthropic and Google on a per-call flag.
- [Build an agent](https://docs.copass.com/developer-tools/agent-router/build.md): Create, list, inspect, update, and archive agents in your sandbox. Three paths — Concierge, CLI, SDK.
- [Event stream](https://docs.copass.com/developer-tools/agent-router/events.md): A provider-neutral async iterator of agent events. Same shape across Anthropic and Google.
- [Integrations (SDK reference)](https://docs.copass.com/developer-tools/agent-router/integrations.md): The router.integrations.* facade — connect, list, disconnect, reconcile, catalog. For the conceptual overview, see Integrations.
- [Providers](https://docs.copass.com/developer-tools/agent-router/providers.md): Pick an AI backend. Anthropic and Google today — flip between them on a per-call flag. Context, tools, and memory stay in the sandbox.
- [Quickstart](https://docs.copass.com/developer-tools/agent-router/quickstart.md): Install the SDK, set two env vars, run your first agent in under a minute.
- [Runs](https://docs.copass.com/developer-tools/agent-router/runs.md): Inspect agent runs — list, follow live, test-fire with synthetic events, debug silent no-ops.
- [Multi-turn conversations](https://docs.copass.com/developer-tools/agent-router/sessions.md): Thread `session_id` across calls to continue a chat. Copass keeps the Context Window warm so window-aware retrieval stays sharp across every turn — and across providers.
- [Tools](https://docs.copass.com/developer-tools/agent-router/tools.md): What tools an agent has access to, where they come from, and how to inspect or constrain them.
- [Triggers](https://docs.copass.com/developer-tools/agent-router/triggers.md): Wire an agent to fire on data-source events — Slack mentions, GitHub issues, Linear status changes, anything an integration emits.
- [Claude Code Extension](https://docs.copass.com/developer-tools/claude-code.md): Turn on window-aware, progressive context for every Claude Code turn.
- [Filesystem Data Source](https://docs.copass.com/developer-tools/datasource-fs.md): Mirror a local directory into Copass with one object
- [MCP Server](https://docs.copass.com/developer-tools/mcp.md): Expose Copass to any LLM agent via the Model Context Protocol
- [Overview](https://docs.copass.com/overview.md): Create a sandbox, feed it data, run agents.
- [Quickstart](https://docs.copass.com/quickstart.md): From zero to a working ingest → retrieve loop in three commands
- [SDK](https://docs.copass.com/sdk.md): A family of TypeScript and Python packages for building Copass-backed agents in your framework of choice
- [Security](https://docs.copass.com/security.md)

## OpenAPI Specs

- [openapi](https://ai.copass.id/openapi.json)