Conduit API overview
Choose a practical path for consuming, implementing, or validating the shared Conduit API contract.
Conduit is a social blogging application and a shared API specification. Use this documentation to connect a frontend, call the hosted API, or implement a backend that behaves like the reference contract.
The contract keeps those jobs interoperable: a frontend can work with a hosted or local backend, and a backend can be checked against the same request, response, authentication, and error behavior. Start with the path that matches your role, then use the endpoint pages for exact parameters and examples.
Choose your path
What you can do
- Authenticate with registration or login, then send
Authorization: Token <jwt>on protected requests. See Authentication and token usage. - Work with users, profiles, articles, comments, favorites, feeds, and tags through the documented HTTP API. Browse the endpoint index.
- Handle the shared response shapes and field-level error envelope. See Response envelopes and resource models and Error envelope and HTTP status behavior.
- Page article and feed collections with
limitandoffset. See Pagination for articles and feeds. - Connect a frontend to a hosted or local backend, including cross-origin requirements when the hosts differ. See Connect a frontend to Conduit and Configure CORS.
- Check a backend against the behavioral suites with Hurl or Bruno.
How the pieces fit
The same contract sits between the client and the implementation. The hosted demo is a ready-to-use backend; a local implementation can serve the same API paths; the conformance suites exercise the behavior that both sides must share.
The hosted API is available at https://api.realworld.show/api and requires no API key. Its public visibility is limited: logged-out users see demo-account content, while logged-in users see their own content and demo-account content. A local backend gives you control over implementation and test data.