NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Sanity

sanity

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

Developer ToolsProductivityWeb del proveedor
Acciones
16
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

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.

Parámetros de entrada

  • resource_idstringObligatorio

    The resource ID to scope the access request to. Must be a valid ID for the resource type.

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Attribute DefinitionSANITY_CREATE_ATTR_DEFINITIONAcción

Tool 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

  • keystringObligatorio

    The unique key/name for the attribute definition. This must be unique within the resource.

  • listboolean

    When true, the attribute accepts an array of values. When false or omitted, it accepts a single value.

  • typestringObligatorioenum

    The data type of the attribute. Must be one of: 'string', 'number', 'boolean'.

    stringnumberboolean
  • read_onlyboolean

    When true, the attribute value cannot be modified after creation. Defaults to false.

  • descriptionstring

    An optional description explaining what this attribute is used for.

  • resource_idstringObligatorio

    The unique identifier of the specific resource (e.g., organization ID, project ID).

  • resource_typestringObligatorio

    The type of resource the attribute definition belongs to. Examples: 'organizations', 'projects', 'datasets'.

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Prompt PostSANITY_CREATE_PROMPT_POSTAcción

Send 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

  • configobject

    Agent configuration. Controls behavior, capabilities, and document access.

  • formatstringenum

    Controls how directives in the response are formatted.

    markdowndirectives
  • messagestringObligatorio

    The prompt message to send to the agent

  • instructionsstring

    Custom instructions for the agent

  • organizationIdstringObligatorio

    Your Sanity organization ID

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete User Attribute DefinitionSANITY_DELETE_ATTR_DEFINITIONAcción

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.

Parámetros de entrada

  • resource_idstringObligatorio

    The unique identifier of the resource. For organizations, this is typically like 'oN7sjLEfL'. For projects, this is the project ID.

  • definition_idstringObligatorio

    The unique identifier of the attribute definition to delete.

  • resource_typestringObligatorioenum

    The type of resource to scope the user attribute definitions to. Common values: 'organization' or 'project'.

    organizationproject

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete User AttributesSANITY_DELETE_USER_ATTRIBUTESAcción

Delete 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[]Obligatorio

    List of attribute keys to delete from the user

  • sanity_user_idstringObligatorio

    Unique identifier of the Sanity user

  • organization_idstringObligatorio

    Unique identifier of the organization

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Invite By TokenSANITY_GET_INVITE_BY_TOKENAcción

Retrieve 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

  • resourceIdstringObligatorio

    The resource ID to scope the access request to. Must be a valid ID for the resource type.

  • inviteTokenstringObligatorio

    The public token for the invite. This token is shared with the invitee.

  • resourceTypestringObligatorioenum

    The 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

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Organization RoleSANITY_GET_ORG_ROLEAcción

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.

Parámetros de entrada

  • roleIdstringObligatorio

    The unique identifier of the role to retrieve

  • organizationIdstringObligatorio

    The unique identifier of the organization

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PermissionSANITY_GET_PERMISSIONAcción

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.

Parámetros de entrada

  • resource_idstringObligatorio

    The resource ID to scope the access request to. Must be a valid ID for the resource type.

  • resource_typestringObligatorio

    The resource to scope access requests to. Must be one of: 'organization' or 'project'.

  • permission_namestringObligatorio

    The name of the permission. This is a unique identifier for the permission.

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RobotsSANITY_GET_ROBOTSAcción

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.

Parámetros de entrada

  • limitinteger

    The number of items to return per page. Defaults to 100.

  • next_cursorstring

    The cursor for pagination. Use the nextCursor from the previous response to get the next page.

  • resource_idstringObligatorio

    The resource ID to scope the access request to. Must be a valid ID for the resource type.

  • resource_typestringObligatorioenum

    The resource type to scope the access requests to. One of: organization, project, media-library, canvas, dashboard, view.

    organizationprojectmedia-librarycanvasdashboardview
  • include_childrenboolean

    Whether to include children resources in the response. Only applies to organization resources.

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RoleSANITY_GET_ROLEAcción

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.

Parámetros de entrada

  • roleNamestringObligatorio

    The name of the role to retrieve.

  • resourceIdstringObligatorio

    The resource ID to scope the access request to. Must be a valid ID for the resource type.

  • resourceTypestringObligatorioenum

    The 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

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Resource UsersSANITY_GET_USERSAcción

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.

Parámetros de entrada

  • limitinteger

    Number of items to return per page. Defaults to 100. Maximum value is 100.

  • next_cursorstring

    Cursor for pagination. Use the nextCursor from the previous response to get the next page of results.

  • resource_idstringObligatorio

    The 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_typestringObligatorioenum

    The resource to scope access requests to. Use 'organization' for organization-level access or 'project' for project-level access.

    organizationproject

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Organization RolesSANITY_LIST_ORG_ROLESAcción

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.

Parámetros de entrada

  • organization_idstringObligatorio

    The unique identifier of the organization

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List User AttributesSANITY_LIST_USER_ATTRIBUTESAcción

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.

Parámetros de entrada

  • limitinteger

    Maximum number of attributes to return

  • cursorstring

    The last attribute key from the previous page (used for pagination)

  • sanity_user_idstringObligatorio

    Unique identifier of the Sanity user

  • organization_idstringObligatorio

    Unique identifier of the organization

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Query All ScreeningSANITY_QUERY_ALL_SCREENINGAcción

Execute 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

  • querystring

    GROQ query string to execute. Defaults to querying all documents of type 'screening'.

  • paramsobject

    Optional parameters to pass to the GROQ query. Use $variableName syntax in query.

  • datasetstring

    The Sanity dataset to query. Defaults to 'production'.

  • explainboolean

    If true, returns query execution plan details.

  • resultSourceMapboolean

    If true, includes source map information in the response.

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Organization ACLSANITY_UPDATE_ORG_ACLAcción

Tool 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_namestringObligatorio

    The role name to assign (e.g., 'administrator', 'member')

  • sanity_user_idstringObligatorio

    The Sanity user ID to assign the role to

  • organization_idstringObligatorio

    The ID of the organization

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update User Attributes ValuesSANITY_UPDATE_USER_ATTRIBUTES_VALUESAcción

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.

Parámetros de entrada

  • userIdstringObligatorio

    The unique identifier of the user whose attributes to update.

  • attributesobjectObligatorio

    A 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.

  • resourceIdstringObligatorio

    The unique identifier of the resource. For organizations, this is the organization ID.

  • resourceTypestringObligatorioenum

    The type of resource that scopes the user attributes (e.g., 'organization' or 'project').

    organizationproject

Parámetros de salida

  • dataanyObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not