Contract
Schemas
The shared contract between the Comitiva desktop, its runner and the hub. Generated from the zod source in @comitiva/contract as JSON Schema draft 2020-12, and served here at their $id.
pinned to v0.3.0source
Entities
- AgentA persistent persona: connection, model, role, tools, folders and permission policy.comitiva.dev/schema/Agent.json
- ConnectionA way to reach an LLM: an API provider or a CLI harness, with a secret reference.comitiva.dev/schema/Connection.json
- ConversationA thread with one agent, its status and the harness session it resumes.comitiva.dev/schema/Conversation.json
- MessageA user, assistant or tool message whose content is a list of blocks.comitiva.dev/schema/Message.json
- ToolServerAn MCP server: stdio or http, built-in or registered by the user.comitiva.dev/schema/ToolServer.json
- ToolApprovalA decision on a tool call: allow, deny or allow-always.comitiva.dev/schema/ToolApproval.json
- UsageRecordTokens, cost and latency of one run, costed when written.comitiva.dev/schema/UsageRecord.json
- UsagePolicyDaily token and cost limits, concurrency and a time window for a connection.comitiva.dev/schema/UsagePolicy.json
Content and errors
Runner protocol
Other
- AgentLinkcomitiva.dev/schema/AgentLink.json
- AttachmentBlockcomitiva.dev/schema/AttachmentBlock.json
- AttachmentInputcomitiva.dev/schema/AttachmentInput.json
- Guidelinecomitiva.dev/schema/Guideline.json
- HubAuthResultcomitiva.dev/schema/HubAuthResult.json
- HubConversationDraftcomitiva.dev/schema/HubConversationDraft.json
- HubConversationPatchcomitiva.dev/schema/HubConversationPatch.json
- HubConversationSummarycomitiva.dev/schema/HubConversationSummary.json
- HubErrorBodycomitiva.dev/schema/HubErrorBody.json
- HubEventcomitiva.dev/schema/HubEvent.json
- HubLoginInputcomitiva.dev/schema/HubLoginInput.json
- HubMetacomitiva.dev/schema/HubMeta.json
- HubRegisterInputcomitiva.dev/schema/HubRegisterInput.json
- HubRunApprovalInputcomitiva.dev/schema/HubRunApprovalInput.json
- HubRunEventsInputcomitiva.dev/schema/HubRunEventsInput.json
- HubRunFinishInputcomitiva.dev/schema/HubRunFinishInput.json
- HubRunFinishResultcomitiva.dev/schema/HubRunFinishResult.json
- HubRunStartInputcomitiva.dev/schema/HubRunStartInput.json
- HubRunStartResultcomitiva.dev/schema/HubRunStartResult.json
- HubUsageRecordcomitiva.dev/schema/HubUsageRecord.json
- HubUsercomitiva.dev/schema/HubUser.json
- Invitationcomitiva.dev/schema/Invitation.json
- InvitationCreatedcomitiva.dev/schema/InvitationCreated.json
- InvitationDraftcomitiva.dev/schema/InvitationDraft.json
- InvitationPreviewcomitiva.dev/schema/InvitationPreview.json
- Membercomitiva.dev/schema/Member.json
- MemberPatchcomitiva.dev/schema/MemberPatch.json
- MessagePagecomitiva.dev/schema/MessagePage.json
- SearchResultcomitiva.dev/schema/SearchResult.json
- SharedAgentcomitiva.dev/schema/SharedAgent.json
- SharedAgentDraftcomitiva.dev/schema/SharedAgentDraft.json
- SharedAgentPatchcomitiva.dev/schema/SharedAgentPatch.json
- UsageBucketcomitiva.dev/schema/UsageBucket.json
- UsageSummarycomitiva.dev/schema/UsageSummary.json
- UsageTotalscomitiva.dev/schema/UsageTotals.json
- Workspacecomitiva.dev/schema/Workspace.json
- WorkspaceDraftcomitiva.dev/schema/WorkspaceDraft.json
- WorkspaceToolServercomitiva.dev/schema/WorkspaceToolServer.json
- WorkspaceToolServerDraftcomitiva.dev/schema/WorkspaceToolServerDraft.json
- WorkspaceToolServerPatchcomitiva.dev/schema/WorkspaceToolServerPatch.json
Validate with any draft 2020-12 validator. Schemas are generated from the input side of zod, so fields with defaults are optional: this is what external producers must send. These files change only when comitiva.dev moves to a newer comitiva release.