readme.io

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

🔑 basic 31 endpoints developer_tools

No SDKs indexed for this API yet.

curl examples

Get metadata about the current project

curl \
  -u "$API_USER:$API_PASS" \
  https://dash.readme.io/api/v1/

Get errors

curl \
  -u "$API_USER:$API_PASS" \
  https://dash.readme.io/api/v1/errors

Get versions

curl \
  -u "$API_USER:$API_PASS" \
  https://dash.readme.io/api/v1/version

Endpoints (31 total)

GET

Get metadata about the current project

GET

/errors

Get errors

GET

/version

Get versions

GET

/changelogs

Get changelogs

GET

/custompages

Get custom pages

GET

/docs/{slug}

Get doc

GET

/api-specification

Get API specification metadata

GET

/categories/{slug}

Get category

GET

/changelogs/{slug}

Get changelog

GET

/custompages/{slug}

Get custom page

GET

/version/{versionId}

Get version

GET

/categories/{slug}/docs

Get docs for category

Related APIs in same category