# Seren Docs

> Seren is a backend control plane for agent-backed applications: Seren Employees, agent services, auth, passwords, skills, models, branchable Postgres, file storage, publisher APIs, MCP, and SDKs.

Base API URL: `https://api.serendb.com`

Canonical OpenAPI 3.1 document: `/openapi.json`

## Recommended Starting Points

- Product overview: `/`
- Five-minute quickstart for hosted MCP, CLI, or TypeScript: `/quickstart`
- How Seren Employees and the underlying agent platform fit together: `/how-seren-works`
- Best practices for defining, connecting, reviewing, and improving employees: `/best-practices`
- Generated API explorer: `/api`
- OpenAPI schema browser: `/schemas`
- Machine-readable schema index: `/schemas/index.json`
- SDK installation and first requests in TypeScript, Python, and Rust: `/sdks`
- CLI and MCP workflows: `/cli`
- Configure a Seren Employee and its managed agent: `/guides/configure-a-managed-employee`
- Connect revision-bound encrypted credential fields to an employee: `/guides/grant-a-credential`
- Configure organization collaboration, employee assignments, task labels, revocation, work-context boundaries, and governed knowledge: `/guides/use-organizational-knowledge`
- Understand employee ownership, organization authority, data boundaries, channels, and lifecycle: `/organizations`
- Review employee identity, authorization, approvals, secrets, isolation, revocation, and audit boundaries, plus the SOC 2 Trust Services Criteria the security program is built to: `/security`
- Connect Codex, Claude, Cursor, Gemini CLI, OpenCode, and other MCP clients: `/guides/connect-mcp-clients`
- TypeScript SDK: `pnpm add @serendb/sdk`
- Python SDK: `pip install seren-sdk`
- Rust SDK: `seren-sdk = "0.8"`
- Seren CLI binaries: `https://github.com/serenorg/seren/releases`
- Hosted MCP: `https://mcp.serendb.com/mcp`
- Codex hosted MCP: `codex mcp add seren --url https://mcp.serendb.com/mcp`
- Install Seren Employees skill: `npx skills add serenorg/skills --skill seren-employees`
- Install all Seren skills: `npx skills add serenorg/skills --all`
- List Seren skills: `npx skills add serenorg/skills --list`

## Using Seren Docs With an LLM

Give a web-enabled LLM the URL of the most relevant Seren documentation page as its starting point. Ask it to read this `/llms.txt` index to discover related product and guide pages, then use `/llms-full.txt` or `/openapi.json` when it needs exact API details. Stable operation pages use `/api/operations/{operation_id}` and link back to the interactive explorer.

The rendered docs include a "Copy for LLM" action that creates this prompt with absolute URLs for the current deployment.

## Service Skills

Use these live Markdown skill files for concise service-specific workflows and guidance. Use the documentation pages for product context and `/openapi.json` when exact paths, parameters, or schemas matter.

- [Seren API skill](https://api.serendb.com/skill.md): authentication, signup, account recovery, publisher discovery, and platform-level API workflows.
- [Seren Agent skill](https://api.serendb.com/publishers/seren-agent/skill.md): the agent APIs underlying Seren Employees.
- [Seren Cloud skill](https://api.serendb.com/publishers/seren-cloud/skill.md): hosted deployments and runtime workflows.
- [Seren DB skill](https://api.serendb.com/publishers/seren-db/skill.md): branchable Postgres workflows.
- [Seren Memory skill](https://api.serendb.com/publishers/seren-memory/skill.md): private memory and organizational knowledge workflows.
- [Seren Models skill](https://api.serendb.com/publishers/seren-models/skill.md): public model routing workflows.
- [Seren Notes skill](https://api.serendb.com/publishers/seren-notes/skill.md): notes, search, sharing, and attachment workflows.
- [Seren Passwords skill](https://api.serendb.com/publishers/seren-passwords/skill.md): vault-backed credential workflows.
- [Seren Skills skill](https://api.serendb.com/publishers/seren-skills/skill.md): skill bundle, version, file, and download workflows.

## API Reference Formats

Seren publishes one merged OpenAPI 3.1 document for all services. There are not separate OpenAPI files for each product. Use the service path prefixes below to locate a product within the shared contract.

- Interactive API explorer: `/api`
- Canonical OpenAPI contract: `/openapi.json`
- Complete generated text reference: `/llms-full.txt`
- Stable human-readable operation page: `/api/operations/{operation_id}`
- OpenAPI schema browser: `/schemas`
- Machine-readable schema index: `/schemas/index.json`

## Service API References

- Seren Employees: product docs `/employees`; concepts `/how-seren-works`; best practices `/best-practices`; filtered API explorer `/api?q=/publishers/seren-agent`; shared OpenAPI path prefix `/publishers/seren-agent/*`; managed agent guide `/guides/configure-a-managed-employee`. Seren Employees are the product, while the technical APIs use managed agent and Seren Agent terminology.
- Organization collaboration: guide `/guides/use-organizational-knowledge`; policy API `/api/operations/get_employee_collaboration_policy`; assignment API `/api/operations/list_employee_collaboration_assignments`; management path prefixes `/organizations/{organization_id}/employee-collaboration-policy` and `/organizations/{organization_id}/employee-collaboration/assignments/*`.
- Seren Cloud: filtered API explorer `/api?q=/publishers/seren-cloud`; shared OpenAPI path prefix `/publishers/seren-cloud/*`. These APIs cover deployments, runs, sessions, approvals, evaluations, schedules, environments, audit records, connectors, and deployment storage.
- Seren Auth: filtered API explorer `/api?q=/auth`; shared OpenAPI path prefix `/auth/*`. These APIs cover users, agent accounts, sessions, email verification, password reset, and organization invitations.
- Seren Passwords: product docs `/passwords`; credential guide `/guides/grant-a-credential`; filtered API explorer `/api?q=/publishers/seren-passwords`; shared OpenAPI path prefix `/publishers/seren-passwords/*`; managed-agent setup paths `/organizations/{organization_id}/managed-agent-secrets/setups*`. User-facing docs use Passwords and Employee, while technical contracts use Secrets and managed agent.
- Seren Skills: product docs `/skills`; filtered API explorer `/api?q=/publishers/seren-skills`; shared OpenAPI path prefix `/publishers/seren-skills/*`.
- Seren Memory: product docs `/memory`; agent hooks and claude-mem migration `/cli#memory-hooks` and `/cli#claude-mem-migration`; filtered API explorer `/api?q=/publishers/seren-memory`; shared OpenAPI path prefix `/publishers/seren-memory/*`; private memory guide `/guides/store-and-recall-memory`; organizational knowledge guide `/guides/use-organizational-knowledge`.
- Seren DB: product docs `/db`; filtered API explorer `/api?q=/publishers/seren-db`; shared OpenAPI path prefix `/publishers/seren-db/*`; branching guide `/guides/branch-a-database`.
- Seren Storage: product docs `/storage`; filtered API explorer `/api?q=/publishers/seren-storage`; shared OpenAPI path prefix `/publishers/seren-storage/*`.
- Seren Notes: filtered API explorer `/api?q=/publishers/seren-notes`; shared OpenAPI path prefix `/publishers/seren-notes/*`.
- Seren Models: filtered API explorer `/api?q=/publishers/seren-models`; shared OpenAPI path prefix `/publishers/seren-models/*`.
- Seren Private Models: filtered API explorer `/api?q=/publishers/seren-private-models`; shared OpenAPI path prefixes `/publishers/seren-private-models/*`, `/publishers/seren-agent/private-models`, and `/organizations/{organization_id}/private-models-policy`.
- Publisher platform: filtered API explorer `/api?q=/publishers`; shared OpenAPI paths `/publishers/*` plus related billing, payment, and wallet operations. Publisher guides are intentionally not part of the public navigation yet; use the API contract as the source of truth.

## Authentication

Use a Seren API key as a bearer token:

```http
Authorization: Bearer your_seren_api_key
```

The docs API explorer can show demo responses without credentials. Paste a user-owned API key on the page to run live GET requests through the docs proxy.

Hosted MCP uses browser-based OAuth and does not require copying an API key into the assistant. CLI automation and SDK applications can use `SEREN_API_KEY`; all SDKs and the CLI support `SEREN_API_BASE` when a non-default API host is required.