Mailrith Developers
Developer Docs
Everything for Mailrith's public API: quickstarts, platform rules, resource guides, and the generated `v1` reference.
Search results
Matching articles
Getting Started
Quickstart
Create a workspace key and make the first authenticated request against Mailrith's public API.
Getting Started
Authentication
Use workspace-scoped Bearer keys and understand how protected requests are authorized.
Getting Started
Testing the API
Run the local worker, generate a workspace key, exercise the endpoints, and execute automated integration coverage.
Getting Started
Agents
Discover Mailrith from agent runtimes with llms files, API metadata, OpenAPI, and authenticated capability discovery.
Getting Started
SDKs
Use the official TypeScript and Python SDKs generated from Mailrith's public contract.
Getting Started
MCP Server
Connect Mailrith to agent runtimes through the official remote MCP server and streamable HTTP transport.
API Concepts
Pagination
Page through list endpoints with a stable cursor contract.
API Concepts
Errors
Handle stable error envelopes and status codes without depending on internal implementation details.
API Concepts
Idempotency
Retry async job creation safely with the `Idempotency-Key` header.
API Concepts
Versioning
Pin clients to the `v1` path contract and use the OpenAPI spec for upgrade planning.
Resources
Subscribers API
List and upsert subscribers with tags, sequences, and custom-field values.
Resources
Tags API
Read the tag catalog and create tags programmatically for targeting and automation.
Resources
Custom Fields API
Read the typed custom-field schema available to the authenticated workspace.
Resources
Forms API
List Mailrith forms and inspect their definitions and recent subscriber counts.
Resources
Segments API
List saved segments and preview unsaved audience definitions.
Resources
Import and Export Jobs
Create async subscriber import and export jobs and poll them to completion.
Reference
API Reference
Browse the generated endpoint reference and download the OpenAPI contract.
No matching developer docs
Try a different keyword such as a resource name, request pattern, or platform rule like "pagination" or "jobs".