21 available actions
What your AI agent can do in Sanity
Sanity is a headless CMS platform that provides structured content storage and APIs for modern applications This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 21 actions.
Common starting points
- Get Invite By TokenRetrieve an invite by its public token.
- Get Organization RoleRetrieve a specific organization role by its ID.
- Add Default Role to UsersApply organization default role to all users.
- Create Attribute DefinitionTool to create a new user attribute definition in Sanity.
- Update User Attributes ValuesUpdate user attribute values for a resource.
- Update Organization ACLTool to assign a role to a member in a Sanity organization.
Browse all 21 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 12 actions
- Get Document by IDFetch a single document by its ID from Sanity.
- Get Invite By TokenRetrieve an invite by its public token.
- Get Organization RoleRetrieve a specific organization role by its ID.
- Get PermissionGet a permission for a specific resource.
- Get ProjectRetrieve full details for a specific Sanity project by its ID.
- Get RobotsTool to get robots with access to a resource.
- Get RoleRetrieve a specific role for a given resource type and resource ID.
- List Resource UsersList all users of a resource and their assigned roles.
- List Organization RolesList all roles available for an organization.
- List User AttributesTool to retrieve user attributes from a Sanity organization.
- Query All ScreeningExecute a GROQ query to fetch all screening documents from Sanity.
- Query DocumentsExecute an arbitrary GROQ query against a Sanity dataset.
Create & communicateCreate records or send supported messagesView 3 actions
- Add Default Role to UsersApply organization default role to all users.
- Create Attribute DefinitionTool to create a new user attribute definition in Sanity.
- Create Prompt PostSend a one-shot prompt to the Sanity Content Agent.
Update & manageChange and manage existing recordsView 2 actions
- Update Organization ACLTool to assign a role to a member in a Sanity organization.
- Update User Attributes ValuesUpdate user attribute values for a resource.
Remove & cancelRemove records or cancel supported workView 3 actions
- Delete User Attribute DefinitionDelete a user attribute definition.
- Delete DocumentDelete a document from Sanity by ID or query.
- Delete User AttributesDelete custom attributes from a Sanity user within an organization.
Other actionsSpecialist and administrative actions.View 1 action
- Validate CredentialValidate Sanity API credentials by fetching the authenticated user's information.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Sanity
How does the agent connect to Sanity?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Sanity?
The page above lists the 21 actions currently available through the Sanity connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Sanity included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Sanity is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Sanity to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.