Reference

Validate Credential

Verify that your Sanity API token is valid and properly configured by retrieving your authenticated user information and accessible projects. This ensures your connection to Sanity is working correctly before performing other operations.

Delete Document

Permanently remove documents from your Sanity content repository by ID or query, with options to preview changes before committing. Useful for cleaning up outdated content, managing large-scale deletions, or maintaining data hygiene in your headless CMS.

Get Document by ID

Retrieve a specific piece of content from your Sanity repository using its unique ID, getting back the complete document with all metadata. Use this when you need to quickly access a known document without writing queries.

Query Documents

Search and retrieve specific content from your Sanity content library using custom queries, allowing you to filter, organize, and transform your data exactly how you need it.

Get Project

Retrieve complete project details from your Sanity workspace, including configuration, display name, organization, and studio information. Use this when you need to verify project settings or access comprehensive project metadata.

Create Prompt Post

Send a single prompt to generate or manage content in Sanity without maintaining conversation history, perfect for quick one-time content requests.

Add Default Role to Users

Automatically assigns your organization's default role to all existing team members, ensuring consistent access permissions across your entire workspace.

Create Attribute Definition

Define custom attributes for your Sanity resources to capture specialized data like customer tiers, subscription levels, or product categories. This lets you organize and filter your content based on business-specific metadata.

Delete User Attribute Definition

Remove custom field definitions from your Sanity project when they're no longer needed, preventing users from setting values for outdated attributes while keeping existing data intact.

Delete User Attributes

Remove custom fields or metadata from team member profiles in your Sanity workspace to keep user information clean and relevant. This helps you maintain accurate records when certain profile data is no longer needed or becomes outdated.

Get Invite By Token

Retrieve details about a team invite using its public token, including status, assigned role, and who sent the invitation.

Get Organization Role

Retrieve details about a specific organization role including its title, description, and permissions to understand what capabilities are assigned to that role within your organization.

Get Permission

Retrieve detailed information about a specific permission assigned to a resource, including what actions are allowed and who can perform them.

Get Robots

Retrieve a list of service accounts (robots) that have access to your Sanity resources, along with their assigned permissions and roles.

Get Role

Fetch detailed information about a specific role in your Sanity workspace, including its permissions, title, and description to understand who can do what in your content management system.

List Organization Roles

Retrieve all available roles that can be assigned to users within your Sanity organization, helping you understand permission levels before assigning team members to specific roles.

List Resource Users

Retrieve all users who have access to your Sanity project along with their assigned roles, helping you manage team permissions and access levels.

List User Attributes

Retrieve detailed user attributes and roles from your Sanity organization to understand team member permissions and access levels. This helps you manage who has access to what content and features across your project.

Query All Screening

Retrieve all screening documents from your Sanity content database using a flexible query system. This helps you access testing, evaluation, or vetting records stored in your content management system.

Update Organization ACL

Assign or modify team member roles within your Sanity organization to control who has access to specific features and content management capabilities. This helps you manage team permissions as your project grows.

Update User Attributes Values

Modify custom user attributes and metadata in your Sanity workspace to store additional information about team members or clients. This lets you organize and track user-specific data like department, role, or custom tags without cluttering your main content structure.