Request a change

post

https://api.slite.com/v1/change-requests

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

command

string

required

length between 1 and 50000

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

editableNoteIds

array of strings

required

length between 1 and 20

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

editableNoteIds*

sourceRoots

array of objects

length ≤ 20

Where the agent may search. Without roots it does not search at all and
works from the command and the editable docs only.

sourceRoots

audienceUserIds

array of strings

length ≤ 20

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

audienceUserIds

assigneeUserId

string

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.

title

string

length ≤ 120

The request's title until the agent names it.

Responses

201Created

401Invalid authentication

402Your workspace has run out of AI credits

403Change requests are not enabled for this workspace

422Input validation error

429Rate limitation error, or too many change requests in progress

defaultUnexpected error