Create a reference page

post

https://api.readme.com/v2/branches/{branch}/reference

Create a page in the API Reference section of your ReadMe project.

📘
This route is only available to projects that are using ReadMe Refactored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

branch

string

required

Project version number, stable for your project's stable version, or a valid branch name.

Body Params

allow_crawlers

string

enum

Defaults to enabled

Allow indexing by robots.

Allowed:

appearance

object

category

object

required

content

object

metadata

object

parent

object

privacy

object

slug

string

length ≥ 1

The accessible URL slug for the page.

state

string

enum

Defaults to current

Allowed:

title

string

required

type

string

enum

Defaults to basic

Allowed:

connections

object

position

number

api_config

string | null

enum

Allowed:

api

object

Headers

prefer

string

By default, the supplied slug will be made unique during reference creation if it already exists, however if you do not want this behavior you can supply prefer: handling=strict to receive a 409 Conflict instead.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created