> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cessy.ai/runtime-api-template/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cessy.ai/_mcp/server.

# Runtime API Template Summary

> Summary shown before the generated Runtime API template reference.

This generated API block is a template for the Cessy Runtime REST surface. Real app endpoint names and schemas are generated from that app's published DomainConfig, with shared platform endpoints for safe agent discovery, channels, and user channel views.

For a specific app, fetch:

```text
/api/rest/<tenant-id>/<app-id>/openapi
```

Add `?workspaceId=<workspace-id>` with normal Runtime bearer authentication to
inspect that unpublished Workspace runtime source. Production OpenAPI remains
public metadata.

Use the generated app contract as the source of truth for commands, projections,
safe agent metadata, channel interaction, batch execution, event import,
projection rebuild, auth, request bodies, and response envelopes. Agent catalog
reads use normal Runtime authentication; channel and user-channel-view calls
require a delegated user bearer token. A Workspace catalog can contain
preview-only agents, while new DMs still resolve their target from the
published app configuration.

Default projection reads mask secret-bearing fields recursively. Numeric
`maxTokens`, `maxInputTokens` and `maxOutputTokens` remain numbers when finite
and non-negative. Named credential-slot references in fields ending in
`credentialSlot`, `credentialSlotRef` or `credentialSlotName` remain readable
as `null` or 1–128-character identifiers beginning with an ASCII letter and
containing only letters, digits, `_`, `.` and `-`. Snake-case spellings follow
the same rules. Additional secret markers in a field name still cause masking;
credential objects, passwords, keys and bearer tokens remain protected. Store
only slot names in these reference fields, never credential values.

Malformed command payloads return HTTP 400 validation errors before
resource-state loading or execution. Valid payloads still pass command
authorization against the declared resource state. A preflight validation
failure has no command commit; do not treat a redaction placeholder from a read
as valid write input.

> Summary shown before the generated Runtime API template reference.


## API Docs

- Runtime API Template > Metadata [Get the generated OpenAPI document for this app](https://docs.cessy.ai/runtime-api-template/metadata/get-generated-open-api.md)
- Runtime API Template > Commands [Execute one command](https://docs.cessy.ai/runtime-api-template/commands/execute-command.md)
- Runtime API Template > Commands [Execute commands in best-effort batch](https://docs.cessy.ai/runtime-api-template/commands/execute-command-batch.md)
- Runtime API Template > Agents [List safe runtime agent metadata](https://docs.cessy.ai/runtime-api-template/agents/list-runtime-agents.md)
- Runtime API Template > Channels [Open a user-delegated agent DM channel](https://docs.cessy.ai/runtime-api-template/channels/open-agent-dm-channel.md)
- Runtime API Template > Channels [List user-visible app channels](https://docs.cessy.ai/runtime-api-template/channels/list-channels.md)
- Runtime API Template > Channels [Get a user-visible app channel](https://docs.cessy.ai/runtime-api-template/channels/get-channel.md)
- Runtime API Template > Channels [List channel messages](https://docs.cessy.ai/runtime-api-template/channels/list-channel-messages.md)
- Runtime API Template > Channels [Post a user message into a channel](https://docs.cessy.ai/runtime-api-template/channels/post-channel-message.md)
- Runtime API Template > Channels [Close a channel](https://docs.cessy.ai/runtime-api-template/channels/close-channel.md)
- Runtime API Template > User Channel Views [Mark a channel read for the authenticated user](https://docs.cessy.ai/runtime-api-template/user-channel-views/mark-channel-read.md)
- Runtime API Template > User Channel Views [List visible channel views for the authenticated user](https://docs.cessy.ai/runtime-api-template/user-channel-views/list-user-channel-views.md)
- Runtime API Template > Projections [List projection documents](https://docs.cessy.ai/runtime-api-template/projections/list-projection-documents.md)
- Runtime API Template > Projections [Get one projection document](https://docs.cessy.ai/runtime-api-template/projections/get-projection-document.md)
- Runtime API Template > Events [Bulk import events](https://docs.cessy.ai/runtime-api-template/events/import-events.md)
- Runtime API Template > Operations [Rebuild all projections](https://docs.cessy.ai/runtime-api-template/operations/rebuild-projections.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.cessy.ai/openapi.json)
- [OpenAPI YAML](https://docs.cessy.ai/openapi.yaml)