canonical: https://jentic.com/apis/realworld-docs.netlify.app/realworld-docs-netlify

# Realworld Docs RealWorld Conduit API

Conduit API documentation. The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically existing user login, createuser. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Existing user login
- CreateUser
- Get current user
- Update current user
- Follow a user
- Unfollow a user

## Use cases

### Developer Tools Operations

Use the RealWorld Conduit API to perform developer tools operations programmatically. The API provides 19 endpoints covering core functionality including existing user login, createuser, get current user.

Example prompt: Call POST `/users/login` to existing user login

### Automated Articles Management

Automate articles operations by combining multiple RealWorld Conduit API endpoints. Agents can createuser and then get current user in a single workflow.

Example prompt: Call POST /users to createuser, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call RealWorld Conduit API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'existing user login', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/users/login` | Existing user login |
| POST | `/users` | CreateUser |
| GET | `/user` | Get current user |
| PUT | `/user` | Update current user |
| GET | `/profiles/{username}` | Get a profile |
| POST | `/profiles/{username}/follow` | Follow a user |
| DELETE | `/profiles/{username}/follow` | Unfollow a user |
| GET | `/articles/feed` | Get recent articles from users you follow |

## Key resources

- **Articles** — Operations related to Articles
- **Comments** — Operations related to Comments
- **Favorites** — Operations related to Favorites
- **Profile** — Operations related to Profile
- **Tags** — Operations related to Tags

## Why Jentic

- **Setup:** Wiring the RealWorld Conduit API by hand means passing its Token in the Authorization header, managing login and registration, and handling profiles, follows, and the article feed yourself. Through Jentic you install once, import the RealWorld Conduit API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The RealWorld Conduit API acts on the authenticated user and identifies profiles by username in the path, so you limit the agent to the operations it needs, such as reading a profile or the article feed. It only calls the operations you allow, so following or unfollowing a profile is out of scope unless you add it.
- **Credential handling:** Your RealWorld Conduit API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'log in an existing user' or 'get the article feed', and Jentic returns the matching RealWorld Conduit API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the RealWorld Conduit API use?

The RealWorld Conduit API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I existing user login with the RealWorld Conduit API?

Yes. Use the POST `/users/login` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the RealWorld Conduit API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I existing user login through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'existing user login'. Jentic returns the matching RealWorld Conduit API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the RealWorld Conduit API have?

The RealWorld Conduit API exposes 19 endpoints covering articles, comments, favorites operations.

### Can I limit what my agent is allowed to do with the RealWorld Conduit API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which RealWorld Conduit API operations and credentials your agent can use, and it only calls the operations you allow. Since the API acts on the authenticated user and identifies profiles by username in the path, you can restrict the agent to read-only operations such as getting a profile or the article feed. Write actions like following or unfollowing a profile stay out of scope unless you explicitly grant them.