Sanity
sanitySanity is a headless CMS platform that provides structured content storage and APIs for modern applications
Acciones disponibles (16)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Default Role to UsersSANITY_ADD_DEFAULT_ROLE_TO_USERSAcciónApply 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.
SANITY_ADD_DEFAULT_ROLE_TO_USERSAcciónApply 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.
Parámetros de entrada
resource_idstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Attribute DefinitionSANITY_CREATE_ATTR_DEFINITIONAcciónTool to create a new user attribute definition in Sanity. Use when you need to define a custom attribute (like 'customer-tier' or 'subscription-level') that can be attached to resources. The key must be unique within the resource. The attribute can have a type of 'string', 'number', or 'boolean' and can optionally be a list of values or read-only.
SANITY_CREATE_ATTR_DEFINITIONAcciónTool to create a new user attribute definition in Sanity. Use when you need to define a custom attribute (like 'customer-tier' or 'subscription-level') that can be attached to resources. The key must be unique within the resource. The attribute can have a type of 'string', 'number', or 'boolean' and can optionally be a list of values or read-only.
Parámetros de entrada
keystringObligatorioThe unique key/name for the attribute definition. This must be unique within the resource.
listbooleanWhen true, the attribute accepts an array of values. When false or omitted, it accepts a single value.
typestringObligatorioenumThe data type of the attribute. Must be one of: 'string', 'number', 'boolean'.
stringnumberbooleanread_onlybooleanWhen true, the attribute value cannot be modified after creation. Defaults to false.
descriptionstringAn optional description explaining what this attribute is used for.
resource_idstringObligatorioThe unique identifier of the specific resource (e.g., organization ID, project ID).
resource_typestringObligatorioThe type of resource the attribute definition belongs to. Examples: 'organizations', 'projects', 'datasets'.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Prompt PostSANITY_CREATE_PROMPT_POSTAcciónSend a one-shot prompt to the Sanity Content Agent. Stateless one-shot prompt endpoint. No thread management or message persistence. Ideal for simple, single-turn interactions. Use when you need to send a single prompt and receive a response without maintaining conversation context.
SANITY_CREATE_PROMPT_POSTAcciónSend a one-shot prompt to the Sanity Content Agent. Stateless one-shot prompt endpoint. No thread management or message persistence. Ideal for simple, single-turn interactions. Use when you need to send a single prompt and receive a response without maintaining conversation context.
Parámetros de entrada
configobjectAgent configuration. Controls behavior, capabilities, and document access.
formatstringenumControls how directives in the response are formatted.
markdowndirectivesmessagestringObligatorioThe prompt message to send to the agent
instructionsstringCustom instructions for the agent
organizationIdstringObligatorioYour Sanity organization ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete User Attribute DefinitionSANITY_DELETE_ATTR_DEFINITIONAcciónDelete 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.
SANITY_DELETE_ATTR_DEFINITIONAcciónDelete 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.
Parámetros de entrada
resource_idstringObligatorioThe unique identifier of the resource. For organizations, this is typically like 'oN7sjLEfL'. For projects, this is the project ID.
definition_idstringObligatorioThe unique identifier of the attribute definition to delete.
resource_typestringObligatorioenumThe type of resource to scope the user attribute definitions to. Common values: 'organization' or 'project'.
organizationproject
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete User AttributesSANITY_DELETE_USER_ATTRIBUTESAcciónDelete custom attributes from a Sanity user within an organization. Use this tool when you need to remove specific custom attributes from a user account. The action deletes the attributes specified in the request and returns the updated attribute list for the user. Example use case: Removing outdated metadata like 'location' or 'year_started' from a user profile.
SANITY_DELETE_USER_ATTRIBUTESAcciónDelete custom attributes from a Sanity user within an organization. Use this tool when you need to remove specific custom attributes from a user account. The action deletes the attributes specified in the request and returns the updated attribute list for the user. Example use case: Removing outdated metadata like 'location' or 'year_started' from a user profile.
Parámetros de entrada
attributesobject[]ObligatorioList of attribute keys to delete from the user
sanity_user_idstringObligatorioUnique identifier of the Sanity user
organization_idstringObligatorioUnique identifier of the organization
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Invite By TokenSANITY_GET_INVITE_BY_TOKENAcciónRetrieve an invite by its public token. Use this action when you need to fetch details about an invite using the invite token that was shared with the invitee. Returns invite information including status, role, and inviter details.
SANITY_GET_INVITE_BY_TOKENAcciónRetrieve an invite by its public token. Use this action when you need to fetch details about an invite using the invite token that was shared with the invitee. Returns invite information including status, role, and inviter details.
Parámetros de entrada
resourceIdstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type.
inviteTokenstringObligatorioThe public token for the invite. This token is shared with the invitee.
resourceTypestringObligatorioenumThe resource type to scope the access requests to. Must be one of: organization, project, media-library, canvas, dashboard, view.
organizationprojectmedia-librarycanvasdashboardview
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Organization RoleSANITY_GET_ORG_ROLEAcciónRetrieve 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.
SANITY_GET_ORG_ROLEAcciónRetrieve 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.
Parámetros de entrada
roleIdstringObligatorioThe unique identifier of the role to retrieve
organizationIdstringObligatorioThe unique identifier of the organization
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get PermissionSANITY_GET_PERMISSIONAcciónGet 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.
SANITY_GET_PERMISSIONAcciónGet 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.
Parámetros de entrada
resource_idstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type.
resource_typestringObligatorioThe resource to scope access requests to. Must be one of: 'organization' or 'project'.
permission_namestringObligatorioThe name of the permission. This is a unique identifier for the permission.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get RobotsSANITY_GET_ROBOTSAcciónTool 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.
SANITY_GET_ROBOTSAcciónTool 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.
Parámetros de entrada
limitintegerThe number of items to return per page. Defaults to 100.
next_cursorstringThe cursor for pagination. Use the nextCursor from the previous response to get the next page.
resource_idstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type.
resource_typestringObligatorioenumThe resource type to scope the access requests to. One of: organization, project, media-library, canvas, dashboard, view.
organizationprojectmedia-librarycanvasdashboardviewinclude_childrenbooleanWhether to include children resources in the response. Only applies to organization resources.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get RoleSANITY_GET_ROLEAcciónRetrieve 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.
SANITY_GET_ROLEAcciónRetrieve 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.
Parámetros de entrada
roleNamestringObligatorioThe name of the role to retrieve.
resourceIdstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type.
resourceTypestringObligatorioenumThe resource type to scope the access requests to. Must be one of: organization, project, media-library, canvas, dashboard, view.
organizationprojectmedia-librarycanvasdashboardview
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Resource UsersSANITY_GET_USERSAcciónList 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.
SANITY_GET_USERSAcciónList 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.
Parámetros de entrada
limitintegerNumber of items to return per page. Defaults to 100. Maximum value is 100.
next_cursorstringCursor for pagination. Use the nextCursor from the previous response to get the next page of results.
resource_idstringObligatorioThe resource ID to scope the access request to. Must be a valid ID for the resource type (e.g., project ID or organization ID).
resource_typestringObligatorioenumThe resource to scope access requests to. Use 'organization' for organization-level access or 'project' for project-level access.
organizationproject
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Organization RolesSANITY_LIST_ORG_ROLESAcciónList 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.
SANITY_LIST_ORG_ROLESAcciónList 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.
Parámetros de entrada
organization_idstringObligatorioThe unique identifier of the organization
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List User AttributesSANITY_LIST_USER_ATTRIBUTESAcciónTool 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.
SANITY_LIST_USER_ATTRIBUTESAcciónTool 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.
Parámetros de entrada
limitintegerMaximum number of attributes to return
cursorstringThe last attribute key from the previous page (used for pagination)
sanity_user_idstringObligatorioUnique identifier of the Sanity user
organization_idstringObligatorioUnique identifier of the organization
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Query All ScreeningSANITY_QUERY_ALL_SCREENINGAcciónExecute a GROQ query to fetch all screening documents from Sanity. Uses the Sanity HTTP query API endpoint. Default query retrieves all documents of type 'screening'. Supports optional query parameters for dynamic queries.
SANITY_QUERY_ALL_SCREENINGAcciónExecute a GROQ query to fetch all screening documents from Sanity. Uses the Sanity HTTP query API endpoint. Default query retrieves all documents of type 'screening'. Supports optional query parameters for dynamic queries.
Parámetros de entrada
querystringGROQ query string to execute. Defaults to querying all documents of type 'screening'.
paramsobjectOptional parameters to pass to the GROQ query. Use $variableName syntax in query.
datasetstringThe Sanity dataset to query. Defaults to 'production'.
explainbooleanIf true, returns query execution plan details.
resultSourceMapbooleanIf true, includes source map information in the response.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Organization ACLSANITY_UPDATE_ORG_ACLAcciónTool to assign a role to a member in a Sanity organization. Use when adding or modifying user roles within an organization.
SANITY_UPDATE_ORG_ACLAcciónTool to assign a role to a member in a Sanity organization. Use when adding or modifying user roles within an organization.
Parámetros de entrada
role_namestringObligatorioThe role name to assign (e.g., 'administrator', 'member')
sanity_user_idstringObligatorioThe Sanity user ID to assign the role to
organization_idstringObligatorioThe ID of the organization
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update User Attributes ValuesSANITY_UPDATE_USER_ATTRIBUTES_VALUESAcciónUpdate 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.
SANITY_UPDATE_USER_ATTRIBUTES_VALUESAcciónUpdate 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.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose attributes to update.
attributesobjectObligatorioA dictionary of attribute key-value pairs to set for the user. Values can be strings, numbers, booleans, arrays, or nested objects. These will shadow any SAML values for the same keys.
resourceIdstringObligatorioThe unique identifier of the resource. For organizations, this is the organization ID.
resourceTypestringObligatorioenumThe type of resource that scopes the user attributes (e.g., 'organization' or 'project').
organizationproject
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not