# API Endpoints API

> API Endpoints API on Apizie: 28 endpoints (Get metadata about the current project, Get API specification metadata, Upload an API specification to ReadMe. Or, to use a newer solution see…, Update an API specification in ReadMe, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/dev-tools:readme/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:readme`
- Category: Dev Tools
- Status: byok
- Source: https://readme.io
- Page: https://zieapi.vercel.app/api/dev-tools/readme
- OpenAPI: https://zieapi.vercel.app/api/dev-tools/readme/openapi.json

Create beautiful product and API documentation with our developer friendly platform.

## Endpoints

### Get metadata about the current project
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-project` (byok)

### Get API specification metadata
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-apispecification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| perPage | integer | no | Number of items to include in pagination (up to 100, defaults to 10) |
| page | integer | no | Used to specify further pages (starts at 1) |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Upload an API specification to ReadMe. Or, to use a newer solution see…
`POST https://zieapi.vercel.app/v1/dev-tools:readme/upload-apispecification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |
| body | object | yes | Form fields as a JSON object |

### Update an API specification in ReadMe
`POST https://zieapi.vercel.app/v1/dev-tools:readme/update-apispecification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page. |
| body | object | yes | Form fields as a JSON object |

### Delete an API specification in ReadMe
`POST https://zieapi.vercel.app/v1/dev-tools:readme/delete-apispecification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page. |

### Get category
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of category. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the the category "Getting Started", enter… |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Get docs for category
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-category-docs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of category. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the the category "Getting Started", enter… |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Get changelogs
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-changelogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| perPage | integer | no | Number of items to include in pagination (up to 100, defaults to 10) |
| page | integer | no | Used to specify further pages (starts at 1) |

### Create changelog
`POST https://zieapi.vercel.app/v1/dev-tools:readme/create-changelog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get changelog
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-changelog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of changelog |

### Update changelog
`POST https://zieapi.vercel.app/v1/dev-tools:readme/update-changelog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of changelog |
| body | object | yes | JSON request body |

### Delete changelog
`POST https://zieapi.vercel.app/v1/dev-tools:readme/delete-changelog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of changelog |

### Get custom pages
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-custom-pages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| perPage | integer | no | Number of items to include in pagination (up to 100, defaults to 10) |
| page | integer | no | Used to specify further pages (starts at 1) |

### Create custom page
`POST https://zieapi.vercel.app/v1/dev-tools:readme/create-custom-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get custom page
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-custom-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of custom page |

### Update custom page
`POST https://zieapi.vercel.app/v1/dev-tools:readme/update-custom-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of custom page |
| body | object | yes | JSON request body |

### Delete custom page
`POST https://zieapi.vercel.app/v1/dev-tools:readme/delete-custom-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of custom page |

### Create doc
`POST https://zieapi.vercel.app/v1/dev-tools:readme/create-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |
| body | object | yes | JSON request body |

### Search docs
`POST https://zieapi.vercel.app/v1/dev-tools:readme/search-docs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | yes | Search string to look for |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Get doc
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of doc. must be lowercase, and replace spaces with hyphens. For example, for the page titled "New Features", enter the slug… |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Update doc
`POST https://zieapi.vercel.app/v1/dev-tools:readme/update-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of doc. must be lowercase, and replace spaces with hyphens. For example, for the page titled "New Features", enter the slug… |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |
| body | object | yes | JSON request body |

### Delete doc
`POST https://zieapi.vercel.app/v1/dev-tools:readme/delete-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Slug of doc. must be lowercase, and replace spaces with hyphens. For example, for the page titled "New Features", enter the slug… |
| x-readme-version | string | yes | Version number of your docs project, for example, v3.0. To see all valid versions for your docs project call… |

### Get errors
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-errors` (byok)

### Get versions
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-versions` (byok)

### Create version
`POST https://zieapi.vercel.app/v1/dev-tools:readme/create-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get version
`GET https://zieapi.vercel.app/v1/dev-tools:readme/get-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| versionId | string | yes | Semver version indentifier |

### Update version
`POST https://zieapi.vercel.app/v1/dev-tools:readme/update-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| versionId | string | yes | Semver version indentifier |
| body | object | yes | JSON request body |

### Delete version
`POST https://zieapi.vercel.app/v1/dev-tools:readme/delete-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| versionId | string | yes | Semver version indentifier |

## Example
```
curl "https://zieapi.vercel.app/v1/dev-tools:readme/get-project" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the API Endpoints API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/dev-tools:readme/get-project with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the API Endpoints API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. API Endpoints itself also needs your own key from readme.io.

### Can AI agents use the API Endpoints API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:readme.

### What is the status of the API Endpoints API?
Needs your own provider key (bring your own key)