Customer StoriesReadMe Blog
API Reference

Create doc

post
https://dash.readme.com/api/v1/docs

Create a new doc inside of this project.

❗

API v1 and this route are not available to projects that are using ReadMe Refactored. Check out our API migration guide for information on how to migrate to the new API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Title of the page.

string
enum

Type of the page. This can be one of the following:

  • basic (most common)
  • link (page that redirects to an external link)
  • error (page describing an API error) [DEPRECATED]
Allowed:
string

Body content of the page, formatted in ReadMe-flavored Markdown.

string
required

Category ID of the page, which you can get through the Get all categories endpoint.

boolean

Visibility of the page.

integer

The position of the page in your project sidebar.

string

The parent doc's ID, if the page is a subpage.

error
object
deprecated

This is used for docs with the type set to error. The error page type and this error object have been deprecated.

string

The slug of the category this page is associated with. You can get this through the Get all categories endpoint. This field is an alternative to the category field.

string

If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the parentDoc field.

Headers
string

Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago