SLslite

Request a change

Changed on

Open a change request: an agent reads the docs you name, turns your command into proposed changes, and leaves them for review. Nothing is applied until a reviewer approves it in Slite. The response comes back as soon as the request is queued, with status: "processing" and the url to hand to the reviewers.

Beta: change requests are not yet available to every workspace. Where they are not enabled, calls fail with 403 and the error id change-request/not-enabled: contact support to have them enabled.

post/change-requests

Request

  • Base URL
    https://api.slite.com/v1
  • Auth
    HTTP bearer

Request body

commandstring required

What to change, in plain words — or the exact content to write, in markdown or sliteml, which the agent reproduces verbatim.

editableNoteIdsstring[] required

The docs the request may change or add sub-docs under. You must be able to edit each of them.

audienceUserIdsstring[]

Who reviews the request besides you. Each of them must be able to read every editable doc and every doc root.

assigneeUserIdstring

Who the request is assigned to: you or a member of the audience who can edit every editable doc. Defaults to you; required when your account cannot review change requests, such as a service account.

titlestring

The request's title until the agent names it.

Response

Created

createdAtstring date-time required
audienceUserIdsstring[] required
assigneeUserIdstring nullable required
threadIdstring nullable required

The agent thread behind the request; null if it never started.

urlstring required

The change request in the app, to hand to the people who review it.

status'processing' | 'pending_review' | 'completed' | 'no_changes' | 'failed' required
idstring required
retryAfterSecondsnumber double

While processing: when to check again.

Changes