API reference
MarkdownThis reference is generated from the OpenAPI document. Endpoints marked Coming soon do not exist yet, are not a stable contract, and may change before launch. Endpoints marked Deployment option are optional: where a deployment does not enable them, they return 404.
| Base URL | https://api.mirabase.dev |
|---|---|
| OpenAPI | https://api.mirabase.dev/v2/openapi.yaml |
| Spec version | 2.0.0 (33c172f77f2c) |
| Status | 115 implemented by default, 12 implemented as a deployment option, 3 coming soon |
Common headers
Every endpoint accepts the headers below. Authenticated responses carry RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset: see Rate limits and quotas. The rules for pagination, idempotency, conditional requests, jobs, and errors are in API conventions, and every error code is listed in Error codes.
| Field | Type | Description |
|---|---|---|
Mirabase-Contract-Version | string | Explicit contract version to negotiate. Omit to use the current compatible contract. |
X-Request-Id | string | Caller correlation id. The service replaces an invalid value with one it issues. |
Endpoint groups
Spaces
- GET
/v2/spacesList Spaces - POST
/v2/spacesCreate a Space - GET
/v2/spaces/{space_id}Read a Space - PUT
/v2/spaces/{space_id}Get or create a Space by your own id - PATCH
/v2/spaces/{space_id}Update a Space - DELETE
/v2/spaces/{space_id}Delete a Space - GET
/v2/spaces/{space_id}/membersList members - PUT
/v2/spaces/{space_id}/members/{principal_id}Set a member - DELETE
/v2/spaces/{space_id}/members/{principal_id}Remove a member - GET
/v2/spaces/{space_id}/processingRead a Space's processing progress
Files
- GET
/v2/spaces/{space_id}/filesRead a file - HEAD
/v2/spaces/{space_id}/filesRead a file's headers - PUT
/v2/spaces/{space_id}/filesWrite a file - PATCH
/v2/spaces/{space_id}/filesEdit a file's text - DELETE
/v2/spaces/{space_id}/filesDelete a file - POST
/v2/spaces/{space_id}/files/batchWrite and delete in a batch - GET
/v2/spaces/{space_id}/files/content-urlGet a file's download URL - GET
/v2/spaces/{space_id}/files/diffDiff versions by path - GET
/v2/spaces/{space_id}/files/lineageRead lineage by path - POST
/v2/spaces/{space_id}/files/revertRevert by path - GET
/v2/spaces/{space_id}/files/versionsList versions by path
Proposals
- GET
/v2/proposals/{proposal_id}Read a proposal - POST
/v2/proposals/{proposal_id}/approveApprove a proposal - GET
/v2/proposals/{proposal_id}/diffDiff a proposal - POST
/v2/proposals/{proposal_id}/rejectReject a proposal - POST
/v2/proposals/{proposal_id}/withdrawWithdraw a proposal - GET
/v2/spaces/{space_id}/proposalsList proposals
Webhooks
- GET
/v2/spaces/{space_id}/webhooksList webhooks - POST
/v2/spaces/{space_id}/webhooksCreate a webhook - GET
/v2/webhooks/{webhook_id}Read a webhook - PATCH
/v2/webhooks/{webhook_id}Update a webhook - DELETE
/v2/webhooks/{webhook_id}Delete a webhook - GET
/v2/webhooks/{webhook_id}/deliveriesList deliveries - POST
/v2/webhooks/{webhook_id}/rotate-secretRotate a webhook secret
Entries
- GET
/v2/entriesList Entries - GET
/v2/entries/{entry_id}Read an Entry - PATCH
/v2/entries/{entry_id}Update an Entry - DELETE
/v2/entries/{entry_id}Move an Entry to the trash - GET
/v2/entries/{entry_id}/contentRead an Entry's content - GET
/v2/entries/{entry_id}/content-urlGet an Entry's download URL - GET
/v2/entries/{entry_id}/copiesList copiesComing soon - GET
/v2/entries/{entry_id}/diffDiff versions - GET
/v2/entries/{entry_id}/lineageRead lineage - GET
/v2/entries/{entry_id}/processingRead processing status - POST
/v2/entries/{entry_id}/purgeErase an Entry - POST
/v2/entries/{entry_id}/reprocessReprocess an Entry - POST
/v2/entries/{entry_id}/restoreRestore an Entry - POST
/v2/entries/{entry_id}/revertRevert to an older version - GET
/v2/entries/{entry_id}/versionsList versions - GET
/v2/entries/{entry_id}/versions/{version_id}Read a version - PATCH
/v2/entries/{entry_id}/versions/{version_id}/messageUpdate a version message - POST
/v2/spaces/{space_id}/trash/purgeEmpty the trash
Memories
- GET
/v2/memoriesList memories - POST
/v2/memoriesCreate a memory - GET
/v2/memories/{memory_id}Read a memory - PATCH
/v2/memories/{memory_id}Update a memory - DELETE
/v2/memories/{memory_id}Forget a memory - POST
/v2/memories/{memory_id}/correctCorrect a memory - GET
/v2/memories/{memory_id}/provenanceRead a memory's provenance - POST
/v2/memories/{memory_id}/reviewReview a memory - POST
/v2/memories/{memory_id}/undoUndo a memory write
Memory dreaming
- GET
/v2/memory/dreams/{dream_id}Read a dream's reportDeployment option - GET
/v2/memory/dreams/{dream_id}/actionsList a dream's actionsDeployment option - GET
/v2/memory/dreams/{dream_id}/judgmentsList a dream's judgmentsDeployment option - POST
/v2/memory/dreams/{dream_id}/undoUndo a dreamDeployment option - GET
/v2/memory/proposals/{proposal_id}Read a memory proposalDeployment option - POST
/v2/memory/proposals/{proposal_id}/approveApprove a memory proposalDeployment option - POST
/v2/memory/proposals/{proposal_id}/rejectReject a memory proposalDeployment option - GET
/v2/spaces/{space_id}/memory/dreamsList dreamsDeployment option - POST
/v2/spaces/{space_id}/memory/dreamsStart a dreamDeployment option - GET
/v2/spaces/{space_id}/memory/proposalsList memory proposalsDeployment option - GET
/v2/spaces/{space_id}/memory/settingsRead the consolidation settingDeployment option - PATCH
/v2/spaces/{space_id}/memory/settingsChange the consolidation settingDeployment option
Branches
- GET
/v2/spaces/{space_id}/branchesList branches - POST
/v2/spaces/{space_id}/branchesOpen a branch - GET
/v2/spaces/{space_id}/branches/{branch_id}Read a branch - PATCH
/v2/spaces/{space_id}/branches/{branch_id}Rename or renew a branch - DELETE
/v2/spaces/{space_id}/branches/{branch_id}Abandon a branch - GET
/v2/spaces/{space_id}/branches/{branch_id}/checkpointsList checkpoints - POST
/v2/spaces/{space_id}/branches/{branch_id}/checkpointsCreate a checkpoint - GET
/v2/spaces/{space_id}/branches/{branch_id}/diffDiff a branch - POST
/v2/spaces/{space_id}/branches/{branch_id}/mergeMerge a branch - GET
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}Read a branch object - HEAD
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}Check a branch object - PUT
/v2/spaces/{space_id}/branches/{branch_id}/objects/{sha256}Write a branch object - POST
/v2/spaces/{space_id}/branches/{branch_id}/rollbackRoll back to a checkpoint
