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:
  • List and search Slite docs and subdocs
  • Create new docs
  • Replace doc content
  • Update existing doc content
  • Create, update, and replace docs in a collection

Technical details

  • 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 Slite endpoint is: https://api.slite.com/v1/{path}

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.
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>"
  ]
}'

Example action: Updating a block with external data

We'll showcase here how to sync a Slite block in a doc with external information.
The example block will display the revenue of the last month and latest customers.
    Create a doc in Slite and get its id via the three-dot menu in the top right: click Copy block id.
    Copy the id of the block by clicking the four-dot menu at the beginning of the block and choosing Copy block id.
    Push data via the Update Tile route to update the block:
curl --request PUT \
     --url https://api.slite.com/v1/notes/<Doc id>/tiles/<Block id> \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-slite-api-key: <API key>' \
     --data '
{
  "status": {
    "label": "104%",
    "colorHex": "#7FFF00"
  },
  "title": "Revenue for September 2023 - 340k
quot;,
  "content": "- Latest customers: Acme (3k$ MRR), Fijo (5k$ MRR) - Goal for the month was: 332k$ - Growth: 8% MoM",
  "url": "https://dashboard.revenu"
}
'
    Check your new enriched block with external data