Skip to main content
Sanity
v1.0.0
33 actions · 2 auth methods
DocumentsIAM

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Token

Connect with a Sanity project robot token (project > API > Tokens) using the Developer permission, which grants access t…

Connector Profile · OAuth 2.0

Recommended for multi-user apps acting on behalf of Sanity users. Requires OAuth client credentials that Sanity provisio…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Token

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
33 actions
Action
Description
Query Documents
Query documents with GROQ
Get Document
Get a document by ID
Mutate Documents
Create, update, patch or delete documents
Export Dataset
Export all documents in a dataset
Get Document History
Get the revision history of a document
Upload Image Asset
Upload an image asset
Upload File Asset
Upload a file asset
Link Media Library Asset
Link a Media Library asset into a dataset
List Projects
List projects
Get Project
Get a project by ID
List Datasets
List datasets
Create Dataset
Create a dataset
Update Dataset
Update a dataset
Delete Dataset
Delete a dataset
Copy Dataset
Copy a dataset
List Dataset Copy Jobs
List dataset copy jobs
List Dataset Tags
List tags assigned to a dataset
Create Tag
Create a project tag
Update Tag
Update a project tag
Delete Tag
Delete a project tag
Assign Tag To Dataset
Assign a tag to a dataset
Remove Tag From Dataset
Remove a tag from a dataset
List Access Users
List users and their roles
Get Access User
Get a user and their roles
Replace User Roles
Replace the set of roles assigned to a user
List Permissions
List available permissions
Get Permission
Get a permission by name
List Roles
List assignable roles
Get Role
Get a role by name
List Invites
List invites for a resource
Create Invite
Invite a user to a resource
Revoke Invite
Revoke an invite
List Access Requests
List access requests for the project