Create doc

Create a new doc inside of this project

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. The available types all show up under the /docs/ URL path of your docs project (also known as the "guides" section). Can be "basic" (most common), "error" (page desribing an API error), or "link" (page that redirects to an external link)

Allowed:
string

Body content of the page, formatted in ReadMe or GitHub flavored Markdown. Accepts long page content, for example, greater than 100k characters

string
required

Category ID of the page, which you can get through https://docs.readme.com/reference/categories#getcategory

boolean
Defaults to true

Visibility of the page

integer
Defaults to 999

The position of the page in your project sidebar.

string

For a subpage, specify the parent doc ID, which you can get through https://docs.readme.com/reference/docs#getdoc

error
object
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/reference/version#getversions.

Responses
201

The doc has successfully been created

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