ReadMe

Productivity API key

Manage ReadMe documentation — pages, categories, versions and changelogs — from any Windmill script, flow or app.

Set up in 3 steps

Copy your API key

In ReadMe, open your project's Configuration then API Key, and copy it.

Add the resource in Windmill

Open Resources, add a resource of type readme, and paste the key.

Run your first script

Fork any script below and read before writing anything. There are dozens here, so search by the verb you need.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

readme — the shape of the credential every script on this page expects.

View raw schema →

Field	Type	Required	What it is
apiKey	string	Yes	API key retrieved from the dashboard.

Questions

Which project does it act on?

The one the key belongs to — ReadMe issues a key per project. Managing several means a resource per project.

My change is not visible

Pages belong to a version. Writing to a version that is not the one readers see leaves the live docs unchanged.

Is my key stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.

Set up in 3 steps

Copy your API key

Add the resource in Windmill

Run your first script

Scripts

Validate an API

Upload an image

Updates an existing branch

Update an existing recipe

Update an API key

Update an API definition

Update a reference page

Update a guides page

Update a custom page

Update a changelog entry

Update a category

Submit your application!

Perform a search query

Get your API keys

Get uploaded images

Get the pages within a category

Get project metadata

Get open roles

Get branches

Get an image

Get an API key

Get an API definition

Get all recipes

Get all custom pages

Get all changelog entries

Get all categories

Get all API definitions

Get a reference page

Get a recipe

Get a guides page

Resource type

Questions