The Slite API lets developers connect other software to Slite and automate actions in your workspace.
How the Slite API works
Here are some examples of the things you can do with the API:
- List and search Slite docs and subdocs
- List recently visited or edited docs
- Create new docs
- Replace doc contents
- Update existing doc contents
- Create, update, and replace docs in a collection
- List docs owned by a certain user id
- Archive and unarchive docs
- Change doc owners
- Retrieve users and get their id to then set the owner on a doc
Technical details
The Slite endpoint is:
https://api.slite.com/v1/{path}.We are using the Open API v3.0 standard to facilitate usage of our API. If you prefer a different viewer, you can find the json spec here .
The rate limit for the Slite API is 120 calls per minute. If you need to have it raised, contact support@slite.com .
Get your API key
Every call to our public API has to be authenticated with a personal API key, generated in your Slite settings.
To get your personal API key:
Click your workspace logo in the top-left corner.
Select
Settings from the menu, then go to the API section.Click
Create a new key and follow the on-screen instructions. You'll see an option to make the key read-only.
The API key will only be displayed once, so make sure to save it in a safe place. You can request multiple API keys and revoke any that are not being used.
Authenticate
To authenticate your requests, you need to pass the newly created key as an
x-slite-api-key header:curl --location 'https://api.slite.com/v1/notes' \--header 'Content-Type: application/json' \--header 'Accept: application/json' \--header 'x-slite-api-key: <API Key>' \--data '{"title": "<string>","parentNoteId": "<string>","templateId": "<string>","markdown": "<string>","attributes": ["<string>","<string>"]}'
Some examples and re-usable scripts based on Slite API
Make sure to review and customise these examples for your needs.
