API Reference
  1. ReadMe API
  2. Recipes

Create a recipe

post
https://api.readme.com/v2/branches//recipes

Create a new recipe in your ReadMe project.

📘

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required
(v{0,1})(stable|\bmain(?:-[a-z]{2})?(?![\w.-])|([0-9]+)(?:\.([0-9]+))?(?:\.([0-9]+))?(-.*)?)(_(.*))?

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

Body Params
appearance
object
connections
object
content
object
required
string | null
required
privacy
object
string
required
Headers
string

The project subdomain. Required with an OAuth token. With an API key, must match the key’s project if supplied.

Response

Updated 6 months ago

Did this page help you?
Language
Credentials
LoadingLoading

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

Updated 6 months ago

Did this page help you?