Vee3

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.

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.

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.

Ban a Clerk user, 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 summary. Cost = 5 tokens.

Ban multiple Clerk users in a single request, 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.

Invite multiple 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.

Invite multiple email addresses to join a Clerk organization in one request. 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.

Add multiple 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. Cost = 10 tokens.

Remove bans from multiple Clerk users in a single request. 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Invite an email address 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.

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.

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.

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.

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.

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.

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.

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.

Invite an email address to join a Clerk organization with a specific 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 invitation summary. Cost = 10 tokens.

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.

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.

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.

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.

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.

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.

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.

Create a session token (JWT) for an active session in a connected Clerk application. **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.

Create a session token using a named JWT template for an active session in a connected Clerk application. **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.

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.

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.

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.

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.

Add an email address 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 entry. Cost = 10 tokens.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Retrieve the billing credit balance for a Clerk 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 credit_balance summary. Cost = 3 tokens.

Retrieve the billing subscription for a Clerk 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 subscription summary including nested subscription_items. Cost = 3 tokens.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Retrieve the billing credit balance 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 credit_balance summary. Cost = 3 tokens.

Retrieve the billing subscription 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 subscription summary including nested subscription_items. Cost = 3 tokens.

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.

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.

List organization domains across all organizations in a 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 domain summaries and total_count. Cost = 5 tokens.

List organization invitations across all organizations in a 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 summaries and total_count. Cost = 5 tokens.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

List verified domains for a specific 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 domain summaries and total_count. Cost = 5 tokens.

List invitations for a specific 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 invitation summaries and total_count. Cost = 5 tokens.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Remove a ban from a Clerk user, 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 summary. Cost = 5 tokens.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

Get Google Search autocomplete suggestions for a partial query. Returns the normalized query and an array of suggested search phrases. Cost = 5 tokens.

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.

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.

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.

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.

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.

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.

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). 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. Cost = 40 tokens.

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.

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). 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. Use google-trends.categories and google-trends.regions to discover valid category, country, and region values. Cost = 40 tokens.

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.

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.

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.

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.

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.

List files currently stored for the authenticated Vee3 account. Returns file_name, content_type, size_bytes, uploaded_at. Use file_name to reference a file in other capabilities. Files are stored for 14 days Cost = 0 tokens.

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.

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.

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.

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.

Reserve a direct upload slot for a local file. Pass the desired file_name only. The name may omit an extension. Vee3 returns an upload_code. Install the uploader once with `npm install -g @vee3/upload` (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 meta-tools.list_uploaded_files and other capabilities. 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. Files can be up to 2 GB and are stored for 14 days. After the upload is detected, Vee3 bills 1 token per 20 MiB, rounded up with a minimum of 1 token. Upload codes can be resolved within 60 minutes of reserve. Use `meta-tools.list_uploaded_files` to list stored uploads for follow-up work. Cost = 0 tokens to reserve. After upload completes, billing is 1 token per 20 MiB, rounded up (minimum 1 token).

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.

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.

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.

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.

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.

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.

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.

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.

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.

Load reviews for a TV season by series slug (for example breaking-bad) and season number. 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.

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.

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.

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.

Get SEO metrics for a search keyword in a specific country market. Returns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential. Cost = 10 tokens.

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.

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.

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.

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.

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.

Fetch for-you feed videos for a region. Requires region. Cost = 4 tokens.

Look up metadata for a TikTok music track. Provide either music_id or music_url, not both. Cost = 2 tokens.

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.

Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.

Search TikTok users by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.

Search TikTok videos by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.

List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens.

List accounts a TikTok user follows. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens.

Look up a TikTok user profile. Provide either user_id or unique_id, not both. Cost = 2 tokens.

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.

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.

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.

Look up metadata for a TikTok video. Provide either video_id or video_url, not both. Cost = 1 token.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.