Slite API

Slite API

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:
For most use cases, GET /v1/ask is the recommended way to query your workspace knowledge. It automatically uses the Slite Agent if your workspace has access to it.
  • List and search Slite docs and subdocs
  • Create new docs
  • Replace doc contents
  • Update existing doc contents
  • Set sidebar positions and reorder docs with listPosition
  • 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
  • Retrieve doc subtrees in a single call using includeDescendants=true on the children endpoint
  • Ask questions in natural language via GET /v1/ask — automatically uses the Slite Agent if your workspace has access
  • Export docs in pure XML SliteML ( format=sliteml ) or HTML with css=inline or css=none

Technical details

The Slite endpoint is: https://api.slite.com/v1/{path}.
The full documentation is available  below , or in any open API viewer.
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 recommended endpoint for knowledge queries is GET /v1/ask. It automatically routes to the Slite Agent for workspaces that have access to it. The /v1/super routes are legacy — use /v1/agent for direct agent calls instead.
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 an API key (a personal API key or an Enterprise service account 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 (or as Authorization: Bearer <key>):
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.

https://slite.com/api/public/notes/QU_8zlG3bkAGxo/redirect
Update a doc block with 3rd party data with Slite API