Your AI team, working in Sanity

Sanity is a headless CMS platform that provides structured content storage and APIs for modern applications

Start your company

What your team can do in Sanity

24 tools to work with, connected with an API key.

Add Default Role to Users

Apply organization default role to all users. Use when you need to assign the organization's default role to all existing users in the organization. Requires the resource ID of the organization.

Create Attribute Definition

Create a user attribute definition for a Sanity resource with a unique key and a string, number, or boolean type.

Create Prompt Post

Send a one-shot prompt to the Sanity Content Agent without maintaining conversation context. HTTP errors are returned in the response's raw_response field.

Delete Document

Delete a document from Sanity by ID or query. This action is irreversible when purge is true β€” the document cannot be recovered once permanently deleted. Use when you need to remove a specific document by ID or bulk delete documents matching a GROQ query (limited to 10,000 documents per operation). For large deletions, paginate by document ID. Set dry_run to true to test the operation without modifying data.

Delete User Attribute Definition

Delete a user attribute definition. Use when you need to remove a custom attribute definition from an organization or project in Sanity. The attribute definition controls how user attributes are structured and validated for a given resource. Deleting a definition does not delete existing user attribute values, but users will no longer be able to set values for that attribute.

Delete User Attributes

Delete specified custom attributes from a Sanity user within an organization. A 404 or empty response produces an empty attribute list, which does not establish the user's remaining attributes.

Get Document by IDReads only

Fetch a document by ID from a Sanity dataset in the project configured on the connection. The response may instead report that the document was omitted.

Get Invite By TokenReads only

Retrieve an invite by its public token for a specified resource. Returns invite details when found; an HTTP 404 is returned as found=false.

Get Organization RoleReads only

Retrieve a specific organization role by its ID. Use this action when you need to fetch details about an organization role including its permissions, title, description, and whether it applies to users or robots. The role must exist for the specified organization.

Get PermissionReads only

Get a permission for a specific resource. Use when you need to retrieve details about a particular permission including its actions, parameters, and scope. The action retrieves permission information based on the resource type, resource ID, and permission name provided in the path parameters.

Get ProjectReads only

Retrieve details for the Sanity project configured on the connection by its ID, including available project information such as display name, organization, studio host, and timestamps.

Get RobotsReads only

Tool to get robots with access to a resource. Use when you need to retrieve a list of robots (service accounts) that have been granted access to a specific resource along with their assigned roles. This action supports pagination through the next_cursor parameter.

Get RoleReads only

Retrieve a specific role for a given resource type and resource ID. Use this action when you need to fetch details about a role including its permissions, title, description, and whether it applies to users or robots. The role must exist for the specified resource.

List DatasetsReads only

List datasets in the Sanity project configured on the connection, optionally including statistics or filtering by profile or add-on parent.

List Organization RolesReads only

List all roles available for an organization. Use this action to retrieve all available roles that can be assigned to users within a specific Sanity organization. The organization_id is required to identify which organization's roles to list.

List Resource UsersReads only

List all users of a resource and their assigned roles. Use when you need to retrieve user information and role assignments for a specific project or organization. Supports pagination via cursor.

List User AttributesReads only

Tool to retrieve user attributes from a Sanity organization. Use when you need to get the attributes (such as roles, permissions, or custom properties) associated with a specific user in a Sanity organization. Supports pagination via the cursor parameter.

Mutate Documents

Apply or dry-run one atomic batch of create, replace, conditional-create, patch, and delete mutations in a Sanity dataset. Calls commit unless dry_run is true; a delete with purge permanently removes document history.

Query All ScreeningReads only

Execute a GROQ query against a Sanity dataset, defaulting to screening documents. Supports optional query parameters; requests are sent without authentication headers.

Query DocumentsReads only

Execute a GROQ query against a Sanity dataset in the project configured on the connection. Supports optional parameters, perspective control, and CDN use; results can be any JSON value, including arrays, objects, scalars, or null.

Update Organization ACL

Tool to assign a role to a member in a Sanity organization. Use when adding or modifying user roles within an organization.

Update User Attributes Values

Update user attribute values for a resource. Use this action to set or update custom attributes for a user within an organization or project. When setting a value for an attribute key that also exists in SAML, the Sanity value will take precedence and shadow the SAML value.

Upload Image Asset

Upload raw image bytes to a dataset in the connected Sanity project.

Validate CredentialReads only

Validate Sanity API credentials by fetching the authenticated user's information. Use this action when you need to verify that an API token is valid and has proper authentication. This action returns user information and accessible projects if the token is valid.

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or