Vee3

Name: Vee3
Author: Vee3io

by io.github.Vee3io

Server Details

Hosted MCP with 91 agent tools: X, domains, SEO, Maps, Trends, Search, YouTube, TikTok, and more.

Status: Healthy
Last Tested: 2026-07-28 14:30
Transport: Streamable HTTP
URL
Repository: Vee3io/vee3
GitHub Stars: 1
Server Listing: Vee3

Glama MCP Gateway

Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.

MCP client

Glama

MCP server

Full call logging

Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.

Tool access control

Enable or disable individual tools per connector, so you decide what your agents can and cannot do.

Managed credentials

Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.

Usage analytics

See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.

100% free. Your data is private.

Tool Definition Quality

A4.1/5.0

Tool DescriptionsA

Average 4.2/5 across 78 of 78 tools scored. Lowest: 3.2/5.

Server CoherenceA

Disambiguation5/5

Each tool has a distinct purpose, further clarified by group prefixes and clear descriptions. Within each group, tools perform different operations (e.g., domains.lookup vs. domains.whois vs. domains.rdap) with no ambiguity.

Naming Consistency5/5

All tools follow a consistent group.tool_name pattern using snake_case. The naming is predictable and uniformly applied across all groups.

Tool Count4/5

78 tools is high, but the server aggregates multiple distinct API domains (11 groups). Each group has a reasonable number of tools, typically under 10, with TikTok having 17. The count reflects breadth, not bloat.

Completeness5/5

Each domain's tool set covers the primary expected operations (e.g., search, details, reviews, metrics, user info). There are no obvious gaps for read-only analytical use; features like posting are likely out of scope.

Available Tools

285 tools

clerk.add_domainInspect

Add a custom domain to a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created domain with CNAME targets for DNS setup.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Domain hostname to add.
`proxy_url`	No	Proxy URL when using a satellite domain behind a reverse proxy.
`is_satellite`	Yes	Whether this is a satellite domain.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Created Clerk domain from the Backend API.

clerk.add_role_set_rolesInspect

Add roles to a role set in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role set summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`role_keys`	Yes	Role keys to add to the role set.
`role_set_id`	Yes	Clerk role set id or key to retrieve, update, or modify.
`creator_role_key`	No	Updated creator role key after adding roles.
`default_role_key`	No	Updated default role key after adding roles.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set`	No	Updated role set summary.

clerk.adjust_billing_credit_balanceInspect

Increase or decrease billing credit for a Clerk user or organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Pass payer_type (user or organization) and payer_id (the user_... or org_... id).

Returns the credit_ledger summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`note`	No	Optional note describing the credit adjustment.
`action`	Yes	Credit adjustment action: "increase" or "decrease".
`amount`	Yes	Credit adjustment amount in cents (minimum 1).
`currency`	No	ISO currency code for the credit adjustment.
`payer_id`	Yes	Clerk user id (user_...) or organization id (org_...) matching payer_type.
`payer_type`	Yes	Whether the payer is a "user" or an "organization".
`idempotency_key`	Yes	Unique key to make the credit adjustment idempotent.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`credit_ledger`	No	Credit ledger entry created by the adjustment.

clerk.assign_organization_role_permissionInspect

Assign a permission to an organization role in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`role_id`	Yes	Clerk organization role id to retrieve, update, delete, or assign permissions to.
`permission_id`	Yes	Clerk organization permission id to retrieve, update, delete, or assign to a role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Organization role summary after assigning the permission.

clerk.attempt_email_address_verificationInspect

Complete email address verification by submitting the OTP code.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns updated verification status.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`code`	Yes	Verification code sent to the email address.
`verification_id`	Yes	Verification id from prepare-clerk-email-address-verification.
`email_address_id`	Yes	Clerk email address id (idn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verification`	No	Verification object with updated status from the Clerk Backend API.

clerk.attempt_phone_number_verificationInspect

Verify an SMS code sent to a Clerk phone number.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns updated verification status.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`code`	Yes	SMS verification code entered by the user.
`phone_number_id`	Yes	Clerk phone number id (idn_... or phn_...) to retrieve or modify.
`verification_id`	Yes	Verification id from prepare-clerk-phone-number-verification.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verification`	No	Verification object with updated status from the Clerk Backend API.

clerk.ban_usersInspect

Ban one or more Clerk users, preventing them from signing in.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summaries and total count.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_ids`	Yes	List of one or more Clerk user ids (user_...) to ban.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`users`	No	Updated user summaries for all banned users.
`total_count`	No	Number of users that were banned.

clerk.cancel_billing_subscription_itemInspect

Cancel a billing subscription item in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated subscription_item summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`end_now`	No	When true, end the subscription immediately instead of at period end.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`subscription_item_id`	Yes	Clerk billing subscription item id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`subscription_item`	No	Canceled subscription item summary.

clerk.change_instance_domainInspect

Change the primary or secondary home URL for a connected Clerk instance.

WARNING: Destructive operation — changing the instance domain invalidates active sessions and may cause brief downtime.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns whether Clerk accepted the domain change request.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`home_url`	Yes	New home URL for the instance domain.
`is_secondary`	No	When true, change the secondary domain instead of the primary.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`accepted`	No	Whether Clerk accepted the domain change request.

clerk.count_usersInspect

Return the total number of users in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cheaper than listing users when you only need the total count.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`query`	No	Optional filter query forwarded to Clerk (email, phone, username, or external id).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of users in the Clerk application.

clerk.create_actor_tokenInspect

Create an actor token that lets one user impersonate another in a connected Clerk application.

Sensitive — the returned token is a high-privilege secret that grants impersonation access; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 15 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) of the user being impersonated.
`actor_sub`	Yes	Clerk user id (user_...) of the impersonating actor (maps to actor.sub).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`expires_in_seconds`	No	Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour).
`session_max_duration_in_seconds`	No	Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes).

Output Schema

ParametersJSON Schema

Name	Required	Description
`actor_token`	No	Created Clerk actor token object from the Backend API.

clerk.create_admin_portal_link_tokenInspect

Create an admin portal link token in a connected Clerk instance.

Sensitive — the returned token is a single-use deep-link secret; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 15 tokens.

ParametersJSON Schema

Name	Required	Description
`scopes`	No	Optional scopes for the link (for example "admin_portal:read").
`it_contact_id`	No	Optional opaque IT contact reference for the link.
`organization_id`	No	Optional organization id (org_...) to scope the admin portal link.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`seconds_until_expiration`	No	Link token lifetime in seconds (default 3600, max 86400).

Output Schema

ParametersJSON Schema

Name	Required	Description
`admin_portal_link_token`	No	Created admin portal link token from the Backend API.

clerk.create_allowlist_identifierInspect

Add an identifier to the allowlist in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created allowlist identifier summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`notify`	No	When true, notify the user by email or SMS that they were added to the allowlist.
`identifier`	Yes	Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`identifier`	No	Created allowlist identifier object from the Backend API.

clerk.create_api_keyInspect

Create an API key in a connected Clerk application.

Sensitive — the returned secret is a high-privilege credential; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new API key summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Human-readable name for the new API key.
`claims`	No	Custom claims to embed in tokens minted from this API key.
`scopes`	No	Permission scopes to grant the API key.
`subject`	Yes	Subject the API key is scoped to (user_... or org_...).
`key_type`	No	API key type (typically "api_key").
`created_by`	No	User id to record as the creator of this API key.
`description`	No	Optional description for the API key.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`seconds_until_expiration`	No	Seconds from creation until the API key expires.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Newly created Clerk API key from the Backend API.

clerk.create_billing_priceInspect

Create a billing price for a plan in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new billing_price summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`amount`	Yes	Price amount in cents (minimum 100).
`plan_id`	Yes	Billing plan id to create a price for.
`currency`	No	ISO currency code (for example usd).
`description`	No	Price description.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`annual_monthly_amount`	No	Equivalent monthly amount in cents when billed annually (minimum 100).

Output Schema

ParametersJSON Schema

Name	Required	Description
`billing_price`	No	Created billing price summary.

clerk.create_billing_price_transitionInspect

Transition a billing subscription item from one price to another in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the price_transition summary with the updated subscription_item.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`to_price_id`	Yes	Target billing price id to transition to.
`from_price_id`	Yes	Current billing price id to transition from.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`subscription_item_id`	Yes	Clerk billing subscription item id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`price_transition`	No	Price transition result from Clerk.

clerk.create_blocklist_identifierInspect

Add an identifier to the blocklist in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Blocked identifiers cannot sign up or sign in. Returns the created blocklist identifier summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`identifier`	Yes	Identifier to block: email, domain, E.164 phone (+15555555555), or Web3 wallet address.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`identifier`	No	Created blocklist identifier object from the Backend API.

clerk.create_email_addressInspect

Create a new email address for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created email address summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`primary`	No	When true, set this email as the user's primary email address.
`user_id`	Yes	Clerk user id (user_...) to retrieve or modify.
`verified`	No	When true, the email address is created as verified.
`email_address`	Yes	Email address to create for the user.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`email_address`	No	Created Clerk email address summary.

clerk.create_enterprise_connectionInspect

Create a SAML or OIDC enterprise SSO connection in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new enterprise_connection summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Display name for the enterprise connection.
`oidc`	No	OIDC client configuration when provider uses OAuth.
`saml`	No	SAML IdP configuration when provider uses SAML.
`active`	No	Whether the connection is active.
`domains`	Yes	Email domains that may use this connection.
`provider`	Yes	Identity provider key (for example saml_custom or oidc_custom).
`organization_id`	No	Clerk organization id (org_...) to link to this connection.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`custom_attributes`	No	Custom attribute mappings from the IdP to user metadata.
`sync_user_attributes`	No	Whether to sync user attributes on each sign-in.
`allow_organization_account_linking`	No	Whether account linking via organization membership is allowed.
`disable_additional_identifications`	No	Whether to block additional identifications for this connection.

Output Schema

ParametersJSON Schema

Name	Required	Description
`enterprise_connection`	No	Newly created enterprise SSO connection.

clerk.create_enterprise_connection_test_runInspect

Start an SSO test flow for an enterprise connection in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a short-lived url that opens the IdP test flow.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`connection_id`	Yes	Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`url`	No	Short-lived URL to start the enterprise SSO test flow.

clerk.create_invitationsInspect

Invite one or more email addresses to sign up for a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`invitations`	Yes	One or more invitation objects. Each item requires email_address (string). Optional fields per item: role (string), redirect_url (string), public_metadata (object).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitations`	No	Created Clerk invitation summaries.

clerk.create_jwt_templateInspect

Create a new JWT template in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new template summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Unique JWT template name.
`claims`	Yes	JWT claims template as a JSON object.
`lifetime`	No	Token lifetime in seconds (30–315360000).
`signing_key`	No	Custom signing private key (required when custom_signing_key is true).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`signing_algorithm`	No	Custom signing algorithm (required when custom_signing_key is true).
`allowed_clock_skew`	No	Allowed clock skew in seconds (0–300).
`custom_signing_key`	No	Whether to use a custom signing key and algorithm.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwt_template`	No	Newly created Clerk JWT template summary.

clerk.create_m2m_tokenInspect

Create an M2M token in a connected Clerk instance.

Sensitive — the returned token is a high-privilege secret; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created M2M token.

Cost = 15 tokens.

ParametersJSON Schema

Name	Required	Description
`claims`	No	Optional custom claims embedded in the token.
`token_format`	No	Token format: "opaque" (default) or "jwt".
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`machine_secret_key`	Yes	Machine secret key (msk_...) used to authenticate the create request.
`seconds_until_expiration`	No	Token lifetime in seconds.
`min_remaining_ttl_seconds`	No	For opaque tokens, reuse an existing token with at least this TTL remaining.

Output Schema

ParametersJSON Schema

Name	Required	Description
`m2m_token`	No	Created M2M token from the Backend API.

clerk.create_machineInspect

Create a machine in a connected Clerk instance for machine-to-machine authentication.

Sensitive — the response may include a machine secret_key on creation; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Machine display name (1–255 characters).
`scoped_machines`	No	Machine ids (mch_...) this machine may access (max 150).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`default_token_ttl`	No	Default M2M token lifetime in seconds (minimum 1).

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine`	No	Created machine object from the Backend API.

clerk.create_machine_scopeInspect

Create a machine scope so one machine can access another.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created machine scope.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`to_machine_id`	Yes	Target machine id (mch_...) to grant access to.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine_scope`	No	Created machine scope from the Backend API.

clerk.create_oauth_applicationInspect

Create a new OAuth application in a connected Clerk application (Clerk as IdP).

Sensitive — client_secret may be present for confidential clients; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new OAuth application summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Display name for the new OAuth application.
`public`	No	Whether this is a public OAuth client (no client secret; PKCE-capable).
`scopes`	No	Space-delimited scopes (e.g. profile email public_metadata).
`redirect_uris`	No	Allowed redirect URIs for the OAuth authorization flow.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`consent_screen_enabled`	No	Whether to show the OAuth consent screen during authorization.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	Newly created Clerk OAuth application summary.

clerk.create_organizationInspect

Create a new organization in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new organization summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Organization display name.
`slug`	No	Optional URL-friendly slug for the organization.
`created_by`	Yes	Clerk user id (user_...) of the user creating the organization.
`public_metadata`	No	Optional public metadata as a JSON object.
`private_metadata`	No	Optional private metadata as a JSON object.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`max_allowed_memberships`	No	Optional maximum number of memberships allowed.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Newly created Clerk organization summary.

clerk.create_organization_domainInspect

Add a domain to a Clerk organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created domain summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Domain name to add (for example example.com).
`verified`	No	Whether the domain is verified. Defaults to true when omitted.
`enrollment_mode`	No	Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Created organization domain summary.

clerk.create_organization_invitationsInspect

Invite one or more email addresses to join a Clerk organization with specific roles.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the list of created invitation summaries.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`invitations`	Yes	One or more invitation objects. Each item requires email_address (string) and role (string, e.g. org:admin, org:member).
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitations`	No	Created invitation summaries.

clerk.create_organization_membershipInspect

Add a user to a Clerk organization with a specified role.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created membership.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`role`	Yes	Role to assign to the user in the organization (e.g. org:member, org:admin).
`user_id`	Yes	Clerk user id (user_...) of the user to add.
`organization_id`	Yes	Clerk organization id (org_...) to add the member to.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`membership`	No	Created organization membership.

clerk.create_organization_permissionInspect

Create a new organization permission in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new permission summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Unique permission key.
`name`	Yes	Permission display name.
`description`	No	Permission description.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_permission`	No	Newly created organization permission summary.

clerk.create_organization_roleInspect

Create a new organization role in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new role summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Unique role key.
`name`	Yes	Role display name.
`description`	No	Role description.
`permissions`	No	Permission keys to assign to the new role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`include_in_initial_role_set`	No	Whether to include this role in the initial role set.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Newly created organization role summary.

clerk.create_phone_numberInspect

Create a phone number for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created phone number summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`primary`	No	Whether this should be the user's primary phone number.
`user_id`	Yes	Clerk user id (user_...) to retrieve or modify.
`verified`	No	Whether the phone number should be marked verified. Defaults to false.
`phone_number`	Yes	Phone number in E.164 format (e.g. +15551234567).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`reserved_for_second_factor`	No	Whether to reserve this number for multi-factor authentication.

Output Schema

ParametersJSON Schema

Name	Required	Description
`phone_number`	No	Created Clerk phone number object from the Backend API.

clerk.create_redirect_urlInspect

Add an allowed redirect URL to a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created redirect URL.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Redirect URL to allow for sign-in and sign-up flows.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`redirect_url`	No	Created Clerk redirect URL from the Backend API.

clerk.create_role_setInspect

Create a new role set in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new role set summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`key`	No	Unique role set key.
`name`	Yes	Role set display name.
`type`	No	Role set type.
`roles`	Yes	Role keys to include in the role set.
`description`	No	Role set description.
`creator_role_key`	Yes	Key of the role assigned to organization creators.
`default_role_key`	Yes	Key of the default role for new members.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set`	No	Newly created role set summary.

clerk.create_sessionInspect

Create a new session for a Clerk user in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created session object with id, user_id, status, last_active_at, expire_at, client_id, created_at, and updated_at.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to create a session for.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk session id (sess_...).
`status`	No	Current status of the session.
`user_id`	No	Clerk user id (user_...) that owns this session.
`client_id`	No	Clerk client id associated with this session.
`expire_at`	No	Unix timestamp in milliseconds when this session expires.
`created_at`	No	Unix timestamp in milliseconds when the session was created.
`updated_at`	No	Unix timestamp in milliseconds when the session was last updated.
`last_active_at`	No	Unix timestamp in milliseconds of the last activity on this session.

clerk.create_session_tokenInspect

Create a session token (JWT) for an active session in a connected Clerk application. Optionally pass template_name to create the token from a named JWT template. Sensitive — the returned JWT grants access on behalf of the user; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a jwt field containing the signed token.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`session_id`	Yes	Clerk session id (sess_...) to retrieve or modify.
`template_name`	No	Optional JWT template name. When set, the session token is created from that template.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwt`	No	Signed JWT for the session. Treat as a secret — do not log.

clerk.create_sign_in_tokenInspect

Create a sign-in token for a user in a connected Clerk application. The token can be used once to sign the user in without credentials (magic-link style).

Sensitive — the returned token is a high-privilege secret that grants sign-in access; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 15 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`expires_in_seconds`	No	Token lifetime in seconds (minimum 1). Defaults to 2592000 (30 days).

Output Schema

ParametersJSON Schema

Name	Required	Description
`sign_in_token`	No	Created Clerk sign-in token object from the Backend API.

clerk.create_svix_appInspect

Create a Svix app and associate it with a connected Clerk application for webhook delivery.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a temporary svix_url from Clerk.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`svix`	No	Svix app response from the Clerk Backend API.

clerk.create_svix_dashboard_urlInspect

Generate a temporary URL for accessing the Svix management dashboard for a connected Clerk application.

Sensitive — the returned URL grants access to webhook configuration; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns svix_url.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`svix`	No	Temporary Svix dashboard URL from the Clerk Backend API.

clerk.create_userInspect

Create a user in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`password`	No	Optional password. Omit to create a user without a password.
`last_name`	No	Optional last name.
`first_name`	No	Optional first name.
`email_address`	Yes	Primary email address for the new Clerk user.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Created Clerk user object from the Backend API.

clerk.create_waitlist_entriesInspect

Add one or more email addresses to the waitlist in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the created or existing waitlist entries.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`waitlist_entries`	Yes	One or more waitlist entry objects. Each item requires email_address (string). Optional fields per item: notify (boolean; whether to notify the user their email was added; defaults to true).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`waitlist_entries`	No	Created or existing Clerk waitlist entry summaries.

clerk.delete_allowlist_identifierInspect

Remove an allowlist identifier by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a deleted confirmation.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`identifier_id`	Yes	Allowlist or blocklist identifier id (alid_... or blid_...) to delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted_identifier`	No	Clerk deleted-object payload confirming removal.

clerk.delete_api_keyInspect

Permanently delete an API key from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted API key id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`api_key_id`	Yes	Clerk API key id (ak_...) to retrieve, update, delete, or revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Deletion confirmation with API key id and deleted flag.

clerk.delete_blocklist_identifierInspect

Remove a blocklist identifier by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a deleted confirmation.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`identifier_id`	Yes	Allowlist or blocklist identifier id (alid_... or blid_...) to delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted_identifier`	No	Clerk deleted-object payload confirming removal.

clerk.delete_domainInspect

Remove a custom domain from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted domain id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain_id`	Yes	Clerk organization domain id (dmn_...) to update, delete, or verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Clerk deleted-object payload confirming domain removal.

clerk.delete_email_addressInspect

Delete a Clerk email address by its id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted email address summary when Clerk provides it.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`email_address_id`	Yes	Clerk email address id (idn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`email_address`	No	Deleted Clerk email address summary, when returned by Clerk.

clerk.delete_enterprise_connectionInspect

Delete an enterprise SSO connection from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted enterprise connection object from Clerk.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`connection_id`	Yes	Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`enterprise_connection`	No	Deleted enterprise connection object returned by Clerk.

clerk.delete_jwt_templateInspect

Permanently delete a JWT template from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

This action is irreversible. Returns the deleted template id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`template_id`	Yes	Clerk JWT template id (jtmp_...) to retrieve, update, or delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwt_template`	No	Deletion confirmation with template id and deleted flag.

clerk.delete_machineInspect

Delete a machine by id from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a deletion confirmation.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted_machine`	No	Deleted machine confirmation from the Backend API.

clerk.delete_machine_scopeInspect

Delete a machine scope, removing access from one machine to another.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a deletion confirmation.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`scope_id`	Yes	Target machine id (mch_...) for the scope to remove.
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted_machine_scope`	No	Deleted machine scope confirmation from the Backend API.

clerk.delete_oauth_applicationInspect

Permanently delete an OAuth application from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted OAuth application object from Clerk.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_application_id`	Yes	Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	Deleted Clerk OAuth application object from the Backend API.

clerk.delete_organizationInspect

Permanently delete an organization from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

This action is irreversible. Returns the deleted organization id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Deletion confirmation with organization id and deleted flag.

clerk.delete_organization_domainInspect

Remove an organization domain from a Clerk organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted domain id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain_id`	Yes	Clerk organization domain id (dmn_...) to update, delete, or verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted_domain`	No	Deletion confirmation with domain id and deleted flag.

clerk.delete_organization_membershipInspect

Remove a user from a Clerk organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

This action cannot be undone.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) of the member to remove.
`organization_id`	Yes	Clerk organization id (org_...) to remove the member from.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`membership`	No	Deleted organization membership object, when returned.

clerk.delete_organization_permissionInspect

Delete an organization permission from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the Clerk deletion payload.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`permission_id`	Yes	Clerk organization permission id to retrieve, update, delete, or assign to a role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_permission`	No	Clerk deletion payload for the organization permission.

clerk.delete_organization_roleInspect

Delete an organization role from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the Clerk deletion payload.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`role_id`	Yes	Clerk organization role id to retrieve, update, delete, or assign permissions to.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Clerk deletion payload for the organization role.

clerk.delete_phone_numberInspect

Delete a Clerk phone number by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

This action cannot be undone. Returns a deleted confirmation.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`phone_number_id`	Yes	Clerk phone number id (idn_... or phn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted`	No	Deleted object confirmation from the Clerk Backend API.

clerk.delete_redirect_urlInspect

Remove an allowed redirect URL from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted redirect URL id and a deleted flag.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`redirect_url_id`	Yes	Clerk redirect URL id to retrieve or delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`redirect_url`	No	Clerk deleted-object payload confirming redirect URL removal.

clerk.delete_svix_appInspect

Delete the Svix app associated with a connected Clerk application and disassociate webhook delivery.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a deleted confirmation.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`svix`	No	Deletion confirmation for the Svix app.

clerk.delete_userInspect

Permanently delete a Clerk user by user id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

This action cannot be undone.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Deleted Clerk user object from the Backend API, when returned.

clerk.delete_user_backup_codesInspect

Delete all MFA backup codes for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after backup codes were removed.

clerk.delete_user_external_accountInspect

Delete (unlink) an external OAuth or social account from a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the deleted external account.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`external_account_id`	Yes	External account id (for example ea_...) to unlink.

Output Schema

ParametersJSON Schema

Name	Required	Description
`external_account`	No	Deleted external account object from the Clerk Backend API.

clerk.delete_user_passkeyInspect

Delete a passkey for a Clerk user by passkey id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to operate on.
`passkey_id`	Yes	Passkey identification id to delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after the passkey was removed.

clerk.delete_user_totpInspect

Delete all TOTP authenticators for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after TOTP was removed.

clerk.delete_user_web3_walletInspect

Delete a Web3 wallet for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to operate on.
`web3_wallet_id`	Yes	Web3 wallet identification id to delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after the Web3 wallet was removed.

clerk.delete_waitlist_entryInspect

Delete a pending waitlist entry from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the Clerk deleted-object payload.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`waitlist_entry_id`	Yes	Clerk waitlist entry id (wle_...) to operate on.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted`	No	Clerk deleted-object payload.

clerk.disable_user_mfaInspect

Disable all MFA methods (SMS, TOTP, and similar) for a Clerk user at once.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after MFA was disabled.

clerk.extend_billing_subscription_trialInspect

Extend the free trial on a billing subscription item in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated subscription_item summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`extend_to`	Yes	RFC3339 timestamp to extend the free trial until.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`subscription_item_id`	Yes	Clerk billing subscription item id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`subscription_item`	No	Subscription item after extending the free trial.

clerk.get_api_keyInspect

Retrieve API key metadata by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the API key summary without the secret.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`api_key_id`	Yes	Clerk API key id (ak_...) to retrieve, update, delete, or revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Clerk API key metadata from the Backend API.

clerk.get_api_key_secretInspect

Reveal the secret for an API key in a connected Clerk application.

Sensitive — the returned secret is a high-privilege credential; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns secret.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`api_key_id`	Yes	Clerk API key id (ak_...) to retrieve, update, delete, or revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`secret`	No	API key secret value. Treat as high-privilege — do not log.

clerk.get_billing_credit_balanceInspect

Retrieve the billing credit balance for a Clerk user or organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Pass payer_type (user or organization) and payer_id (the user_... or org_... id).

Returns the credit_balance summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`payer_id`	Yes	Clerk user id (user_...) or organization id (org_...) matching payer_type.
`payer_type`	Yes	Whether the payer is a "user" or an "organization".
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`credit_balance`	No	Billing credit balance summary.

clerk.get_billing_statementInspect

Retrieve a billing statement by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the billing_statement summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`statement_id`	Yes	Clerk billing statement id.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`billing_statement`	No	Billing statement summary.

clerk.get_billing_subscriptionInspect

Retrieve the billing subscription for a Clerk user or organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Pass payer_type (user or organization) and payer_id (the user_... or org_... id).

Returns the subscription summary including nested subscription_items.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`payer_id`	Yes	Clerk user id (user_...) or organization id (org_...) matching payer_type.
`payer_type`	Yes	Whether the payer is a "user" or an "organization".
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`subscription`	No	Billing subscription summary.

clerk.get_clientInspect

Retrieve a client by id from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the client object.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`client_id`	Yes	Clerk client id to retrieve.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`client`	No	Client object from the Backend API.

clerk.get_connected_accountsInspect

List Clerk applications connected to the authenticated Vee3 account.

Returns clerk_instance_id, display name, environment type, and whether each connection is the default. Use clerk_instance_id on future Clerk calls, or omit it to use the default account.

If accounts is empty, the user must connect a Clerk application at https://vee3.io/dashboard/connections before Clerk capabilities work. Agents cannot complete the connection flow; ask the user to connect, then call this tool again.

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`accounts`	No	Active connected Clerk applications for the authenticated Vee3 account.

clerk.get_email_addressInspect

Retrieve a Clerk email address by its id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the email address summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`email_address_id`	Yes	Clerk email address id (idn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk email address id (idn_...).
`primary`	No	Whether this is the user's primary email address.
`user_id`	No	Clerk user id (user_...) that owns this email address.
`verified`	No	Whether the email address is verified.
`created_at`	No	Unix timestamp in milliseconds when the email address was created.
`updated_at`	No	Unix timestamp in milliseconds when the email address was last updated.
`email_address`	No	Email address value.
`verification_status`	No	Verification status (e.g. verified, unverified, failed).

clerk.get_enterprise_connectionInspect

Retrieve a single enterprise SSO connection from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the enterprise_connection summary including SAML or OIDC configuration when present.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`connection_id`	Yes	Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`enterprise_connection`	No	Enterprise SSO connection details.

clerk.get_instanceInspect

Retrieve the connected Clerk application instance id and environment type.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the Clerk instance id (ins_...) and environment_type (development or production). App display names are not available from the Backend API.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`instance`	No	Connected Clerk instance metadata.

clerk.get_instance_communication_settingsInspect

Retrieve SMS communication settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns communication settings.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`communication_settings`	No	Clerk instance communication settings from the Backend API.

clerk.get_instance_oauth_settingsInspect

Retrieve OAuth settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns OAuth settings.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_settings`	No	Clerk instance OAuth settings from the Backend API.

clerk.get_instance_organization_settingsInspect

Retrieve organization feature settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns organization feature settings.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_settings`	No	Clerk instance organization settings from the Backend API.

clerk.get_instance_settingsInspect

Retrieve core settings for a connected Clerk application instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns core instance settings.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`instance_settings`	No	Core Clerk instance settings from the Backend API.

clerk.get_jwksInspect

Retrieve the JSON Web Key Set (JWKS) for verifying Clerk session tokens.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns public signing keys for verifying Clerk JWTs.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwks`	No	Clerk JWKS payload from the Backend API.

clerk.get_jwt_templateInspect

Retrieve a single JWT template from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns id, name, claims, lifetime, allowed_clock_skew, created_at, updated_at, signing_algorithm, and custom_signing_key.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`template_id`	Yes	Clerk JWT template id (jtmp_...) to retrieve, update, or delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwt_template`	No	Clerk JWT template details.

clerk.get_machineInspect

Retrieve a machine by id from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns machine metadata including scoped_machines.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine`	No	Machine object from the Backend API.

clerk.get_machine_secret_keyInspect

Retrieve the secret key for a machine in a connected Clerk instance.

Sensitive — the returned secret grants machine authentication; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the machine secret key.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine_secret_key`	No	Machine secret key payload from the Backend API.

clerk.get_oauth_applicationInspect

Retrieve a single OAuth application by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the OAuth application summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_application_id`	Yes	Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	Clerk OAuth application summary.

clerk.get_organizationInspect

Retrieve a single organization from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns organization id, name, slug, members_count, and created_at.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Clerk organization details.

clerk.get_organization_invitationInspect

Retrieve a single Clerk organization invitation by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the invitation summary including status.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`invitation_id`	Yes	Clerk organization invitation id (orginv_...).
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitation`	No	Requested organization invitation summary.

clerk.get_organization_permissionInspect

Retrieve an organization permission by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the permission summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`permission_id`	Yes	Clerk organization permission id to retrieve, update, delete, or assign to a role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_permission`	No	Organization permission summary.

clerk.get_organization_roleInspect

Retrieve an organization role by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the role summary including assigned permissions.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`role_id`	Yes	Clerk organization role id to retrieve, update, delete, or assign permissions to.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Organization role summary.

clerk.get_phone_numberInspect

Retrieve a Clerk phone number by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the phone number summary.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`phone_number_id`	Yes	Clerk phone number id (idn_... or phn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk phone number id.
`verified`	No	Whether the phone number is verified.
`phone_number`	No	Phone number in E.164 format.
`default_second_factor`	No	Whether this is the user's default second factor.
`reserved_for_second_factor`	No	Whether the phone number is reserved for multi-factor authentication.

clerk.get_redirect_urlInspect

Retrieve an allowed redirect URL by id from a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the redirect URL.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`redirect_url_id`	Yes	Clerk redirect URL id to retrieve or delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`redirect_url`	No	Clerk redirect URL from the Backend API.

clerk.get_role_setInspect

Retrieve a role set by id from a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the role set summary including roles.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`role_set_id`	Yes	Clerk role set id or key to retrieve, update, or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set`	No	Role set summary.

clerk.get_sessionInspect

Retrieve a single session from a connected Clerk application by its session id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns session id, user_id, status, last_active_at, expire_at, client_id, created_at, and updated_at.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`session_id`	Yes	Clerk session id (sess_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk session id (sess_...).
`status`	No	Current status of the session.
`user_id`	No	Clerk user id (user_...) that owns this session.
`client_id`	No	Clerk client id associated with this session.
`expire_at`	No	Unix timestamp in milliseconds when this session expires.
`created_at`	No	Unix timestamp in milliseconds when the session was created.
`updated_at`	No	Unix timestamp in milliseconds when the session was last updated.
`last_active_at`	No	Unix timestamp in milliseconds of the last activity on this session.

clerk.get_sign_upInspect

Retrieve an in-progress sign-up from a connected Clerk application by sign-up id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns status, contact fields, missing and unverified fields, and completion timestamps.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`sign_up_id`	Yes	Clerk sign-up id (su_...) to retrieve or update.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk sign-up id (su_...).
`status`	No	Sign-up status: "missing_requirements", "complete", or "abandoned".
`username`	No	Username associated with the in-progress sign-up.
`last_name`	No	Last name collected during sign-up.
`abandon_at`	No	Unix timestamp in milliseconds when the sign-up will be abandoned.
`first_name`	No	First name collected during sign-up.
`phone_number`	No	Phone number associated with the in-progress sign-up.
`email_address`	No	Email address associated with the in-progress sign-up.
`missing_fields`	No	Fields still required before the sign-up can complete.
`created_user_id`	No	Clerk user id created when the sign-up completed.
`unverified_fields`	No	Fields that still need verification.
`created_session_id`	No	Clerk session id created when the sign-up completed.

clerk.get_userInspect

Retrieve one Clerk user by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns id, name, primary email, and created_at.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to retrieve.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Requested Clerk user summary.

clerk.get_user_oauth_access_tokenInspect

Retrieve OAuth access tokens previously issued for a Clerk user and provider. Sensitive — returned token values are secrets that grant access to the user's linked provider account; never log or expose token values.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns oauth_access_tokens.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum tokens to return when paginated.
`offset`	No	Number of tokens to skip when paginated.
`user_id`	Yes	Clerk user id (user_...) to operate on.
`provider`	Yes	OAuth provider id (for example oauth_google).
`paginated`	No	Whether to paginate results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_access_tokens`	No	OAuth access token objects for the user and provider. Treat token values as secrets.

clerk.invite_waitlist_entryInspect

Send an invite to the email address on a waitlist entry.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`ignore_existing`	No	When true, create an invitation even if one already exists for this email.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`waitlist_entry_id`	Yes	Clerk waitlist entry id (wle_...) to operate on.

Output Schema

ParametersJSON Schema

Name	Required	Description
`waitlist_entry`	No	Updated Clerk waitlist entry after inviting.

clerk.list_allowlist_identifiersInspect

List allowlisted identifiers in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns allowlist identifiers and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of identifiers to return (1–500).
`offset`	No	Number of identifiers to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`identifiers`	No	Allowlist identifiers returned for the requested page.
`total_count`	No	Total number of allowlist identifiers for the instance.

clerk.list_api_keysInspect

List API keys in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns api_keys and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of API keys to return (1–500).
`query`	No	Search query to filter API keys by name.
`offset`	No	Number of API keys to skip before returning results.
`subject`	Yes	Subject to list API keys for (user_... or org_...).
`key_type`	No	Filter by API key type (typically "api_key").
`include_invalid`	No	When true, include revoked or expired API keys.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_keys`	No	API keys matching the request.
`total_count`	No	Total number of API keys matching the filters.

clerk.list_billing_plansInspect

List billing plans in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns billing_plans summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of billing plans to return (1–500).
`offset`	No	Number of billing plans to skip before returning results.
`paginated`	No	Whether to return paginated results with total_count.
`payer_type`	No	Filter by payer type: "user" or "org".
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of billing plans matching the query.
`billing_plans`	No	Billing plans in the connected Clerk application.

clerk.list_billing_pricesInspect

List billing prices in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns billing_prices summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of billing prices to return (1–500).
`offset`	No	Number of billing prices to skip before returning results.
`plan_id`	No	Filter by billing plan id.
`paginated`	No	Whether to return paginated results with total_count.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of billing prices matching the query.
`billing_prices`	No	Billing prices in the connected Clerk application.

clerk.list_billing_statement_payment_attemptsInspect

List payment attempts for a billing statement in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns payment_attempts summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of payment attempts to return (1–500).
`offset`	No	Number of payment attempts to skip before returning results.
`paginated`	No	Whether to return paginated results with total_count.
`statement_id`	Yes	Clerk billing statement id.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of payment attempts for the statement.
`payment_attempts`	No	Payment attempts for the billing statement.

clerk.list_billing_statementsInspect

List billing statements in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns billing_statements summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of billing statements to return (1–500).
`offset`	No	Number of billing statements to skip before returning results.
`paginated`	No	Whether to return paginated results with total_count.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of billing statements matching the query.
`billing_statements`	No	Billing statements in the connected Clerk application.

clerk.list_billing_subscription_itemsInspect

List billing subscription items in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns subscription_items summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of subscription items to return (1–500).
`query`	No	Search query to filter subscription items.
`offset`	No	Number of subscription items to skip before returning results.
`status`	No	Filter by subscription item status.
`plan_id`	No	Filter by billing plan id.
`paginated`	No	Whether to return paginated results with total_count.
`payer_type`	No	Filter by payer type: "user" or "org".
`include_free`	No	When true, include free subscription items.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of subscription items matching the query.
`subscription_items`	No	Billing subscription items matching the query.

clerk.list_blocklist_identifiersInspect

List blocklisted identifiers in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns blocklist identifiers and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of identifiers to return (1–500).
`offset`	No	Number of identifiers to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`identifiers`	No	Blocklist identifiers returned for the requested page.
`total_count`	No	Total number of blocklist identifiers for the instance.

clerk.list_domainsInspect

List custom domains configured for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns custom domain summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domains`	No	Custom domains configured for the connected Clerk instance.
`total_count`	No	Total number of domains.

clerk.list_enterprise_connectionsInspect

List enterprise SSO (SAML/OIDC) connections in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns enterprise_connections summaries plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`active`	No	Filter by active status. Omit to return all connections.
`offset`	No	Number of results to skip before returning.
`organization_id`	No	Filter connections linked to this Clerk organization id (org_...).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of enterprise connections matching the query.
`enterprise_connections`	No	Enterprise SSO connections in the connected Clerk application.

clerk.list_enterprise_connection_test_runsInspect

List SAML or OIDC debug test runs for an enterprise SSO connection.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns test_runs summaries plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`offset`	No	Number of results to skip before returning.
`status`	No	Filter by test run status: "pending", "success", or "failed".
`connection_id`	Yes	Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`test_runs`	No	Enterprise connection SSO test runs.
`total_count`	No	Total number of test runs matching the query.

clerk.list_instance_organization_membershipsInspect

List all organization memberships across a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns membership id, organization_id, role, and timestamps.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of organization memberships to return (1–500).
`offset`	No	Number of organization memberships to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`memberships`	No	Organization memberships across the Clerk application.
`total_count`	No	Total number of organization memberships in the Clerk application.

clerk.list_invitationsInspect

List application invitations in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns invitation id, email_address, status, created_at, and revoked for each invitation, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of invitations to return (1–500).
`offset`	No	Number of invitations to skip before returning results.
`status`	No	Optional status filter: "pending", "accepted", "revoked", or "expired".
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitations`	No	Invitations returned for the requested page.
`total_count`	No	Total number of invitations returned on this page.

clerk.list_jwt_templatesInspect

List JWT templates in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns each template's id, name, claims, lifetime, allowed_clock_skew, created_at, updated_at, signing_algorithm, and custom_signing_key, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of JWT templates.
`jwt_templates`	No	JWT templates in the connected Clerk application.

clerk.list_m2m_tokensInspect

List M2M tokens for a machine in a connected Clerk instance.

Sensitive — returns token metadata for active machine credentials.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns M2M token summaries plus total_count. JWT-format tokens are not listed.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`offset`	No	Number of results to skip before returning.
`expired`	No	Include expired tokens (default false).
`revoked`	No	Include revoked tokens (default false).
`subject`	Yes	Machine id (mch_...) whose tokens to list.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`m2m_tokens`	No	M2M tokens for the requested page.
`total_count`	No	Total number of matching M2M tokens.

clerk.list_machinesInspect

List machines in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns machine summaries plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`query`	No	Filter by machine id (exact) or name (partial match).
`offset`	No	Number of results to skip before returning.
`order_by`	No	Sort by name or created_at; prefix with - for descending (default -created_at).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`machines`	No	Machines for the requested page.
`total_count`	No	Total number of machines in the instance.

clerk.list_oauth_applicationsInspect

List OAuth applications registered in a connected Clerk application when Clerk acts as an OAuth identity provider.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns each application's id, name, client_id, redirect_uris, scopes, public flag, and related endpoint URLs, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of OAuth applications.
`oauth_applications`	No	OAuth applications in the connected Clerk application.

clerk.list_organization_domainsInspect

List organization domains across a Clerk instance. Optionally filter to one organization via organization_id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns domain summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`query`	No	Search domains by name or organization id. Values starting with org_ match organization id exactly; otherwise performs a case-insensitive partial match on the domain name.
`offset`	No	Number of results to skip before returning.
`verified`	No	Filter by verification status: "true" or "false".
`enrollment_mode`	No	Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.
`organization_id`	No	Filter domains to a specific Clerk organization id (org_...).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domains`	No	Organization domains returned for the requested page.
`total_count`	No	Total number of domains matching the filter.

clerk.list_organization_invitationsInspect

List organization invitations across a Clerk instance. Optionally filter to one organization via organization_id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns invitation summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`offset`	No	Number of results to skip before returning.
`status`	No	Filter by invitation status: pending, accepted, revoked, or expired.
`organization_id`	No	Filter invitations to a specific Clerk organization id (org_...).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitations`	No	Invitations returned for the requested page.
`total_count`	No	Total number of invitations matching the filter.

clerk.list_organization_membershipsInspect

List members of a Clerk organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns membership id, user_id, role, and created_at for each member, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of organization memberships to return (1–500).
`offset`	No	Number of organization memberships to skip before returning results.
`organization_id`	Yes	Clerk organization id (org_...) whose members to list.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`memberships`	No	Memberships returned for the requested page.
`total_count`	No	Total number of members in the organization.

clerk.list_organization_permissionsInspect

List organization permissions in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns permission summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`query`	No	Search by name or key.
`offset`	No	Number of results to skip before returning.
`order_by`	No	Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of organization permissions.
`organization_permissions`	No	Organization permissions in the connected Clerk application.

clerk.list_organization_rolesInspect

List organization roles in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns role summaries with nested permissions and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`query`	No	Search by name or key.
`offset`	No	Number of results to skip before returning.
`order_by`	No	Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of organization roles.
`organization_roles`	No	Organization roles in the connected Clerk application.

clerk.list_organizationsInspect

List organizations in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns organization id, name, slug, members_count, and created_at for each organization, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of organizations to return (1–500).
`query`	No	Optional search string to filter organizations by name or slug.
`offset`	No	Number of organizations to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of organizations in the Clerk application.
`organizations`	No	Organizations returned for the requested page.

clerk.list_redirect_urlsInspect

List allowed redirect URLs for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns redirect URL summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of redirect URLs to return (1–500).
`offset`	No	Number of redirect URLs to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of redirect URLs.
`redirect_urls`	No	Allowed redirect URLs returned for the requested page.

clerk.list_role_setsInspect

List role sets in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns role set summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of results to return (1–500).
`query`	No	Search by name or key.
`offset`	No	Number of results to skip before returning.
`order_by`	No	Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_sets`	No	Role sets in the connected Clerk application.
`total_count`	No	Total number of role sets.

clerk.list_sessionsInspect

List sessions in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns session id, user_id, status, last_active_at, and expire_at for each session.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of sessions to return (1–500).
`offset`	No	Number of sessions to skip before returning results.
`status`	No	Filter sessions by status. Accepted values: abandoned, active, ended, expired, removed, replaced, revoked.
`user_id`	No	Filter sessions to those belonging to this Clerk user id (user_...). Clerk requires user_id or client_id when listing sessions; pass user_id here.
`client_id`	No	Filter sessions to those belonging to this Clerk client id (client_...).
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`sessions`	No	Sessions returned for the requested page.
`total_count`	No	Total number of sessions returned.

clerk.list_user_organization_invitationsInspect

List all organization invitations for a specific Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns invitation id, organization_id, email_address, role, status, and created_at.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of organization invitations to return (1–500).
`offset`	No	Number of organization invitations to skip before returning results.
`user_id`	Yes	Clerk user id (user_...) whose invitations to list.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitations`	No	Organization invitations for the user.
`total_count`	No	Total number of organization invitations for the user.

clerk.list_user_organization_membershipsInspect

List all organizations a specific Clerk user belongs to.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns membership id, organization_id, role, and timestamps.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of organization memberships to return (1–500).
`offset`	No	Number of organization memberships to skip before returning results.
`user_id`	Yes	Clerk user id (user_...) whose memberships to list.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`memberships`	No	Organization memberships for the user.
`total_count`	No	Total number of organization memberships for the user.

clerk.list_usersInspect

List users in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns user id, name, primary email, and created_at for each user, plus total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of users to return (1–500).
`offset`	No	Number of users to skip before returning results.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`users`	No	Users returned for the requested page.
`total_count`	No	Total number of users in the Clerk application.

clerk.list_waitlist_entriesInspect

List waitlist entries in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns waitlist entry summaries and total_count.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of waitlist entries to return (1–500).
`query`	No	Filter by email address or waitlist entry id.
`offset`	No	Number of waitlist entries to skip before returning results.
`status`	No	Optional status filter: "pending", "invited", "rejected", or "completed".
`order_by`	No	Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`total_count`	No	Total number of waitlist entries on this page.
`waitlist_entries`	No	Waitlist entries returned for the requested page.

clerk.lock_userInspect

Lock a Clerk user account, preventing the user from signing in until unlocked.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summary.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to lock.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after locking.

clerk.prepare_email_address_verificationInspect

Start email address verification for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a verification object with id and status. Use attempt-clerk-email-address-verification to submit the code the user receives.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`strategy`	Yes	Verification strategy: email_code sends an OTP; email_link sends a link.
`redirect_url`	No	Required when strategy is email_link. URL the user is redirected to after clicking the link.
`email_address_id`	Yes	Clerk email address id (idn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verification`	No	Verification object from the Clerk Backend API.
`email_address`	No	Clerk email address summary after preparing verification.

clerk.prepare_phone_number_verificationInspect

Send an SMS verification code to a Clerk phone number.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns a verification object with id and status. Use attempt-clerk-phone-number-verification to submit the code the user receives.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`phone_number_id`	Yes	Clerk phone number id (idn_... or phn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verification`	No	Verification object from the Clerk Backend API.

clerk.refresh_sessionInspect

Refresh an existing session in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the refreshed session object with updated expiry.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`session_id`	Yes	Clerk session id (sess_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk session id (sess_...).
`status`	No	Current status of the session.
`user_id`	No	Clerk user id (user_...) that owns this session.
`client_id`	No	Clerk client id associated with this session.
`expire_at`	No	Unix timestamp in milliseconds when this session expires.
`created_at`	No	Unix timestamp in milliseconds when the session was created.
`updated_at`	No	Unix timestamp in milliseconds when the session was last updated.
`last_active_at`	No	Unix timestamp in milliseconds of the last activity on this session.

clerk.reject_waitlist_entryInspect

Reject a waitlist entry in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated waitlist entry.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`waitlist_entry_id`	Yes	Clerk waitlist entry id (wle_...) to operate on.

Output Schema

ParametersJSON Schema

Name	Required	Description
`waitlist_entry`	No	Updated Clerk waitlist entry after rejection.

clerk.remove_organization_role_permissionInspect

Remove a permission from an organization role in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`role_id`	Yes	Clerk organization role id to retrieve, update, delete, or assign permissions to.
`permission_id`	Yes	Clerk organization permission id to retrieve, update, delete, or assign to a role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Organization role summary after removing the permission.

clerk.replace_organization_metadataInspect

Replace one metadata object entirely for a Clerk organization (existing keys in that object are removed).

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated organization summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`metadata`	Yes	New metadata object to set (replaces all existing keys).
`metadata_type`	Yes	Metadata type to replace: "public" or "private".
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Updated Clerk organization summary.

clerk.replace_role_setInspect

Replace a role set with another role set in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the migration payload from Clerk.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`role_set_id`	Yes	Clerk role set id or key to retrieve, update, or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`dest_role_set_key`	Yes	Key of the destination role set to migrate members to.
`reassignment_mappings`	No	Optional map of source role keys to destination role keys.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set_migration`	No	Clerk role set migration payload.

clerk.replace_role_set_roleInspect

Replace one role with another in a role set in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role set summary.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`role_key`	Yes	Key of the role to replace in the role set.
`role_set_id`	Yes	Clerk role set id or key to retrieve, update, or modify.
`to_role_key`	Yes	Key of the replacement role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set`	No	Updated role set summary.

clerk.replace_user_email_addressInspect

Replace all of a Clerk user's email addresses with a single verified primary email.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new primary email address summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to retrieve or modify.
`email_address`	Yes	New primary email address for the user.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`email_address`	No	New primary Clerk email address summary.

clerk.replace_user_metadataInspect

Replace the entire contents of one metadata namespace for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

The metadata body fully replaces the chosen namespace. Returns the updated user summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) whose metadata to replace.
`metadata`	Yes	New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys.
`metadata_type`	Yes	Metadata namespace to replace.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after the metadata replacement.

clerk.replace_user_phone_numberInspect

Replace a Clerk user's phone number with a single primary number.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the replacement phone number summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to retrieve or modify.
`phone_number`	Yes	New phone number in E.164 format.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`identification_status`	No	Status for the replacement number: verified (default) or reserved.

Output Schema

ParametersJSON Schema

Name	Required	Description
`phone_number`	No	Replacement Clerk phone number object from the Backend API.

clerk.revoke_actor_tokenInspect

Revoke an actor token in a connected Clerk application so it can no longer be used for impersonation.

Sensitive — invalidates a high-privilege token.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked actor token object.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`actor_token_id`	Yes	Clerk actor token id to revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`actor_token`	No	Revoked Clerk actor token object from the Backend API.

clerk.revoke_admin_portal_link_tokenInspect

Revoke an admin portal link token by id in a connected Clerk instance.

Sensitive — invalidates a single-use deep-link token.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked admin portal link token.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`revocation_reason`	No	Optional reason recorded when revoking the link token.
`admin_portal_link_token_id`	Yes	Admin portal link token id (aplt_...) to revoke.

Output Schema

ParametersJSON Schema

Name	Required	Description
`admin_portal_link_token`	No	Revoked admin portal link token from the Backend API.

clerk.revoke_api_keyInspect

Revoke an API key in a connected Clerk application so it can no longer be used.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked API key summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`api_key_id`	Yes	Clerk API key id (ak_...) to retrieve, update, delete, or revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`revocation_reason`	No	Optional reason recorded when revoking the API key.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Revoked Clerk API key from the Backend API.

clerk.revoke_invitationInspect

Revoke a pending application invitation by invitation id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Only pending invitations can be revoked.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`invitation_id`	Yes	Clerk application invitation id (inv_...) to revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitation`	No	Revoked Clerk invitation object from the Backend API.

clerk.revoke_m2m_tokenInspect

Revoke an M2M token by id in a connected Clerk instance.

Sensitive — invalidates a machine authentication token.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked M2M token.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`m2m_token_id`	Yes	Clerk M2M token id (mt_...) to revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`m2m_token`	No	Revoked M2M token from the Backend API.

clerk.revoke_organization_invitationInspect

Revoke a pending Clerk organization invitation.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Only pending invitations can be revoked. Returns the updated invitation summary with status revoked.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`invitation_id`	Yes	Clerk organization invitation id (orginv_...).
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invitation`	No	Revoked organization invitation summary.

clerk.revoke_sessionInspect

Revoke a session in a connected Clerk application, immediately ending it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked session object with status set to revoked.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`session_id`	Yes	Clerk session id (sess_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk session id (sess_...).
`status`	No	Current status of the session.
`user_id`	No	Clerk user id (user_...) that owns this session.
`client_id`	No	Clerk client id associated with this session.
`expire_at`	No	Unix timestamp in milliseconds when this session expires.
`created_at`	No	Unix timestamp in milliseconds when the session was created.
`updated_at`	No	Unix timestamp in milliseconds when the session was last updated.
`last_active_at`	No	Unix timestamp in milliseconds of the last activity on this session.

clerk.revoke_sign_in_tokenInspect

Revoke a sign-in token in a connected Clerk application so it can no longer be used.

Sensitive — invalidates a high-privilege token.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the revoked sign-in token object.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`sign_in_token_id`	Yes	Clerk sign-in token id to revoke.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`sign_in_token`	No	Revoked Clerk sign-in token object from the Backend API.

clerk.rotate_machine_secret_keyInspect

Rotate the secret key for a machine in a connected Clerk instance.

Sensitive — the response includes the new secret key; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the new secret key.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`previous_token_ttl`	Yes	Seconds the previous secret key remains valid after rotation (0–28800).

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine_secret_key`	No	Rotated machine secret key payload from the Backend API.

clerk.rotate_oauth_application_secretInspect

Rotate the client secret for a confidential OAuth application in a connected Clerk application.

Sensitive — the response includes a new client_secret. Update authorized OAuth clients immediately and do not log the secret.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated OAuth application summary with the new client_secret.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_application_id`	Yes	Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	OAuth application summary with the new client_secret.

clerk.set_user_password_compromisedInspect

Mark a Clerk user's password as compromised. The user will be prompted to reset their password on next sign-in.

Sensitive — password-adjacent account security action.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`revoke_all_sessions`	No	When true, revoke all active sessions for the user.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after marking password compromised.

clerk.unban_usersInspect

Remove bans from one or more Clerk users, restoring their ability to sign in.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summaries and total count.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_ids`	Yes	List of one or more Clerk user ids (user_...) to unban.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`users`	No	Updated user summaries for all unbanned users.
`total_count`	No	Number of users that were unbanned.

clerk.unlock_userInspect

Unlock a locked Clerk user account, allowing the user to sign in again.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summary.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to unlock.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after unlocking.

clerk.unset_user_password_compromisedInspect

Clear the compromised-password flag for a Clerk user so they are no longer forced to reset on next sign-in.

Sensitive — password-adjacent account security action.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user object.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after clearing the compromised-password flag.

clerk.update_api_keyInspect

Update an API key in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated API key summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`claims`	No	Updated custom claims for tokens minted from this API key.
`scopes`	No	Updated permission scopes for the API key.
`subject`	No	Updated subject (user_... or org_...).
`api_key_id`	Yes	Clerk API key id (ak_...) to retrieve, update, delete, or revoke.
`description`	No	Updated description for the API key.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`seconds_until_expiration`	No	Updated seconds until expiration from now.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Updated Clerk API key from the Backend API.

clerk.update_domainInspect

Update a custom domain on a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated domain.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated domain hostname.
`domain_id`	Yes	Clerk organization domain id (dmn_...) to update, delete, or verify.
`proxy_url`	No	Updated proxy URL for a satellite domain.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Updated Clerk domain from the Backend API.

clerk.update_email_addressInspect

Update a Clerk email address by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated email address summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`primary`	No	When true, set this email as the user's primary email address.
`verified`	No	When true, mark the email address as verified.
`email_address_id`	Yes	Clerk email address id (idn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`email_address`	No	Updated Clerk email address summary.

clerk.update_enterprise_connectionInspect

Update an enterprise SSO connection in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated enterprise_connection summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated display name for the connection.
`oidc`	No	Updated OIDC client configuration.
`saml`	No	Updated SAML IdP configuration.
`active`	No	Whether the connection is active.
`domains`	No	Updated domain list (replaces existing domains when provided).
`connection_id`	Yes	Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.
`organization_id`	No	Clerk organization id (org_...) to link to this connection.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`custom_attributes`	No	Updated custom attribute mappings.
`sync_user_attributes`	No	Whether to sync user attributes on each sign-in.
`allow_organization_account_linking`	No	Whether account linking via organization membership is allowed.
`disable_additional_identifications`	No	Whether to block additional identifications for this connection.

Output Schema

ParametersJSON Schema

Name	Required	Description
`enterprise_connection`	No	Updated enterprise SSO connection.

clerk.update_instance_communication_settingsInspect

Update SMS communication settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated communication settings.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`blocked_country_codes`	No	ISO country codes to block from receiving SMS messages (up to 250).

Output Schema

ParametersJSON Schema

Name	Required	Description
`communication_settings`	No	Updated Clerk instance communication settings from the Backend API.

clerk.update_instance_oauth_settingsInspect

Update OAuth settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated OAuth settings.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_jwt_access_tokens`	No	Whether OAuth access tokens should be issued as JWTs.
`dynamic_oauth_client_registration`	No	Whether dynamic OAuth client registration should be enabled.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_settings`	No	Updated Clerk instance OAuth settings from the Backend API.

clerk.update_instance_organization_settingsInspect

Update organization feature settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated organization settings.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`enabled`	No	Whether organizations should be enabled for the instance.
`creator_role`	No	Default role assigned to the organization creator.
`domains_enabled`	No	Whether organization domains should be enabled.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`admin_delete_enabled`	No	Whether organization admins can delete their organization.
`domains_default_role`	No	Default role for members who join via a verified organization domain.
`initial_role_set_key`	No	Initial role set key applied to new organizations.
`max_allowed_memberships`	No	Maximum organization memberships allowed per user.
`domains_enrollment_modes`	No	Allowed organization domain enrollment modes: manual_invitation, automatic_invitation, or automatic_suggestion.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_settings`	No	Updated Clerk instance organization settings from the Backend API.

clerk.update_instance_restrictionsInspect

Update sign-up and sign-in restriction settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated instance restrictions.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`allowlist`	No	Whether the allowlist restriction should be enabled.
`blocklist`	No	Whether the blocklist restriction should be enabled.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`block_email_subaddresses`	No	Whether email subaddresses (plus-addressing) should be blocked.
`block_disposable_email_domains`	No	Whether disposable email domains should be blocked.
`allowlist_blocklist_disabled_on_sign_in`	No	Whether allowlist and blocklist checks should be skipped during sign-in.

Output Schema

ParametersJSON Schema

Name	Required	Description
`restrictions`	No	Updated Clerk instance restrictions from the Backend API.

clerk.update_instance_settingsInspect

Update core settings for a connected Clerk application instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated instance settings.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`hibp`	No	Whether Have I Been Pwned password checking should be enabled.
`test_mode`	No	Whether the instance should run in test mode.
`support_email`	No	Support email address shown to end users.
`allowed_origins`	No	Allowed browser origins for the instance.
`clerk_js_version`	No	Pinned Clerk.js version for the instance.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`development_origin`	No	Development origin URL for local testing.
`url_based_session_syncing`	No	Whether URL-based session syncing should be enabled.
`preferred_sign_in_strategy_when_password_required`	No	Preferred sign-in strategy when a password is required: "password" or "otp".

Output Schema

ParametersJSON Schema

Name	Required	Description
`instance_settings`	No	Updated Clerk instance settings from the Backend API.

clerk.update_jwt_templateInspect

Update an existing JWT template in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated template summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Optional new unique template name.
`claims`	No	Optional new JWT claims template as a JSON object.
`lifetime`	No	Optional new token lifetime in seconds (30–315360000).
`signing_key`	No	Optional custom signing private key.
`template_id`	Yes	Clerk JWT template id (jtmp_...) to retrieve, update, or delete.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`signing_algorithm`	No	Optional custom signing algorithm.
`allowed_clock_skew`	No	Optional new allowed clock skew in seconds (0–300).
`custom_signing_key`	No	Optional flag to enable or disable a custom signing key.

Output Schema

ParametersJSON Schema

Name	Required	Description
`jwt_template`	No	Updated Clerk JWT template summary.

clerk.update_machineInspect

Update a machine in a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated machine.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated machine display name.
`machine_id`	Yes	Clerk machine id (mch_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`default_token_ttl`	No	Updated default M2M token lifetime in seconds.

Output Schema

ParametersJSON Schema

Name	Required	Description
`machine`	No	Updated machine object from the Backend API.

clerk.update_oauth_applicationInspect

Update an OAuth application in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated OAuth application summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	New display name for the OAuth application.
`public`	No	Whether this is a public OAuth client (no client secret; PKCE-capable).
`scopes`	No	Space-delimited scopes (e.g. profile email public_metadata).
`redirect_uris`	No	Replacement list of allowed redirect URIs.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_application_id`	Yes	Clerk OAuth application id (oa_...) to retrieve, update, or delete.
`consent_screen_enabled`	No	Whether to show the OAuth consent screen during authorization.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	Updated Clerk OAuth application summary.

clerk.update_organizationInspect

Update fields for a Clerk organization.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated organization summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Optional new display name for the organization.
`slug`	No	Optional new URL-friendly slug.
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`public_metadata`	No	Optional public metadata to merge into the organization.
`private_metadata`	No	Optional private metadata to merge into the organization.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`max_allowed_memberships`	No	Optional new maximum number of memberships allowed.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Updated Clerk organization summary.

clerk.update_organization_domainInspect

Update enrollment mode or verification status for an organization domain.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated domain summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`verified`	No	Whether the domain is verified.
`domain_id`	Yes	Clerk organization domain id (dmn_...) to update, delete, or verify.
`enrollment_mode`	No	Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Updated organization domain summary.

clerk.update_organization_membershipInspect

Change the role of a Clerk organization member.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated membership.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`role`	Yes	New role for the member (e.g. org:member, org:admin).
`user_id`	Yes	Clerk user id (user_...) of the member to update.
`organization_id`	Yes	Clerk organization id (org_...) containing the member.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`membership`	No	Updated organization membership.

clerk.update_organization_membership_metadataInspect

Merge public or private metadata on a Clerk organization membership.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated membership.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) of the member.
`organization_id`	Yes	Clerk organization id (org_...) containing the membership.
`public_metadata`	No	Public metadata to merge into the membership.
`private_metadata`	No	Private metadata to merge into the membership.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`membership`	No	Updated organization membership.

clerk.update_organization_metadataInspect

Merge metadata into a Clerk organization (deep merge — existing keys are preserved unless overwritten).

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated organization summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`organization_id`	Yes	Clerk organization id (org_...) to operate on.
`public_metadata`	No	Public metadata to merge into the organization.
`private_metadata`	No	Private metadata to merge into the organization.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization`	No	Updated Clerk organization summary.

clerk.update_organization_permissionInspect

Update an organization permission in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated permission summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated permission display name.
`description`	No	Updated permission description.
`permission_id`	Yes	Clerk organization permission id to retrieve, update, delete, or assign to a role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_permission`	No	Updated organization permission summary.

clerk.update_organization_roleInspect

Update an organization role in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated role display name.
`role_id`	Yes	Clerk organization role id to retrieve, update, delete, or assign permissions to.
`description`	No	Updated role description.
`permissions`	No	Permission keys to assign to the role.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`is_creator_eligible`	No	Whether this role may be assigned as organization creator.

Output Schema

ParametersJSON Schema

Name	Required	Description
`organization_role`	No	Updated organization role summary.

clerk.update_phone_numberInspect

Update a Clerk phone number by id.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated phone number summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`primary`	No	Whether this should be the user's primary phone number.
`verified`	No	Whether the phone number should be marked verified.
`phone_number_id`	Yes	Clerk phone number id (idn_... or phn_...) to retrieve or modify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`reserved_for_second_factor`	No	Whether to reserve this number for multi-factor authentication.

Output Schema

ParametersJSON Schema

Name	Required	Description
`phone_number`	No	Updated Clerk phone number object from the Backend API.

clerk.update_role_setInspect

Update a role set in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated role set summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated role set display name.
`description`	No	Updated role set description.
`role_set_id`	Yes	Clerk role set id or key to retrieve, update, or modify.
`creator_role_key`	No	Updated creator role key.
`default_role_key`	No	Updated default role key.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`role_set`	No	Updated role set summary.

clerk.update_sign_upInspect

Update an in-progress sign-up in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`sign_up_id`	Yes	Clerk sign-up id (su_...) to retrieve or update.
`external_id`	No	External id for the guest signing up; copied to the user when sign-up completes.
`custom_action`	No	When true, marks the sign-up as a custom action.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Clerk sign-up id (su_...).
`status`	No	Sign-up status: "missing_requirements", "complete", or "abandoned".
`username`	No	Username associated with the in-progress sign-up.
`last_name`	No	Last name collected during sign-up.
`abandon_at`	No	Unix timestamp in milliseconds when the sign-up will be abandoned.
`first_name`	No	First name collected during sign-up.
`phone_number`	No	Phone number associated with the in-progress sign-up.
`email_address`	No	Email address associated with the in-progress sign-up.
`missing_fields`	No	Fields still required before the sign-up can complete.
`created_user_id`	No	Clerk user id created when the sign-up completed.
`unverified_fields`	No	Fields that still need verification.
`created_session_id`	No	Clerk session id created when the sign-up completed.

clerk.update_userInspect

Update profile fields for a Clerk user.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to update.
`username`	No	Optional username.
`last_name`	No	Optional last name.
`first_name`	No	Optional first name.
`external_id`	No	Optional external id for the user.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user summary.

clerk.update_user_metadataInspect

Merge metadata fields for a Clerk user. Only the provided metadata keys are updated.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) whose metadata to update.
`public_metadata`	No	Public metadata fields to merge. Existing keys not listed are preserved.
`unsafe_metadata`	No	Unsafe metadata fields to merge. Existing keys not listed are preserved.
`private_metadata`	No	Private metadata fields to merge. Existing keys not listed are preserved.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Updated Clerk user object after the metadata merge.

clerk.upload_oauth_application_logoInspect

Upload or replace the logo image for an OAuth application in a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated OAuth application summary.

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description
`file_name`	Yes	Stored file name from files.list_uploaded_files. Upload with files.upload_file first.
`uploader_user_id`	No	Clerk user id (user_...) credited with the image upload.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.
`oauth_application_id`	Yes	Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_application`	No	OAuth application summary with updated client_image_url.

clerk.verify_api_keyInspect

Verify an API key against a connected Clerk application.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the verified API key summary when valid.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`secret`	Yes	API key secret to verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`api_key`	No	Verified Clerk API key from the Backend API.

clerk.verify_clientInspect

Verify a client JWT from the Clerk Frontend API.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the verified client object.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`token`	Yes	JWT representing the active Clerk client.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`client`	No	Verified client object from the Backend API.

clerk.verify_m2m_tokenInspect

Verify an M2M token in a connected Clerk instance.

Sensitive — accepts a machine token value; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns verified M2M token metadata.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`token`	Yes	M2M token string to verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`m2m_token`	No	Verified M2M token metadata from the Backend API.

clerk.verify_oauth_access_tokenInspect

Sensitive — accepts an OAuth access token; do not log or expose it.

Verify an OAuth access token issued by a connected Clerk application acting as an OAuth identity provider.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns token metadata when active (including subject user id, client_id, scopes, and expiration) or active=false when the token is unknown, invalid, or an inactive JWT.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`access_token`	Yes	OAuth access token to verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`oauth_access_token`	No	Verification result from the Clerk Backend API.

clerk.verify_organization_domain_ownershipInspect

Mark an organization domain's DNS ownership as verified via manual override.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Idempotent when ownership is already verified. Returns the updated domain summary.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain_id`	Yes	Clerk organization domain id (dmn_...) to update, delete, or verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`domain`	No	Organization domain summary after ownership verification.

clerk.verify_user_passwordInspect

Verify that a Clerk user's password matches the supplied value. Useful for support and custom re-verification flows.

Sensitive — accepts a plain-text password; do not log or expose it.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns verified (true when the password matches).

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`user_id`	Yes	Clerk user id (user_...) to operate on.
`password`	Yes	Plain-text password to verify.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verified`	No	True when the password matches the user's stored password.

clerk.verify_user_totpInspect

Verify a time-based one-time password or backup code for a Clerk user. Backup codes are consumed when used.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns verified and code_type when successful.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`code`	Yes	TOTP or backup code to verify.
`user_id`	Yes	Clerk user id (user_...) to operate on.
`clerk_instance_id`	No	Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`verified`	No	True when the code is valid.
`code_type`	No	Type of code verified (for example totp or backup_code).

domains.check_availabilityInspect

Check domain name availability for up to ten domains in one request.

Returns a JSON object whose keys are the requested domain names and whose values are booleans: true if the domain appears available, false if it is taken.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domains`	Yes	Domain names to check (maximum 10).

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

domains.dns_recordsInspect

Fetch DNS records for a domain.

Returns an array of records. Each record includes name, ttl, type (for example A, AAAA, CNAME, MX, NS, SOA, TXT), and data (record value).

Optionally pass subdomain to include records for a host under the domain (for example blog for blog.example.com).

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain`	Yes	Domain name to look up (for example example.com).
`subdomain`	No	Optional subdomain label to include (for example www or blog).

Output Schema

ParametersJSON Schema

Name	Required	Description
`records`	No	DNS records returned for the domain.

domains.list_tldsInspect

List or search top-level domains (TLDs) with registry metadata.

Filter by substring search, availability phase, TLD category, and paginate with limit and page. limit defaults to 100 when omitted. Each result includes the TLD suffix, type, availability phase, WHOIS server, domain counts when known, registry organization details, and created/changed timestamps.

availability values: general-availability (open for normal registration) or sunrise (trademark sunrise period before general availability).

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description
`page`	No	Page number for paginated results.
`limit`	No	Maximum number of TLDs to return. Defaults to 100 when omitted.
`search`	No	Return TLDs whose suffix contains this substring.
`tld_type`	No	Filter by TLD category: country-code, generic, generic-restricted, infrastructure, or sponsored.
`availability`	No	Filter by registration phase: general-availability (normal public registration) or sunrise (early trademark-holder period).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tlds`	No	Matching top-level domain records.

domains.lookupInspect

Look up a domain and return normalized registration details.

Combines registry and registrar RDAP and WHOIS sources to return the most accurate normalized fields across TLDs: availability, domain status, created/updated/expiry dates, registrar data, contact records, and nameservers.

Use this when you need registrant-oriented summary data rather than raw WHOIS or RDAP payloads.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain`	Yes	Domain name to look up (for example example.com).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tld`	No	Top-level domain suffix.
`dates`	No	Registration lifecycle dates.
`domain`	No	Looked-up domain name.
`source`	No	Primary data source used for the normalized response.
`status`	No	Normalized EPP status codes.
`keyword`	No	Second-level domain label without the TLD.
`contacts`	No	Registrant, admin, tech, and billing contact records.
`registrar`	No	Registrar summary data.
`nameservers`	No	Authoritative nameserver host names.
`availability`	No	Availability state (for example registered or available).

domains.metricsInspect

Analyze a domain with comprehensive SEO metrics, backlink data, and social signals.

Returns authority metrics (Moz domain/page authority, Ahrefs domain rating, Majestic trust and citation flow), backlink profile counts (total backlinks, referring domains, EDU/GOV links), traffic and keyword estimates (organic traffic, traffic value, organic keywords, Ahrefs rank), social signals (Facebook shares/comments, Pinterest pins, StumbleUpon), and technical data (IP addresses, subnets, topical trust flow categories).

Cost = 40 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain`	Yes	Domain name to analyze (for example example.com).

Output Schema

ParametersJSON Schema

Name	Required	Description
`mozDA`	No	Moz domain authority score (0-100).
`mozPA`	No	Moz page authority score (0-100).
`domain`	No	Analyzed domain name.
`ahrefsDR`	No	Ahrefs domain rating (0-100).
`stumbles`	No	Total StumbleUpon shares.
`FB_shares`	No	Total Facebook shares.
`ahrefsRank`	No	Global website ranking from Ahrefs.
`majesticCF`	No	Majestic citation flow score (0-100).
`majesticTF`	No	Majestic trust flow score (0-100).
`FB_comments`	No	Total Facebook comments.
`last_updated`	No	When the metrics snapshot was last updated.
`ahrefsTraffic`	No	Estimated monthly organic traffic.
`majesticLinks`	No	Total links from the Majestic database.
`pinterest_pins`	No	Total Pinterest saves.
`ahrefsBacklinks`	No	Total number of backlinks from Ahrefs.
`ahrefsRefDomains`	No	Number of unique referring domains from Ahrefs.
`ahrefsTrafficValue`	No	Estimated value of organic traffic.
`ahrefsOrganicKeywords`	No	Number of ranking organic keywords.

domains.rdapInspect

Look up raw RDAP (Registration Data Access Protocol) data for a domain.

Returns registrar entities, domain status codes, registration and expiration events, nameservers, DNSSEC delegation data, RDAP conformance labels, and registry notices.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain`	Yes	Domain name to look up (for example example.com).

Output Schema

ParametersJSON Schema

Name	Required	Description
`events`	No	Registration, expiration, and last-changed timestamps.
`status`	No	EPP status codes for the domain.
`ldhName`	No	Domain name in LDH form.
`entities`	No	Registrar, registrant, and related RDAP entities.
`secureDNS`	No	DNSSEC delegation and DS record data.
`nameservers`	No	Authoritative nameservers for the domain.
`objectClassName`	No	RDAP object class (for example domain).

domains.tld_detailsInspect

Look up detailed registry information for a single top-level domain (TLD).

Returns status, TLD type, availability phase, WHOIS and RDAP servers, registry URL, domain counts, delegation dates, registry organization, administrative/technical contacts, and remarks.

Pass the TLD suffix without a leading dot (for example io or com).

Cost = 1 token.

ParametersJSON Schema

Name	Required	Description	Default
`tld`	Yes	TLD suffix to look up without a leading dot (for example io).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tld`	No	TLD suffix without a leading dot.
`type`	No	TLD category (for example country-code or generic).
`level`	No	TLD level (1 for standard TLDs).
`status`	No	Delegation status (for example ACTIVE).
`changed`	No	TLD record last changed timestamp.
`created`	No	TLD delegation created timestamp.
`remarks`	No	Additional registry notes or links.
`contacts`	No	Registry contact records.
`rdap_server`	No	Authoritative RDAP server URL.
`availability`	No	Registration phase for the TLD.
`organization`	No	Registry operator contact details.
`registry_url`	No	Registry web site URL.
`whois_server`	No	Authoritative WHOIS server host name.
`domains_count`	No	Approximate registered domain count when reported by the registry.

domains.whoisInspect

Fetch WHOIS registration data for a domain.

Returns a JSON object keyed by WHOIS server host name. Each value contains parsed fields such as Domain Name, registrar details, dates, name servers, domain status, DNSSEC data, and raw text lines.

Set include_registrar to true to query registry and registrar servers (slower, more complete). Default false queries the registry server only.

Cost = 4 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`domain`	Yes	Domain name to look up (for example example.com).
`include_registrar`	No	When true, query registry and registrar WHOIS servers for more complete data. When false (default), query the registry server only.

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

files.delete_fileInspect

Permanently delete a file from the authenticated account's upload storage.

Pass file_name from files.list_uploaded_files. The file is removed from storage and any linked upload session is marked expired.

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`file_name`	Yes	Relative file name or path to delete. Use files.list_uploaded_files to see available names.

Output Schema

ParametersJSON Schema

Name	Required	Description
`file_name`	No	Deleted file name.

files.download_fileInspect

Reserve a direct download for a previously uploaded file.

Pass the file_name from files.list_uploaded_files (paths such as folder/subfolder/name.ext are supported). Vee3 returns a download_code.

Install the Vee3 CLI once with npm install -g @vee3/cli (requires Node 18+), then run vee3-get-file {download_code} ./path/to/save in the terminal. The CLI does not need an API key.

If installation fails with a TLS or certificate error (common on networks that inspect HTTPS traffic), use Node 22.15 or newer and run with NODE_OPTIONS=--use-system-ca, or configure npm to trust your network's root certificate.

Download codes can be resolved within 60 minutes of reserve.

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`file_name`	Yes	Relative file name or path to download. Use files.list_uploaded_files to see available names.

Output Schema

ParametersJSON Schema

Name	Required	Description
`command`	No	Suggested terminal command for downloading to a local path.
`file_name`	No	Stored file name.
`expires_at`	No	ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).
`size_bytes`	No	Object size in bytes when known.
`download_id`	No	Stable identifier for the reserved download.
`content_type`	No	MIME type on the stored object when known.
`download_code`	No	Short code to pass to the @vee3/get-file CLI.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.

files.extend_fileInspect

Extend retention for a file that was uploaded with files.upload_file and appears in files.list_uploaded_files with retained_until.

Adds additional_retention_days to the current schedule (or from now if retention already expired). Only files with a completed upload session and retention metadata can be extended.

Cost = max(1, ceil(size_gibibytes * additional_retention_days * 2)) tokens.

ParametersJSON Schema

Name	Required	Description	Default
`file_name`	Yes	Relative file name or path to extend. Use files.list_uploaded_files and choose a file that includes retained_until.
`additional_retention_days`	Yes	Days to add to the file's retention schedule.

Output Schema

ParametersJSON Schema

Name	Required	Description
`file_name`	No	Extended file name.
`size_bytes`	No	File size in bytes used for billing.
`token_cost`	No	Tokens billed for this extension.
`retained_until`	No	ISO 8601 timestamp when the file is now scheduled to be removed.
`additional_retention_days`	No	Days added in this request.

files.list_uploaded_filesInspect

List files currently stored for the authenticated Vee3 account.

Returns file_name (including any folders), content_type, size_bytes, uploaded_at, and retained_until when known. Use file_name to reference a file in other capabilities.

Optional folder limits results to that folder path and its subfolders (for example media/clips).

retained_until is when the file will be removed (based on retention_days at upload).

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`folder`	No	Optional folder path (for example media/clips). When set, only files under that folder (including nested subfolders) are returned. Do not use '..' or absolute paths.

Output Schema

ParametersJSON Schema

Name	Required	Description
`files`	No	Files currently stored for the authenticated account, newest first.

files.move_fileInspect

Move a stored file to a new account-relative path.

Pass source_file_name from files.list_uploaded_files and the desired destination_file_name. The file is copied to the new path and the source is removed. Any linked upload session is updated to the new path.

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`source_file_name`	Yes	Current relative file name or path. Use files.list_uploaded_files to see available names.
`destination_file_name`	Yes	New relative file name or path. Must not already exist in account storage.

Output Schema

ParametersJSON Schema

Name	Required	Description
`source_file_name`	No	Previous file name.
`destination_file_name`	No	New file name after the move.

files.upload_fileInspect

Reserve a direct upload slot for a local file.

Pass the desired file_name. To place a file in folders, use a path in file_name (folder/subfolder/.../name). Optionally pass retention_days (default 7, minimum 1). The name may omit an extension. Vee3 returns an upload_code.

Install the Vee3 CLI once with npm install -g @vee3/cli (requires Node 18+), then run vee3-upload {upload_code} {file_path} in the terminal. The CLI resolves the code to a signed upload URL, streams the local file to Vee3 storage, and prints the stored file_name after the upload finishes. Use that file_name in files.list_uploaded_files and other capabilities. The CLI does not need an API key.

Files can be up to 2 GB. Retention is chosen at reserve time (default 7 days). After the upload is detected, Vee3 bills max(1, ceil(size_gibibytes * retention_days * 2)) tokens. Upload codes can be resolved within 60 minutes of reserve.

Use files.list_uploaded_files to list stored uploads for follow-up work.

Cost = 0 tokens to reserve. After upload completes, billing is max(1, ceil(size_gibibytes * retention_days * 2)) tokens.

ParametersJSON Schema

Name	Required	Description	Default
`file_name`	Yes	Desired file name or path for the uploaded file. Use folder/subfolder/.../file_name to organize files in folders. Extension is optional and is replaced based on detected file type. Do not use '..' or absolute paths.
`retention_days`	No	How many days to keep the file after upload completes. Default 7. Billing uses size and this retention.

Output Schema

ParametersJSON Schema

Name	Required	Description
`command`	No	Suggested terminal command for uploading the local file.
`max_bytes`	No	Maximum allowed file size in bytes.
`upload_id`	No	Stable identifier for the reserved upload.
`expires_at`	No	ISO 8601 timestamp when the upload code can no longer be resolved (60 minutes after reserve).
`upload_code`	No	Short code to pass to the @vee3/upload CLI.
`retention_days`	No	Days the file will be retained after upload completes.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or uploading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.

google-maps.languagesInspect

List supported language codes for Google Maps place endpoints.

Returns languages as a map of language names to codes (for example English: en). Use these codes with the language parameter on place detail, review, and photo calls.

Cost = 1 token.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`languages`	No	Map of language names to language codes for Google Maps place endpoints (for example English: en).

google-maps.nearby_searchInspect

Search for places near a latitude and longitude.

Required: location. Optional: radius (defaults to 1000 meters when sort_by is Relevance), keyword, place_type, open_now, min_price, max_price, language, region, and cursor. When sort_by is Distance, omit radius and provide keyword or place_type. Pass cursor from a previous cursor_next to fetch the next page.

Returns matching places in places. Use place_id with place detail, review, and photo endpoints.

cursor_next and cursor_previous appear only when pagination cursors are available. Additional upstream fields may appear.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Pagination cursor from cursor_next on a previous response.
`radius`	No	Search radius in meters (default 1000).
`region`	No	Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.
`keyword`	No	Keyword to match nearby places (for example restaurant).
`sort_by`	No	Result ordering: "Relevance" (default) or "Distance".
`language`	No	Language code for results (for example en).
`location`	Yes	Latitude and longitude of the search point (for example 40,-110).
`open_now`	No	When true, return only places open for business at query time.
`max_price`	No	Maximum price level (0–4, inclusive).
`min_price`	No	Minimum price level (0–4, inclusive).
`place_type`	No	Restrict results to a single Google Maps place type (for example restaurant).

Output Schema

ParametersJSON Schema

Name	Required	Description
`places`	No	Nearby places matching the search criteria. Additional upstream fields may appear.
`cursor_next`	No	Cursor for the next page when more results are available.
`cursor_previous`	No	Cursor for the previous page when available.

google-maps.place_detailsInspect

Get detailed information for a Google Maps place.

Provide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional region and language are supported.

Returns a flat place object with fields such as name, full_address, location, hours, status, rating, review_count, website, phone_number, and types when available. Additional upstream fields may appear.

Cost = 4 tokens.

ParametersJSON Schema

Name	Required	Description
`region`	No	Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.
`language`	No	Language code for results (for example en).
`place_id`	Yes	Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).

Output Schema

ParametersJSON Schema

Name	Required	Description
`name`	No	Place display name.
`hours`	No	Opening hours when available.
`types`	No	Place type labels when available.
`rating`	No	Average user rating when available.
`status`	No	Human-readable open/closed status when available.
`website`	No	Place website when available.
`location`	No	Place coordinates when available.
`full_address`	No	Full formatted address when available.
`phone_number`	No	Place phone number when available.
`review_count`	No	Total number of reviews when available.

google-maps.place_photosInspect

Get photos for a Google Maps place.

Provide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional cursor, region, and language are supported. Pass cursor from a previous cursor_next to fetch the next page.

Returns place metadata and a photos array. Each photo has photo_url and description when available. cursor_next appears only when a pagination cursor is available. Additional upstream fields may appear.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Pagination cursor from cursor_next on a previous response.
`region`	No	Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.
`language`	No	Language code for results (for example en).
`place_id`	Yes	Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).

Output Schema

ParametersJSON Schema

Name	Required	Description
`place`	No	Place metadata for the photo listing.
`photos`	No	Place photos.
`cursor_next`	No	Cursor for the next page when more results are available.

google-maps.place_reviewsInspect

Get reviews for a Google Maps place.

Provide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional sort_by (Relevant, Lowest, Highest, Newest), cursor, region, and language are supported. Pass cursor from a previous cursor_next to fetch the next page.

Returns place metadata and a reviews array. Each review includes fields such as review_id, review_text, rating, and user_name. cursor_next appears only when a pagination cursor is available. Additional upstream fields may appear.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Pagination cursor from cursor_next on a previous response.
`region`	No	Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.
`sort_by`	No	Review sort order: "Relevant" (default), "Lowest", "Highest", or "Newest".
`language`	No	Language code for results (for example en).
`place_id`	Yes	Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).

Output Schema

ParametersJSON Schema

Name	Required	Description
`place`	No	Place metadata for the reviewed location.
`reviews`	No	Place reviews.
`cursor_next`	No	Cursor for the next page when more results are available.

google-maps.place_typesInspect

List supported Google Maps place type values for search filters.

Returns place_types as a string array. Use a value with place_type on google-maps.search or google-maps.nearby_search.

Cost = 1 token.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`place_types`	No	Supported Google Maps place type string values.

google-maps.review_detailsInspect

Get details for one Google Maps review.

Provide review_id from a place reviews response. Returns one review object at the top level with fields such as review_id, review_text, rating, and user_name when available. Additional upstream fields may appear.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`review_id`	Yes	Google Maps review identifier.

Output Schema

ParametersJSON Schema

Name	Required	Description
`rating`	No	Star rating for the review.
`review_id`	No	Review identifier.
`user_name`	No	Reviewer display name when available.
`review_text`	No	Review body text.

google-maps.searchInspect

Search Google Maps by text query.

Optional filters include location, radius (defaults to 1000 meters), open_now, min_price, max_price, place_type, language, and region. Pass cursor from a previous cursor_next to fetch the next page.

Returns matching places in places with names, full_address, place_id, ratings, and location. Use place_id with place detail, review, and photo endpoints.

cursor_next and cursor_previous appear only when pagination cursors are available. Additional upstream fields may appear.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`query`	Yes	Search query for places (for example restaurants in Paris).
`cursor`	No	Pagination cursor from cursor_next on a previous response.
`radius`	No	Search radius in meters (default 1000).
`region`	No	Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.
`language`	No	Language code for results (for example en).
`location`	No	Optional latitude and longitude bias point (for example 40,-110). A location embedded in the query may override this.
`open_now`	No	When true, return only places open for business at query time.
`max_price`	No	Maximum price level (0–4, inclusive).
`min_price`	No	Minimum price level (0–4, inclusive).
`place_type`	No	Restrict results to a single Google Maps place type (for example restaurant).

Output Schema

ParametersJSON Schema

Name	Required	Description
`places`	No	Matching places from the text search. Additional upstream fields may appear.
`cursor_next`	No	Cursor for the next page when more results are available.
`cursor_previous`	No	Cursor for the previous page when available.

google-search.autocompleteInspect

Get Google Search autocomplete suggestions for a partial query.

Returns the normalized query and an array of suggested search phrases.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`query`	Yes	Partial search keywords or phrase.

Output Schema

ParametersJSON Schema

Name	Required	Description
`query`	No	Normalized query echoed from the request.
`suggestions`	No	Suggested search phrases for the query.

google-search.keyword_traffic_insightsInspect

Get Google keyword traffic insights and related keyword suggestions for a seed keyword.

Returns an array of keyword suggestions. Each item includes text, monthly search volume, competition_level, competition_index, low_bid, high_bid, and trend.

Required: keyword and language (for example en). Optional: location (for example US) for country-specific data; omit location for global results (default). Optional: mode (exact or all, default all), min_search_volume (default 0), and intent (informational, navigational, commercial, or transactional).

Cost = 20 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`mode`	No	Keyword suggestion filter: exact returns only suggestions that exactly match the seed keyword; all returns all suggestions (default).	all
`intent`	No	Filter by search intent: informational, navigational, commercial, or transactional.
`keyword`	Yes	Seed keyword to get traffic insights and suggestions for.
`language`	Yes	Language code for the search market (for example en).
`location`	No	Optional country or region code for localized traffic (for example US). Omit for global keyword insights.
`min_search_volume`	No	Minimum monthly search volume; only keywords at or above this threshold are returned.

Output Schema

ParametersJSON Schema

Name	Required	Description
`keyword_suggestions`	No	Keyword suggestions with traffic and competition metrics.

google-search.languagesInspect

List languages you can pass as language on google-search.keyword_traffic_insights and google-search.url_traffic_insights.

Returns an array of entries with language_name and language_code (for example en, de). Maps to upstream lang on the provider API. No request parameters.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`languages`	No	Supported languages for the language request parameter.

google-search.locationsInspect

List countries and region codes you can pass as location on google-search.keyword_traffic_insights and google-search.url_traffic_insights.

Returns an array of entries with country_name and country_code (for example US, GB). No request parameters.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`locations`	No	Supported countries for the location request parameter.

google-search.url_traffic_insightsInspect

Get Google keyword traffic insights and related keyword suggestions for a URL.

Returns an array of keyword suggestions. Each item includes text, monthly search volume, competition_level, competition_index, low_bid, high_bid, and trend.

Required: url and language (for example en). Optional: location (for example US) for country-specific data; omit location for global results (default). Optional: min_search_volume (default 0) and intent (informational, navigational, commercial, or transactional).

Cost = 20 tokens.

ParametersJSON Schema

Name	Required	Description
`url`	Yes	Public http or https URL to get traffic insights and suggestions for.
`intent`	No	Filter by search intent: informational, navigational, commercial, or transactional.
`language`	Yes	Language code for the search market (for example en).
`location`	No	Optional country or region code for localized traffic (for example US). Omit for global URL keyword insights.
`min_search_volume`	No	Minimum monthly search volume; only keywords at or above this threshold are returned.

Output Schema

ParametersJSON Schema

Name	Required	Description
`keyword_suggestions`	No	Keyword suggestions with traffic and competition metrics.

google-trends.categoriesInspect

List all Google Trends category and subcategory labels you can pass to other Google Trends tools in the category field.

Returns cat (array of category names, including All categories) and msg. Use this before interest-over-time or interest-by-region calls when filtering by category.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`cat`	No	Category and subcategory names accepted by the category field.
`msg`	No	Status or informational message from the upstream API (often empty).

google-trends.interest_by_regionInspect

Fetch Google Trends interest-by-region breakdowns for one to five keywords.

Returns a JSON object whose top-level keys are your keywords. Each value maps location names (countries or subregions) to interest scores (0–100).

Requires start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100). Optional end defaults to now. country defaults to global; region requires a valid country. category and gprop default to all when omitted or empty. resolution is COUNTRY (default) or REGION.

Cost = 40 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`end`	No	Range end in datetime-with-timezone form. Defaults to now.
`gprop`	No	Google property filter (for example images, news, youtube, froogle). Defaults to all.
`start`	Yes	Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).
`region`	No	Region within country. Requires country when set.
`country`	No	Country name for geo filtering. Defaults to global.
`category`	No	Trends category or subcategory. Defaults to all.
`keywords`	Yes	Up to five keywords to compare.
`resolution`	No	Geographic resolution: COUNTRY (default) or REGION.	COUNTRY

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

google-trends.interest_over_timeInspect

Fetch Google Trends interest-over-time series for one to five keywords.

Returns a JSON object whose top-level keys are your keywords. Each value maps timestamps to interest scores (0–100). Granularity depends on the requested date range (from about one minute to monthly buckets).

Cost = 40 tokens.

ParametersJSON Schema

Name	Required	Description
`end`	No	Range end in datetime-with-timezone form. Defaults to now.
`gprop`	No	Google property filter (for example images, news, youtube, froogle). Defaults to all.
`start`	Yes	Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).
`region`	No	Region within country. Requires country when set.
`country`	No	Country name for geo filtering. Defaults to global.
`category`	No	Trends category or subcategory. Defaults to all.
`keywords`	Yes	Up to five keywords to compare.

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

google-trends.regionsInspect

List all countries and subregions you can pass to other Google Trends tools in the country and region fields.

Returns geo.countries: each country name maps to country (label) and regions (array of subregion names). Also returns msg.

Use this before interest-over-time or interest-by-region calls when filtering by geography. Pair with google-trends.categories when filtering by category.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`geo`	No	Geographic options keyed by country name.
`msg`	No	Status or informational message (often empty).

google-trends.related_queriesInspect

Fetch Google Trends related queries for one to five keywords.

Returns a JSON object whose top-level keys are your keywords. Each value has top and rising sections; each section has query (rank index to query string) and value (rank index to score).

Use google-trends.categories and google-trends.regions to discover valid category, country, and region values.

Cost = 40 tokens.

ParametersJSON Schema

Name	Required	Description
`end`	No	Range end in datetime-with-timezone form. Defaults to now.
`gprop`	No	Google property filter (for example images, news, youtube, froogle). Defaults to all.
`start`	Yes	Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).
`region`	No	Region within country. Requires country when set.
`country`	No	Country name for geo filtering. Defaults to global.
`category`	No	Trends category or subcategory. Defaults to all.
`keywords`	Yes	Up to five keywords to compare.

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

google-trends.suggestionsInspect

Get Google Trends suggestions for a single keyword.

Returns result: an array of suggested topics and entities, each with mid (topic id), title (display name), and type (for example Topic, Software, Book).

Use this to refine keywords before interest-over-time, interest-by-region, or related-queries calls.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`keyword`	Yes	Keyword or phrase to get suggestions for.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	No	Suggested topics and entities for the keyword.

meta-tools.describeInspect

Describe a single Vee3 capability.

Pass the MCP tool name (for example website-screenshots.capture) or capability id (for example website-screenshot). Use this after meta-tools.list_group_tools when you need parameter names, defaults, response fields, examples, and token cost before calling a tool

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`tool_name`	Yes	MCP tool name (for example `x-twitter.create_post`) or capability id (for example `create-x-post`).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tool`	No	Full capability detail including fields, examples, and bindings.
`capability_id`	No	Described capability id.

meta-tools.list_allInspect

List all live Vee3 agent tools.

Use this when you need to discover which tools exist and what they are called in MCP. Each entry includes mcp_tool_name, group_id, and summary. Use meta-tools.describe for full request/response schemas and token costs

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`tools`	No	Live tool summaries for every capability exposed to agents.

meta-tools.list_groupsInspect

List all Vee3 capability groups.

Use this to see how tools are organized (for example website-screenshots or meta-tools) before listing tools in a specific group

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`groups`	No	Capability groups with live tool counts.

meta-tools.list_group_toolsInspect

List live tools belonging to a single capability group.

Use group_id from meta-tools.list_groups (for example website-screenshots). Returns name and summary for each live tool in the group

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`group_id`	Yes	Group id to list tools for (for example website-screenshots).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tools`	No	Live tool summaries in the requested group.
`group_id`	No	Requested group id.

meta-tools.report_bugInspect

Report a bug, error, or anything that did not work as expected while using Vee3.

Use this when a capability fails unexpectedly, returns wrong data, or behaves inconsistently. Include what you tried, what happened, and any error output

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description
`summary`	Yes	Short title describing the issue.
`description`	Yes	Detailed explanation of what went wrong, what was expected, and steps to reproduce if known.
`error_details`	No	Raw error message, stack trace, or API response that shows the failure.
`related_capability_id`	No	MCP tool name or capability id involved in the issue, if applicable.

Output Schema

ParametersJSON Schema

Name	Required	Description
`status`	No	Submission status. Always "received" on success.
`report_id`	No	Unique identifier for the submitted bug report.
`created_at`	No	ISO 8601 timestamp when the report was recorded.

meta-tools.request_featureInspect

Request a new capability or feature that Vee3 does not offer yet.

Use this when you need something that is not available in the catalog — a missing integration, data source, workflow, or enhancement to an existing capability. Describe what you need, why you cannot accomplish it today, and how you would use it

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description
`summary`	Yes	Short title describing the requested capability or feature.
`use_case`	No	Example workflow or scenario where this feature would be used.
`description`	Yes	Detailed explanation of what is needed, why it cannot be done with existing tools, and how it would help.
`related_capability_id`	No	Capability id this request extends or relates to, if applicable.

Output Schema

ParametersJSON Schema

Name	Required	Description
`status`	No	Submission status. Always "received" on success.
`created_at`	No	ISO 8601 timestamp when the request was recorded.
`request_id`	No	Unique identifier for the submitted feature request.

meta-tools.searchInspect

Search live Vee3 agent tools by keyword or short task description.

Call this first when you are unsure which tool to use. Returns ranked matches with tool_name, summary, and cost for each hit. Use meta-tools.describe on the best match for full request and response schemas.

Optional group_id narrows results to one capability group. limit defaults to 8 (maximum 20).

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum results to return (1–20).
`query`	Yes	Keywords or short task description (for example `tiktok video comments` or `domain availability`).
`group_id`	No	Optional group id to narrow results (for example `x-twitter`).

Output Schema

ParametersJSON Schema

Name	Required	Description
`query`	No	Normalized search query that was executed.
`results`	No	Ranked capability matches visible to the caller.

meta-tools.token_balanceInspect

Get the current API token balance for the authenticated account.

Returns tokens used, tokens remaining, monthly allowance, billing plan, and when the allowance resets (billing_period_end). Use this before expensive calls or when you receive a 402 insufficient_tokens response

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`tokens_used`	No	Tokens consumed in the current billing period.
`billing_plan`	No	Current billing plan id (free, starter, pro, scale).
`tokens_remaining`	No	Tokens left before quota is exhausted.
`billing_period_end`	No	ISO 8601 end of the current billing period.
`billing_period_start`	No	ISO 8601 start of the current billing period.
`monthly_token_allowance`	No	Total tokens included in the current billing period.
`billing_period_resets_at`	No	ISO 8601 timestamp when the token allowance resets (same as period end).

rotten-tomatoes.celebrity_detailsInspect

Look up a celebrity on Rotten Tomatoes by slug (for example morgan-freeman).

Returns name, bio, birth date and place, profile image, and filmography lists for movies and TV with scores and years.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`celebrity_slug`	Yes	Celebrity slug (for example morgan-freeman).

Output Schema

ParametersJSON Schema

Name	Required	Description
`tv`	No	TV credits with title, slug, year, and score.
`name`	No	Celebrity name.
`slug`	No	Celebrity slug.
`movies`	No	Movie credits with title, slug, year, and score.

rotten-tomatoes.movie_cast_and_crewInspect

List cast and crew credits for a movie by slug (for example shawshank-redemption).

Returns cast and crew members with names, roles, character names, and profile links where available.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`movie_slug`	Yes	Movie slug (for example shawshank-redemption).

Output Schema

ParametersJSON Schema

Name	Required	Description
`cast`	No	Cast and crew credits for the movie.
`slug`	No	Movie slug.

rotten-tomatoes.movie_detailsInspect

Look up a movie on Rotten Tomatoes by slug (for example shawshank-redemption).

Returns title, year, rating, runtime, genres, description, poster and hero images, Tomatometer and Popcornmeter scores, cast highlights, and where to watch links.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`movie_slug`	Yes	Movie slug (for example shawshank-redemption).

Output Schema

ParametersJSON Schema

Name	Required	Description
`cast`	No	Featured cast with name, slug, and imageUrl.
`slug`	No	Movie slug.
`year`	No	Release year.
`title`	No	Movie title.
`tomatometer`	No	Critic Tomatometer score and metadata.
`popcornmeter`	No	Audience Popcornmeter score and metadata.

rotten-tomatoes.movie_reviewsInspect

Load reviews for a movie by slug (for example shawshank-redemption).

Returns review quotes, sentiment, publication, critic details, and pageInfo for pagination. Use cursor from pageInfo.endCursor for the next page. Optionally set type to critic for critic reviews only.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of review pages to return (1–50, default 20).
`cursor`	No	Pagination cursor from a previous response pageInfo.endCursor field.
`movie_slug`	Yes	Movie slug (for example shawshank-redemption).
`review_type`	No	Review filter. Use critic for critic reviews; omit for the default set.

Output Schema

ParametersJSON Schema

Name	Required	Description
`slug`	No	Movie slug.
`type`	No	Review set type (for example critic).
`reviews`	No	Review entries with quote, sentiment, critic, and publication.
`pageInfo`	No	Pagination metadata for review listings.

rotten-tomatoes.searchInspect

Search Rotten Tomatoes by title or name.

Returns matching movies, TV series, and celebrities with slugs, scores, poster URLs, release years, and top-billed cast where available.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of search results to return (1–50, default 20).
`query`	Yes	Search query for movies, TV series, or celebrities.

Output Schema

ParametersJSON Schema

Name	Required	Description
`query`	No	Echo of the search query.
`movies`	No	Search hits (movies, TV series, or celebrities). Each entry includes type, slug, title, url, posterUrl, score, and cast when available.

rotten-tomatoes.tv_show_cast_and_crewInspect

List cast and crew credits for a TV series by slug (for example breaking-bad).

Returns cast and crew members with names, roles, character names, and profile links where available.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`tv_show_slug`	Yes	TV series slug (for example breaking-bad).

Output Schema

ParametersJSON Schema

Name	Required	Description
`cast`	No	Cast and crew credits for the series.
`slug`	No	TV series slug.

rotten-tomatoes.tv_show_detailsInspect

Look up a TV series on Rotten Tomatoes by slug (for example breaking-bad).

Returns title, years on air, TV rating, season count, genres, description, poster and hero images, Tomatometer and Popcornmeter scores, and creator/cast highlights.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`tv_show_slug`	Yes	TV series slug (for example breaking-bad).

Output Schema

ParametersJSON Schema

Name	Required	Description
`slug`	No	TV series slug.
`year`	No	Years on air (for example 2008 - 2013).
`title`	No	Series title.
`tomatometer`	No	Average Tomatometer score and metadata.
`popcornmeter`	No	Average Popcornmeter score and metadata.

rotten-tomatoes.tv_show_episodeInspect

Load a single episode by TV series slug (for example breaking-bad), season number, and episode number.

Returns episode title, air date, description, and episode Tomatometer score when available.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`tv_show_slug`	Yes	TV series slug (for example breaking-bad).
`season_number`	Yes	Season number as one or two digits (for example 1 or 01).
`episode_number`	Yes	Episode number as one or two digits (for example 1 or 01).

Output Schema

ParametersJSON Schema

Name	Required	Description
`slug`	No	TV series slug.
`title`	No	Episode title.
`season`	No	Season number.
`episode`	No	Episode number.

rotten-tomatoes.tv_show_seasonInspect

Load season-level details for a TV series by slug (for example breaking-bad) and season number.

Returns season title, episode list summaries, and season Tomatometer scores when available.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`tv_show_slug`	Yes	TV series slug (for example breaking-bad).
`season_number`	Yes	Season number as one or two digits (for example 1 or 01).

Output Schema

ParametersJSON Schema

Name	Required	Description
`slug`	No	TV series slug.
`season`	No	Season identifier.
`episodes`	No	Episodes in the season when listed.

rotten-tomatoes.tv_show_season_reviewsInspect

Load reviews for a TV season by series slug (for example breaking-bad) and season number.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of review pages to return (1–50, default 20).
`cursor`	No	Pagination cursor from a previous response pageInfo.endCursor field.
`review_type`	No	Review filter. Use critic for critic reviews; omit for the default set.
`tv_show_slug`	Yes	TV series slug (for example breaking-bad).
`season_number`	Yes	Season number as one or two digits (for example 1 or 01).

Output Schema

ParametersJSON Schema

Name	Required	Description
`slug`	No	TV series slug.
`season`	No	Season number.
`reviews`	No	Review entries with quote, sentiment, critic, and publication.
`pageInfo`	No	Pagination metadata for review listings.

seo.backlinksInspect

Find backlinks pointing to a website URL.

Returns an overview (domain rating, URL rating, backlink counts, referring domains, dofollow breakdown) and a list of individual backlinks with anchor text, source and target URLs, domain rating, and redirect chains.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Public website URL to check for backlinks.
`include_subdomains`	No	When true (default), include backlinks to the domain and its subdomains. When false, analyze only the exact URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`overview`	No	Aggregate backlink statistics for the target.
`backlinks`	No	Individual backlink records with anchor text and source URLs.

seo.basic_metricsInspect

Get Ahrefs domain authority signals for a website URL.

Returns domainRating (0–100 Ahrefs authority score) and ahRank (global Ahrefs website rank). Useful for comparing site strength and prioritizing outreach or competitive research.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Public website URL to analyze (for example https://example.com).

Output Schema

ParametersJSON Schema

Name	Required	Description
`ahRank`	No	Global website rank (lower is stronger).
`domainRating`	No	Domain authority score from 0 to 100.

seo.country_codesInspect

List country codes you can pass as country on seo.keyword_metrics.

Returns an array of 2-letter ISO country codes (for example us, gb, de).

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`country_codes`	No	Supported ISO country codes for keyword metrics.

seo.keyword_metricsInspect

Get SEO metrics for a search keyword in a specific country market.

Returns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`country`	No	2-letter ISO country code for the target market (default us). Use seo.country_codes for supported values.	us
`keyword`	Yes	Search keyword or phrase to analyze.

Output Schema

ParametersJSON Schema

Name	Required	Description
`cpc`	No	Estimated cost per click in paid search.
`clicks`	No	Estimated monthly clicks from organic search.
`keyword`	No	Analyzed keyword.
`difficulty`	No	Keyword difficulty score (higher is harder to rank).
`searchVolume`	No	Estimated monthly search volume in the selected country.
`trafficPotential`	No	Estimated traffic potential if ranking well.
`globalSearchVolume`	No	Estimated global monthly search volume.

seo.url_metricsInspect

Get detailed Ahrefs SEO metrics for a specific URL.

Returns two sections:

page: backlinks, referring domains, estimated traffic, traffic value, organic keywords, URL rating, and word count on the page
domain: domain rating, rank, backlinks, referring domains, traffic, traffic value, and organic keywords

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Public page URL to analyze.

Output Schema

ParametersJSON Schema

Name	Required	Description
`page`	No	Metrics for the requested page URL.
`domain`	No	Metrics for the parent domain.

tiktok.comment_repliesInspect

List replies to a TikTok comment. Requires video_id and comment_id. Pass cursor from a previous response to fetch the next page.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of replies to return (max 40).
`cursor`	No	Pagination cursor from a previous response.
`video_id`	Yes	TikTok video id.
`comment_id`	Yes	TikTok comment id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.download_musicInspect

Download a TikTok music track so the user or agent can save and reuse it.

Provide either music_id or music_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run vee3-get-file.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`music_id`	No	TikTok music id.
`file_name`	No	Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.
`music_url`	No	TikTok music page URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`command`	No	Suggested terminal command for downloading to a local path.
`file_url`	No	Signed download URL from account file storage.
`file_name`	No	Account-relative path where the file was stored.
`expires_at`	No	ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).
`download_id`	No	Stable identifier for the reserved agent download session.
`content_type`	No	MIME type of the music file.
`download_code`	No	Short code to pass to the @vee3/cli `vee3-get-file` command.
`retained_until`	No	ISO 8601 timestamp when account storage retention expires.
`file_size_bytes`	No	Music file size in bytes.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.
`tiktok_download_id`	No	Unique TikTok download operation identifier, prefix td_.

tiktok.download_music_from_videoInspect

Download music from a TikTok video so the user or agent can save and reuse it.

Provide either video_id or video_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run vee3-get-file.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`video_id`	No	TikTok video id.
`file_name`	No	Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.
`video_url`	No	TikTok video URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`command`	No	Suggested terminal command for downloading to a local path.
`file_url`	No	Signed download URL from account file storage.
`file_name`	No	Account-relative path where the file was stored.
`expires_at`	No	ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).
`download_id`	No	Stable identifier for the reserved agent download session.
`content_type`	No	MIME type of the music file.
`download_code`	No	Short code to pass to the @vee3/cli `vee3-get-file` command.
`retained_until`	No	ISO 8601 timestamp when account storage retention expires.
`file_size_bytes`	No	Music file size in bytes.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.
`tiktok_download_id`	No	Unique TikTok download operation identifier, prefix td_.

tiktok.download_videoInspect

Download a TikTok video so the user or agent can save and reuse it.

Provide either video_id or video_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run vee3-get-file.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`quality`	No	Video quality to download. 'standard' is default quality; 'hd' is high definition. Only one selected quality is downloaded.	standard
`video_id`	No	TikTok video id.
`file_name`	No	Optional account-relative storage path for the video. If omitted, the file is stored under downloads/ with a generated name.
`video_url`	No	TikTok video URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`command`	No	Suggested terminal command for downloading to a local path.
`quality`	No	Echo of the requested video quality (standard or hd).
`file_url`	No	Signed download URL from account file storage.
`file_name`	No	Account-relative path where the file was stored.
`expires_at`	No	ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).
`download_id`	No	Stable identifier for the reserved agent download session.
`content_type`	No	MIME type of the downloaded file.
`download_code`	No	Short code to pass to the @vee3/cli `vee3-get-file` command.
`retained_until`	No	ISO 8601 timestamp when account storage retention expires.
`file_size_bytes`	No	Downloaded file size in bytes.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.
`tiktok_download_id`	No	Unique TikTok download operation identifier, prefix td_.

tiktok.for_you_feedInspect

Fetch for-you feed videos for a region. Requires region.

Cost = 4 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`count`	No	Number of videos to return (max 20).
`region`	Yes	Region code (for example us, jp, kr).

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	For-you feed videos from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.music_detailsInspect

Look up metadata for a TikTok music track. Provide either music_id or music_url, not both.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`music_id`	No	TikTok music id.
`music_url`	No	TikTok music page URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.music_videosInspect

List videos that use a TikTok music track. Requires music_id. Pass cursor from a previous response to fetch the next page.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 30).
`cursor`	No	Pagination cursor from a previous response.
`music_id`	Yes	TikTok music id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.search_photosInspect

Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 30).
`query`	Yes	Search keywords.
`cursor`	No	Pagination cursor from a previous response.
`region`	No	Region code (for example us, jp, kr).

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.search_usersInspect

Search TikTok users by keyword. Requires query. Pass cursor from a previous response to fetch the next page.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`count`	No	Number of items to return (max 30).
`query`	Yes	Search keywords.
`cursor`	No	Pagination cursor from a previous response.
`follower_count`	No	Follower count filter: 0-4.	0

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.search_videosInspect

Search TikTok videos by keyword. Requires query. Pass cursor from a previous response to fetch the next page.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`count`	No	Number of items to return (max 30).
`query`	Yes	Search keywords.
`cursor`	No	Pagination cursor from a previous response.
`region`	No	Region code (for example us, jp, kr).
`sort_by`	No	Sort order: relevance, like_count, or date_posted.	relevance
`publish_time`	No	Publish time filter: 0, 1, 7, 30, 90, or 180.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.user_followersInspect

List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 200).
`cursor`	No	Pagination cursor from a previous response.
`user_id`	Yes	TikTok numeric user id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.user_followingInspect

List accounts a TikTok user follows. Requires user_id. Pass cursor from a previous response to fetch the next page.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 200).
`cursor`	No	Pagination cursor from a previous response.
`user_id`	Yes	TikTok numeric user id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.user_infoInspect

Look up a TikTok user profile. Provide either user_id or unique_id, not both.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`user_id`	No	TikTok numeric user id.
`unique_id`	No	TikTok unique id (username).

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.user_repostsInspect

List reposts for a TikTok user. Provide either user_id or unique_id, not both. Pass cursor from a previous response to fetch the next page.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 30).
`cursor`	No	Pagination cursor from a previous response.
`user_id`	No	TikTok numeric user id.
`unique_id`	No	TikTok unique id (username).

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.user_videosInspect

List videos posted by a TikTok user. Provide either user_id or unique_id, not both. Set latest to true for newest posts or false for top posts. Pass cursor from a previous response to fetch the next page.

Cost = 3 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of items to return (max 30).
`cursor`	No	Pagination cursor from a previous response.
`latest`	No	When true, return latest videos. When false, return top videos.
`user_id`	No	TikTok numeric user id.
`unique_id`	No	TikTok unique id (username).

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.video_commentsInspect

List comments on a TikTok video. Provide either video_id or video_url, not both. Pass cursor from a previous response to fetch the next page.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description
`count`	No	Number of comments to return (max 50).
`cursor`	No	Pagination cursor from a previous response.
`video_id`	No	TikTok video id.
`video_url`	No	TikTok video URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

tiktok.video_detailsInspect

Look up metadata for a TikTok video. Provide either video_id or video_url, not both.

Cost = 1 token.

ParametersJSON Schema

Name	Required	Description	Default
`video_id`	No	TikTok video id.
`video_url`	No	TikTok video URL.

Output Schema

ParametersJSON Schema

Name	Required	Description
`msg`	No	Upstream status message.
`code`	No	Upstream status code (0 = success).
`data`	No	Capability-specific payload from the upstream provider.
`processed_time`	No	Upstream processing time in seconds.

website-screenshots.captureInspect

Capture a screenshot of a public website so the user or agent can inspect its layout, content, and UI.

The image is saved to account file storage. The response includes screenshot_url for API users and download_code for agents to run vee3-get-file.

Cost = 20 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Public http or https URL to capture. Private, localhost, and internal network addresses are blocked.
`format`	No	Output image format. 'png' preserves lossless quality (default). 'jpeg' produces smaller files.	png
`quality`	No	JPEG compression quality from 0 (smallest) to 100 (best). Only applies when format is 'jpeg'; ignored for PNG.
`dark_mode`	No	When true, emulate prefers-color-scheme: dark so sites with dark-mode CSS render in dark mode. Has no effect on sites without dark-mode styling.
`file_name`	No	Optional account-relative storage path for the screenshot. If omitted, the file is stored under downloads/ with a generated name.
`full_page`	No	Capture the full scrollable page. When false, only the viewport area is captured.
`wait_until`	No	When to take the screenshot: 'load' (load event), 'domcontentloaded' (DOM ready, faster), or 'networkidle' (no network activity for 500ms, slowest but most complete).	domcontentloaded
`viewport_width`	No	Browser viewport width in pixels.
`timeout_seconds`	No	Maximum seconds to wait for the page to load before failing.
`viewport_height`	No	Browser viewport height in pixels.
`block_cookie_banners`	No	When true, attempt to dismiss common cookie consent banners and overlays before capture. Best-effort - custom or first-party banners may remain.

Output Schema

ParametersJSON Schema

Name	Required	Description
`url`	No	Echo of requested URL.
`format`	No	Echo of the requested output format (png or jpeg).
`status`	No	Always "completed" for synchronous capture.
`command`	No	Suggested terminal command for downloading to a local path.
`quality`	No	Echo of JPEG quality used when format is jpeg.
`dark_mode`	No	Echo of whether dark color scheme emulation was used.
`file_name`	No	Account-relative path where the screenshot was stored.
`full_page`	No	Whether full page was captured.
`created_at`	No	ISO 8601 timestamp.
`expires_at`	No	ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).
`download_id`	No	Stable identifier for the reserved download.
`download_code`	No	Short code to pass to the @vee3/cli `vee3-get-file` command.
`screenshot_id`	No	Unique identifier, prefix ss_.
`retained_until`	No	ISO 8601 timestamp when account storage retention expires.
`screenshot_url`	No	Signed download URL from account file storage.
`viewport_width`	No	Actual viewport width used.
`file_size_bytes`	No	Image file size in bytes.
`install_command`	No	One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.
`troubleshooting`	No	What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.
`viewport_height`	No	Actual viewport height used.
`block_cookie_banners`	No	Echo of whether cookie banner dismissal was attempted.

x-twitter.connected_accountsInspect

List X (Twitter) accounts connected to the authenticated Vee3 account for write capabilities.

Returns user_id, user_name, display name, avatar URL, and whether each account is the default. Use user_id or user_name on future write calls, or omit both to use the default account.

If accounts is empty, the user must connect an X account at https://vee3.io/dashboard/connections before write capabilities work. Agents cannot complete OAuth; ask the user to connect, then call this tool again.

Cost = 0 tokens.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`accounts`	No	Active connected X accounts for the authenticated Vee3 account.

x-twitter.create_bookmarkInspect

Bookmark a post for a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Cost = 30 tokens.

ParametersJSON Schema

Name	Required	Description
`post_id`	Yes	Numeric id of the post to bookmark.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user_id`	No	Numeric X user id of the connected account.
`user_name`	No	X handle of the connected account.
`bookmarked`	No	Whether the post is bookmarked after this request.

x-twitter.create_postInspect

Publish a post to a connected X account via the official X API (POST /2/tweets).

Call x-twitter.connected_accounts first. If accounts is empty, the user must connect an X account at https://vee3.io/dashboard/connections before posting. Agents cannot complete OAuth; ask the user to connect, then call x-twitter.connected_accounts again.

Pass user_id or user_name to target a specific account, not both. Omit both to use the default connected account.

At least one of text, poll, media, or card_uri is required.

Supports text, polls, media attachments, reply settings, paid partnership disclosure, AI-generated labels, super-follower exclusivity, nullcast posts, cards, communities, and direct-message deep links.

To attach media, upload files with files.upload_file and the @vee3/upload CLI, then pass file_name values returned by files.list_uploaded_files in the media array (up to 4 files). Only files listed by list_uploaded_files can be attached. poll, media, and card_uri are mutually exclusive in the X API.

Token pricing: 60 tokens base for text posts. Posts whose text includes a URL are billed 1000 tokens base instead. Attaching only media (an image or video) without a URL in the text does not trigger the URL rate. Each attached image adds 50 tokens. Each attached video adds 150 tokens plus 50 tokens per 5 MB of video size.

X rate limit: 100 POST /2/tweets requests per connected user per 15 minutes. Wait and retry if posting is temporarily blocked.

If X authorization fails, reconnect the account in the Vee3 dashboard. Read the error message when X rejects a post and adjust the request.

ParametersJSON Schema

Name	Required	Description
`poll`	No	Poll object with options (2-4 strings) and duration_minutes (5-10080).
`text`	No	Post text content. At least one of text, poll, media, or card_uri is required.
`media`	No	File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file and @vee3/upload first, then list_uploaded_files to get the stored file_name values.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`card_uri`	No	Card URI for the post. Mutually exclusive with poll and media.
`nullcast`	No	Whether the post is promoted-only and hidden from the public timeline.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`community_id`	No	Community id when posting to an X community.
`made_with_ai`	No	Whether the post contains AI-generated media.
`reply_settings`	No	Who can reply to the post.
`paid_partnership`	No	Whether the post is a paid partnership.
`share_with_followers`	No	Whether to share a community post with followers too.
`direct_message_deep_link`	No	Deep link that moves the conversation into Direct Messages.
`for_super_followers_only`	No	Whether the post is exclusive to super followers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`text`	No	Post text returned by the X API.
`user_id`	No	Numeric X user id of the connected account that published the post.
`tweet_id`	No	Numeric id of the created or edited post.
`user_name`	No	X handle of the connected account that published the post.

x-twitter.delete_bookmarkInspect

Remove a bookmarked post for a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Cost = 30 tokens.

ParametersJSON Schema

Name	Required	Description
`post_id`	Yes	Numeric id of the bookmarked post to remove.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user_id`	No	Numeric X user id of the connected account.
`user_name`	No	X handle of the connected account.
`bookmarked`	No	Whether the post is bookmarked after this request.

x-twitter.delete_postInspect

Delete a post published by a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Cost = 25 tokens.

ParametersJSON Schema

Name	Required	Description
`post_id`	Yes	Numeric id of the post to delete.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`deleted`	No	Whether the post was deleted.
`user_id`	No	Numeric X user id of the connected account.
`user_name`	No	X handle of the connected account.

x-twitter.edit_postInspect

Edit a recent post from a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Requires post_id and at least one of text, media, paid_partnership, or made_with_ai.

Edits must be within X's one-hour window after posting. The authenticated X account may need X Premium for API edits. Posts with polls and some other types cannot be edited. Each edit returns a new post_id.

To attach media, upload files with files.upload_file and pass file_name values from files.list_uploaded_files.

Token pricing matches x-twitter.create_post: 60 tokens base, 1000 with URL, plus media surcharges.

ParametersJSON Schema

Name	Required	Description
`text`	No	Updated post text.
`media`	No	File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file first.
`post_id`	Yes	Numeric id of the post to edit.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`made_with_ai`	No	Whether the post contains AI-generated media.
`paid_partnership`	No	Whether the post is a paid partnership.

Output Schema

ParametersJSON Schema

Name	Required	Description
`text`	No	Post text returned by the X API.
`post_id`	No	Numeric id of the edited post returned by the X API.
`user_id`	No	Numeric X user id of the connected account.
`user_name`	No	X handle of the connected account.

x-twitter.get_bookmarksInspect

Fetch bookmarked posts for a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Returns raw X API data with tweet objects, expanded authors, media, polls, and places. Use next_cursor to fetch the next page.

Cost = 25 tokens.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of bookmarks to return (default 20, max 100).
`cursor`	No	Pagination cursor from a previous response next_cursor field.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`data`	No	Bookmarked posts returned by the X API.
`includes`	No	Expanded users, media, polls, places, and referenced posts.
`next_cursor`	No	Cursor for the next page of bookmarks, when available.
`result_count`	No	Number of bookmarks in this page.

x-twitter.reply_to_postInspect

Reply to a post from a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Requires reply_to_post_id. Supports the same content options as x-twitter.create_post: text, polls, media, reply settings, paid partnership disclosure, AI-generated labels, super-follower exclusivity, nullcast posts, cards, communities, and direct-message deep links.

At least one of text, poll, media, or card_uri is required, same as x-twitter.create_post.

Token pricing matches x-twitter.create_post.

ParametersJSON Schema

Name	Required	Description
`poll`	No	Poll object with options (2-4 strings) and duration_minutes (5-10080).
`text`	No	Reply text content. At least one of text, poll, media, or card_uri is required.
`media`	No	File names from files.list_uploaded_files to attach (up to 4).
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`card_uri`	No	Card URI for the post. Mutually exclusive with poll and media.
`nullcast`	No	Whether the post is promoted-only and hidden from the public timeline.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`community_id`	No	Community id when posting to an X community.
`made_with_ai`	No	Whether the post contains AI-generated media.
`reply_settings`	No	Who can reply to the post.
`paid_partnership`	No	Whether the post is a paid partnership.
`reply_to_post_id`	Yes	Numeric id of the post to reply to.
`share_with_followers`	No	Whether to share a community post with followers too.
`exclude_reply_user_ids`	No	User ids to exclude from the reply mention list.
`direct_message_deep_link`	No	Deep link that moves the conversation into Direct Messages.
`for_super_followers_only`	No	Whether the post is exclusive to super followers.
`auto_populate_reply_metadata`	No	Whether to automatically populate reply metadata.

Output Schema

ParametersJSON Schema

Name	Required	Description
`text`	No	Reply text returned by the X API.
`post_id`	No	Numeric id of the reply post.
`user_id`	No	Numeric X user id of the connected account.
`user_name`	No	X handle of the connected account.

x-twitter.repost_postInspect

Repost a post for a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Returns the reposted post_id and retweeted status.

Cost = 75 tokens.

ParametersJSON Schema

Name	Required	Description
`post_id`	Yes	Numeric id of the post to repost.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`post_id`	No	Numeric id of the reposted post.
`user_id`	No	Numeric X user id of the connected account.
`retweeted`	No	Whether the post was reposted.
`user_name`	No	X handle of the connected account.

x-twitter.searchInspect

Search public X (Twitter) posts matching a keyword or phrase.

Returns a timeline of matching posts with tweet text, engagement counts, author info, media, and quoted tweets. Use cursor from next_cursor to fetch the next page. search_type controls ranking: Top (default), Latest, Media, People, or Lists.

Cost = 5 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`query`	Yes	Search keywords or phrase.
`cursor`	No	Pagination cursor from a previous response next_cursor field.
`search_type`	No	Result ranking mode.	Top

Output Schema

ParametersJSON Schema

Name	Required	Description
`status`	No	Search status from the upstream provider (ok on success).
`timeline`	No	Matching posts from the search. Additional provider-specific fields may appear on each entry.
`next_cursor`	No	Cursor for the next results page, when available.
`prev_cursor`	No	Cursor for the previous results page, when available.

x-twitter.tweet_infoInspect

Fetch metadata for a single public X (Twitter) post by its numeric tweet id.

Returns tweet text, engagement counts (likes, retweets, replies, quotes, bookmarks), language, conversation id, author profile summary, and attached media when present.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Numeric tweet id.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Numeric tweet id.
`lang`	No	Detected language code.
`text`	No	Tweet body text.
`likes`	No	Like count.
`media`	No	Attached media grouped by type (for example photo or video arrays). Additional provider-specific media fields may appear.
`author`	No	Author profile summary for the tweet.
`quotes`	No	Quote count.
`replies`	No	Reply count.
`retweets`	No	Repost count.
`bookmarks`	No	Bookmark count.
`created_at`	No	Tweet creation timestamp from X.
`conversation_id`	No	Conversation thread id for the tweet.

x-twitter.tweet_repliesInspect

Fetch the latest replies for a single X (Twitter) post by its numeric tweet id.

Returns a timeline of reply tweets with text, engagement counts, author info, media, and in-reply-to metadata. Use cursor from next_cursor to fetch the next page.

Cost = 4 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Numeric tweet id.
`cursor`	No	Pagination cursor from a previous response next_cursor field.

Output Schema

ParametersJSON Schema

Name	Required	Description
`status`	No	Reply fetch status from the upstream provider (ok on success).
`timeline`	No	Reply tweets, newest first. Additional provider-specific fields may appear on each entry.
`next_cursor`	No	Cursor for the next replies page, when available.
`prev_cursor`	No	Cursor for the previous replies page, when available.

x-twitter.unrepost_postInspect

Remove a repost for a connected X account.

Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.

Cost = 50 tokens.

ParametersJSON Schema

Name	Required	Description
`post_id`	Yes	Numeric id of the original post to unrepost.
`user_id`	No	Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.
`user_name`	No	X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user_id`	No	Numeric X user id of the connected account.
`retweeted`	No	Whether the post is still reposted after this request.
`user_name`	No	X handle of the connected account.

x-twitter.user_infoInspect

Fetch public profile metadata for an X (Twitter) user.

Provide user_name (handle without @) or rest_id (numeric user id). At least one is required. When rest_id is set, it takes precedence over user_name. Returns display name, bio, follower counts, verification flags, avatar URLs, and related profile fields.

Cost = 2 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`rest_id`	No	Numeric X user id (rest_id). When provided, user_name is ignored.
`user_name`	No	X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	No	Numeric X user id (may duplicate rest_id).
`desc`	No	Profile bio / description.
`name`	No	Display name shown on the profile.
`avatar`	No	Profile avatar image URL.
`status`	No	Profile lookup status from the upstream provider.
`friends`	No	Number of accounts the user follows.
`profile`	No	X screen name (handle).
`rest_id`	No	Numeric X user id.
`location`	No	Profile location string.
`protected`	No	Whether the account is protected (private).
`sub_count`	No	Follower count.
`affiliates`	No	Affiliate account metadata when present (object or empty array from the provider). Additional provider-specific fields may appear.
`created_at`	No	Account creation timestamp from X.
`media_count`	No	Total media item count.
`header_image`	No	Profile banner image URL.
`blue_verified`	No	Whether the account has X blue verification.
`statuses_count`	No	Total post count.
`business_account`	No	Business account metadata when present (object with counts or empty array from the provider when not applicable).
`verification_type`	No	Verification type label from X when present.
`pinned_tweet_ids_str`	No	Pinned tweet ids for the profile when present.

x-twitter.user_timelineInspect

Fetch a user's recent X (Twitter) posts, pinned tweet, and profile summary.

Provide user_name (handle without @) or rest_id (numeric user id). At least one is required. When rest_id is set, it takes precedence over user_name. Returns timeline entries with tweet text, engagement counts, media, quoted tweets, and author info. Use cursor from next_cursor to fetch the next page.

Cost = 4 tokens.

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Pagination cursor from a previous response next_cursor field.
`rest_id`	No	Numeric X user id (rest_id). When provided, user_name is ignored.
`user_name`	No	X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.

Output Schema

ParametersJSON Schema

Name	Required	Description
`user`	No	Profile summary for the requested user.
`pinned`	No	Pinned tweet object when the user has one pinned post.
`status`	No	Timeline fetch status from the upstream provider (ok on success).
`timeline`	No	Recent posts from the user. Additional provider-specific fields may appear on each entry.
`next_cursor`	No	Cursor for the next timeline page, when available.
`prev_cursor`	No	Cursor for the previous timeline page, when available.

youtube.channel_detailsInspect

Fetch metadata for a public YouTube channel by channel id or URL.

Accepts a channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg) or common YouTube channel URLs (for example https://www.youtube.com/@WWE). Returns title, username, description, subscriber and view counts, join date, verification flags, avatar and banner images, keywords, and external links.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`channel_id`	Yes	YouTube channel id or URL (for example UCJ5v_MCY6GNUBTO8-D3XoAg or https://www.youtube.com/@WWE).

Output Schema

ParametersJSON Schema

Name	Required	Description
`links`	No	External links listed on the channel About page.
`stats`	No	Public channel statistics.
`title`	No	Channel display name.
`avatar`	No	Channel avatar images at different sizes.
`badges`	No	Channel badges (for example Official Artist Channel).
`banner`	No	Channel banner images for desktop, mobile, and TV layouts.
`country`	No	Country associated with the channel when available.
`keywords`	No	Channel keywords from the About page.
`username`	No	Public @ handle when available.
`artistBio`	No	Artist bio text when the channel is a music artist.
`channelId`	No	Canonical YouTube channel id.
`isVerified`	No	Whether the channel is verified.
`joinedDate`	No	Channel creation date (ISO 8601).
`description`	No	Channel About description.
`isFamilySafe`	No	Whether the channel is marked family safe.
`joinedDateText`	No	Human-readable join date.
`canonicalBaseUrl`	No	Canonical channel path on YouTube when available.
`hasBusinessEmail`	No	Whether a business email is available for contact.
`isVerifiedArtist`	No	Whether the channel is a verified artist channel.

youtube.channel_searchInspect

Search public videos on a YouTube channel by keyword or phrase.

Accepts a bare channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg), not a URL. Returns matching video entries and cursorNext for pagination.

Use cursorNext from a prior response as cursor for the next page.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description
`query`	Yes	Search keywords or phrase within the channel.
`cursor`	No	Pagination cursor from cursorNext.
`channel_id`	Yes	YouTube channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg, not a URL).

Output Schema

ParametersJSON Schema

Name	Required	Description
`contents`	No	Matching video entries for the current page. Each entry includes a type field and nested video object.
`cursorNext`	No	Cursor for the next page, when available.

youtube.channel_videosInspect

Fetch a paginated list of videos from a public YouTube channel by its channel id.

Accepts a channel id (for example UCg6gPGh8HU2U01vaFCAsvmQ) or common YouTube channel URLs (for example https://www.youtube.com/@ChrisTitusTech). Use cursor from a prior response for the next page.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`cursor`	No	Pagination cursor from a previous response cursor field.
`channel_id`	Yes	YouTube channel id or URL (for example UCg6gPGh8HU2U01vaFCAsvmQ or https://www.youtube.com/@ChrisTitusTech).

Output Schema

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Cursor for the next page, when available.
`videos`	No	Channel videos for the current page.

youtube.playlist_detailsInspect

Fetch metadata for a public YouTube playlist by playlist id.

Returns title, description, creator summary, video and view counts, thumbnails, badges, and last updated timestamps.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`playlist_id`	Yes	YouTube playlist id (for example PLcirGkCPmbmFeQ1sm4wFciF03D_EroIfr).

Output Schema

ParametersJSON Schema

Name	Required	Description
`stats`	No	Public playlist statistics.
`title`	No	Playlist title.
`author`	No	Playlist creator summary.
`badges`	No	Playlist badges when available.
`playlistId`	No	Canonical YouTube playlist id.
`thumbnails`	No	Playlist thumbnail images at different sizes.
`description`	No	Playlist description.
`updatedTime`	No	Last update date (ISO 8601).
`updatedTimeText`	No	Human-readable last update time.

youtube.searchInspect

Search public YouTube content by keyword or phrase.

Returns matching result cards, estimated result count, and spelling suggestions.

Use filter parameters to apply multiple YouTube search filters:

upload_date: Last hour, Today, This week, This month, This year
content_type: Video, Channel, Playlist, Movie
duration: Under 4 minutes, 4 - 20 minutes, Over 20 minutes
features: Live, 4K, HD, Subtitles/CC, Creative Commons, 360°, VR180, 3D, HDR, Location, Purchased (multiple allowed)
sort_by: Relevance, Upload date, View count, Rating

Filter values are matched case-insensitively. Only one option per group applies except features, which accepts multiple labels.

When a requested filter cannot be applied, the API returns the best-effort results available so far and includes unappliedFilters with the labels that were skipped.

Use cursor with the same query to paginate: pass cursorNext from a prior response. Filter parameters and cursor cannot be combined.

Check didYouMean when the query may be misspelled.

Cost = 20 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`query`	Yes	Search keywords or phrase.
`cursor`	No	Pagination cursor from cursorNext.
`sort_by`	No	Sort order. One of: Relevance, Upload date, View count, Rating.
`duration`	No	Duration filter. One of: Under 4 minutes, 4 - 20 minutes, Over 20 minutes.
`features`	No	Feature filters. Multiple allowed. Each value must be one of: Live, 4K, HD, Subtitles/CC, Creative Commons, 360°, VR180, 3D, HDR, Location, Purchased.
`language`	No	Language code for localized results (for example en).	en
`location`	No	Country code for localized results (for example US).	US
`upload_date`	No	Upload date filter. One of: Last hour, Today, This week, This month, This year.
`content_type`	No	Content type filter. One of: Video, Channel, Playlist, Movie.

Output Schema

ParametersJSON Schema

Name	Required	Description
`contents`	No	Search result entries for the current page. Video entries include a type field and nested video object.
`cursorNext`	No	Cursor for the next results page, when available.
`didYouMean`	No	Suggested corrected query when the search may be misspelled.
`estimatedResults`	No	Approximate total number of matching results.
`unappliedFilters`	No	Requested filter labels that could not be applied. Present only when at least one filter was skipped.

youtube.search_autocompleteInspect

Get YouTube search autocomplete suggestions for a partial query.

Returns the normalized query and an array of suggested search phrases. Optional language and location codes localize suggestions (defaults: en, US).

Cost = 8 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`query`	Yes	Partial search keywords or phrase.
`language`	No	Language code for localized suggestions (for example en).	en
`location`	No	Country code for localized suggestions (for example US).	US

Output Schema

ParametersJSON Schema

Name	Required	Description
`query`	No	Normalized query echoed from the provider.
`results`	No	Suggested search phrases for the query.

youtube.video_commentsInspect

Fetch top-level comments for a public YouTube video by its 11-character video id.

Returns comment text, author summary, vote and reply counts, pinned status, total comment count, and cursorNext for the next page.

Use sort_by to choose comment order:

sort_by: Top comments, Newest first

Sort values are matched case-insensitively.

Use cursor with the same video_id to paginate: pass cursorNext from a prior response. sort_by and cursor cannot be combined.

Cost = 15 tokens.

ParametersJSON Schema

Name	Required	Description
`cursor`	No	Pagination cursor from a previous response cursorNext field.
`sort_by`	No	Comment sort order. One of: Top comments, Newest first.
`video_id`	Yes	YouTube video id (11 characters, not a URL).

Output Schema

ParametersJSON Schema

Name	Required	Description
`comments`	No	Top-level comments for the current page and sort order. Additional provider-specific fields may appear on each entry.
`cursorNext`	No	Cursor for the next comments page, when available.
`totalCommentsCount`	No	Total number of comments on the video.

youtube.video_detailsInspect

Fetch metadata for a public YouTube video by video id or URL.

Accepts a bare 11-character video id (for example PuQFESk0BrA) or common YouTube watch, youtu.be, Shorts, and embed URLs. Returns title, description, view count, duration, publish date, channel id, category, keywords, and thumbnails.

Cost = 10 tokens.

ParametersJSON Schema

Name	Required	Description	Default
`video_id`	Yes	YouTube video id or URL (for example PuQFESk0BrA, https://youtu.be/PuQFESk0BrA, or https://www.youtube.com/watch?v=PuQFESk0BrA).

Output Schema

ParametersJSON Schema

Name	Required	Description
`type`	No	Video type (for example NORMAL).
`title`	No	Video title.
`author`	No	Channel display name.
`category`	No	Primary category label.
`keywords`	No	Video keyword tags.
`video_id`	No	Canonical YouTube video id.
`channel_id`	No	Uploader channel id.
`thumbnails`	No	Available thumbnail images at different sizes.
`description`	No	Plain-text video description.
`video_length`	No	Video duration in seconds as a string.
`published_time`	No	Publish date (ISO 8601).
`is_live_content`	No	Whether the video is live content (True or False as a string).
`number_of_views`	No	Total view count.

Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:

{
  "$schema": "https://glama.ai/mcp/schemas/connector.json",
  "maintainers": [{ "email": "your-email@example.com" }]
}

The email address must match the email associated with your Glama account. Once published, Glama will automatically detect and verify the file within a few minutes.