canonical: https://jentic.com/apis/readme.io/api-endpoints

# Readme API Endpoints

Create beautiful product and API documentation with our developer friendly platform. The API exposes 31 endpoints secured with basic authentication.

## For AI agents

Programmatically get metadata about the current project, uploadapispecification. Covers 31 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Get metadata about the current project
- uploadAPISpecification
- updateAPISpecification
- deleteAPISpecification
- Access API Endpoints e commerce resources via REST API

## Use cases

### E-Commerce Operations

Use the API Endpoints to perform e commerce operations programmatically. The API provides 31 endpoints covering core functionality including get metadata about the current project, uploadapispecification, getapispecification.

Example prompt: Call GET / to get metadata about the current project

### Automated API Specification Management

Automate API specification operations by combining multiple API Endpoints endpoints. Agents can uploadapispecification and then getapispecification in a single workflow.

Example prompt: Call POST /api-specification to uploadapispecification, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Endpoints 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 basic tokens manually.

Example prompt: Search Jentic for 'get metadata about the current project', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | / | Get metadata about the current project |
| POST | /api-specification | uploadAPISpecification |
| GET | /api-specification | getAPISpecification |
| PUT | /api-specification/{id} | updateAPISpecification |
| DELETE | /api-specification/{id} | deleteAPISpecification |
| GET | /categories/{slug} | Get category |
| GET | /categories/{slug}/docs | Get docs for category |
| POST | /changelogs | Create changelog |

## Key resources

- **API Specification** — Operations related to API Specification
- **Categories** — Operations related to Categories
- **Changelog** — Operations related to Changelog
- **Custom Pages** — Operations related to Custom Pages
- **Docs** — Operations related to Docs

## Why Jentic

- **Setup:** Wiring the ReadMe API Endpoints by hand means encoding your key as HTTP basic auth, managing the API specification, category, and changelog resources, and handling paging and retries yourself. Through Jentic you install once, import API Endpoints from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** API Endpoints puts the resource id in the URL path (/api-specification/{id}), so a rule can pin your agent to one specification. You choose the operations it may call, so a destructive one like deleting a specification is not included unless you add it, keeping the agent to reading and updating.
- **Credential handling:** Your API Endpoints basic credential 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 'get metadata about the current project' or 'read a category's docs', and Jentic returns the matching API Endpoints operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the API Endpoints use?

The API Endpoints uses HTTP Basic authentication. 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 get metadata about the current project with the API Endpoints?

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

### What are the rate limits for the API Endpoints?

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 get metadata about the current project through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get metadata about the current project'. Jentic returns the matching API Endpoints operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Endpoints have?

The API Endpoints exposes 31 endpoints covering API specification, categories, changelog operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which API Endpoints operations the agent may call and which credential it uses. You choose the exact operations to expose, so a destructive one like deleting an API specification is left out unless you add it, keeping the agent to reading and updating. Because the resource id sits in the URL path, such as /api-specification/{id}, you can pin the agent to a single specification.