Customer StoriesReadMe Blog
API Reference

Upload specification

post
https://dash.readme.com/api/v1/api-specification

Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/main/docs/rdme.

❗

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
file

An OpenAPI/Swagger file. We accept JSON or YAML.

url

A public URL to an OpenAPI/Swagger definition. We accept JSON or YAML.

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
201

The API specification was successfully uploaded.

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