canonical: https://jentic.com/apis/readmecom/readmecom

# Readmecom ReadMe API

ReadMe API v1 for managing documentation projects, categories, docs, changelogs, custom pages, versions, and API specifications. The API exposes 36 endpoints secured with basic authentication.

## For AI agents

Programmatically get metadata about the current project, retrieve an entry from the API registry. Covers 36 operations with basic authentication.

## Scope

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

## Capabilities

- Get metadata about the current project
- Retrieve an entry from the API Registry
- Upload an API specification
- Update an API specification
- Delete an API specification
- Create a category

## Use cases

### Developer Tools Operations

Use the ReadMe API to perform developer tools operations programmatically. The API provides 36 endpoints covering core functionality including get metadata about the current project, retrieve an entry from the API registry, upload an API specification.

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

### Automated project Management

Automate project operations by combining multiple ReadMe API endpoints. Agents can retrieve an entry from the API registry and then upload an API specification in a single workflow.

Example prompt: Call GET `/api-registry/{uuid}` to retrieve an entry from the API registry, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ReadMe 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 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 |
| GET | `/api-registry/{uuid}` | Retrieve an entry from the API Registry |
| POST | `/api-specification` | Upload an API specification |
| GET | `/api-specification` | Get API specification metadata |
| PUT | `/api-specification/{id}` | Update an API specification |
| DELETE | `/api-specification/{id}` | Delete an API specification |
| POST | `/categories` | Create a category |
| GET | `/categories` | Get all categories |

## Key resources

- **project** — Operations related to project
- **api-registry** — Operations related to api-registry
- **api-specification** — Operations related to api-specification
- **categories** — Operations related to categories
- **changelogs** — Operations related to changelogs

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 39 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 89 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 55 / 100
- **View full report:** https://jentic.com/apis/readmecom/readmecom/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the ReadMe API by hand means encoding your key as HTTP basic auth, managing the API specification, category, and registry resources, and handling paging and retries yourself. Through Jentic you install once, import the ReadMe API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The ReadMe API 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 ReadMe API 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 'list categories', and Jentic returns the matching ReadMe 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 ReadMe API use?

The ReadMe API 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 ReadMe API?

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 ReadMe 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 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 ReadMe API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The ReadMe API exposes 36 endpoints covering project, api-registry, api-specification operations.

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

Yes. Because you run Jentic One yourself, you decide which ReadMe API operations your agent may call and which stored credential it uses. Since the resource id sits in the URL path, such as `/api-specification/{id}`, your own rules can pin the agent to a single specification and grant it only read and update operations like GET /api-specification and PUT `/api-specification/{id}.` A destructive call such as DELETE `/api-specification/{id}` is excluded unless you explicitly allow it.