Connection check
verified live · 26h ago
vee3
Hosted MCP with 91 agent tools: X, domains, SEO, Maps, Trends, Search, YouTube, TikTok, and more.
Tools
267
GitHub stars
—
Installs / wk
—
Licence
—
Transport
streamable-http
Last checked
26h ago
Tools & capabilities
267 toolsRead from the running server on 26h ago.
clerk.add_domain
name*proxy_urlis_satellite*clerk_instance_id
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 a… 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.
clerk.ban_users
user_ids*clerk_instance_id
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 th… 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.
clerk.change_instance_domain
home_url*is_secondaryclerk_instance_id
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 br… 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.
clerk.count_users
queryclerk_instance_id
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 u… 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.
clerk.create_actor_token
user_id*actor_sub*clerk_instance_idexpires_in_secondssession_max_duration_in_seconds
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 impersonat… 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.
clerk.create_admin_portal_link_token
scopesit_contact_idorganization_idclerk_instance_idseconds_until_expiration
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_conn… 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.
clerk.create_allowlist_identifier
notifyidentifier*clerk_instance_id
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 us… 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.
clerk.create_api_key
name*claimsscopessubject*key_typecreated_by
+3
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… 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.
clerk.create_blocklist_identifier
identifier*clerk_instance_id
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 us… 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.
clerk.create_email_address
primaryuser_id*verifiedemail_address*clerk_instance_id
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… 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.
clerk.create_enterprise_connection
name*oidcsamlactivedomains*provider*
+6
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,… 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.
clerk.create_enterprise_connection_test_run
connection_id*clerk_instance_id
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 connecti… 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.
clerk.create_invitations
invitations*clerk_instance_id
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, o… 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.
clerk.create_jwt_template
name*claims*lifetimesigning_keyclerk_instance_idsigning_algorithm
+2
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… 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.
clerk.create_m2m_token
claimstoken_formatclerk_instance_idmachine_secret_key*seconds_until_expirationmin_remaining_ttl_seconds
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… 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.
clerk.create_machine
name*scoped_machinesclerk_instance_iddefault_token_ttl
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 expo… 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.
clerk.create_machine_scope
machine_id*to_machine_id*clerk_instance_id
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 de… 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.
clerk.create_oauth_application
name*publicscopesredirect_urisclerk_instance_idconsent_screen_enabled
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. Ca… 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.
clerk.create_organization
name*slugcreated_by*public_metadataprivate_metadataclerk_instance_id
+1
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… 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.
clerk.create_organization_domain
name*verifiedenrollment_modeorganization_id*clerk_instance_id
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. Retu… 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.
clerk.create_organization_invitations
invitations*organization_id*clerk_instance_id
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 connectio… 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.
clerk.create_organization_membership
role*user_id*organization_id*clerk_instance_id
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 de… 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.
clerk.create_organization_permission
key*name*descriptionclerk_instance_id
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… 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.
clerk.create_organization_role
key*name*descriptionpermissionsclerk_instance_idinclude_in_initial_role_set
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… 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.
clerk.create_phone_number
primaryuser_id*verifiedphone_number*clerk_instance_idreserved_for_second_factor
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. Re… 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.
clerk.create_redirect_url
url*clerk_instance_id
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 d… 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.
clerk.create_session
user_id*clerk_instance_id
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… 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.
clerk.create_session_token
session_id*template_nameclerk_instance_id
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** — th… 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.
clerk.create_sign_in_token
user_id*clerk_instance_idexpires_in_seconds
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 retu… 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.
clerk.create_svix_app
clerk_instance_id
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 co… 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.
clerk.create_svix_dashboard_url
clerk_instance_id
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… 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.
clerk.create_user
passwordlast_namefirst_nameemail_address*clerk_instance_id
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 acco… 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.
clerk.create_waitlist_entries
waitlist_entries*clerk_instance_id
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,… 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.
clerk.delete_allowlist_identifier
identifier_id*clerk_instance_id
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. Retu… 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.
clerk.delete_api_key
api_key_id*clerk_instance_id
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 us… 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.
clerk.delete_blocklist_identifier
identifier_id*clerk_instance_id
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. Retur… 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.
clerk.delete_domain
domain_id*clerk_instance_id
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 defa… 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.
clerk.delete_email_address
email_address_id*clerk_instance_id
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. Re… 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.
clerk.delete_enterprise_connection
connection_id*clerk_instance_id
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… 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.
clerk.delete_jwt_template
template_id*clerk_instance_id
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 t… 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.
clerk.delete_machine
machine_id*clerk_instance_id
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 defa… 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.
clerk.delete_machine_scope
scope_id*machine_id*clerk_instance_id
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… 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.
clerk.delete_oauth_application
clerk_instance_idoauth_application_id*
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 omi… 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.
clerk.delete_organization
organization_id*clerk_instance_id
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… 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.
clerk.delete_organization_domain
domain_id*clerk_instance_id
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 def… 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.
clerk.delete_organization_membership
user_id*organization_id*clerk_instance_id
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. T… 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.
clerk.delete_organization_permission
permission_id*clerk_instance_id
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 t… 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.
clerk.delete_organization_role
role_id*clerk_instance_id
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… 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.
clerk.delete_phone_number
phone_number_id*clerk_instance_id
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 ac… 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.
clerk.delete_redirect_url
redirect_url_id*clerk_instance_id
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… 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.
clerk.delete_svix_app
clerk_instance_id
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 sp… 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.
clerk.delete_user
user_id*clerk_instance_id
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.… 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.
clerk.delete_user_backup_codes
user_id*clerk_instance_id
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 accoun… 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.
clerk.delete_user_external_account
user_id*clerk_instance_idexternal_account_id*
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… 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.
clerk.delete_user_passkey
user_id*passkey_id*clerk_instance_id
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 acc… 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.
clerk.delete_user_totp
user_id*clerk_instance_id
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 acc… 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.
clerk.delete_user_web3_wallet
user_id*web3_wallet_id*clerk_instance_id
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. Ret… 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.
clerk.delete_waitlist_entry
clerk_instance_idwaitlist_entry_id*
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… 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.
clerk.disable_user_mfa
user_id*clerk_instance_id
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… 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.
clerk.get_api_key
api_key_id*clerk_instance_id
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… 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.
clerk.get_api_key_secret
api_key_id*clerk_instance_id
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_con… 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.
clerk.get_connected_accounts
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 cle… 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.
clerk.get_development_api_keys
clerk_instance_id
Return the Publishable Key and Secret Key for a connected development Clerk instance so the agent can configure a local app env (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_… Return the Publishable Key and Secret Key for a connected development Clerk instance so the agent can configure a local app env (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY). **Sensitive** — the returned Secret Key is a high-privilege credential; do not log or expose it. Development only. Production connections are refused. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. If the connection was created before Publishable Keys were stored, ask the user to reconnect the Clerk application at https://vee3.io/dashboard/connections. Cost = 5 tokens.
clerk.get_email_address
email_address_id*clerk_instance_id
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.… 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.
clerk.get_enterprise_connection
connection_id*clerk_instance_id
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… 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.
clerk.get_instance
clerk_instance_id
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… 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.
clerk.get_instance_communication_settings
clerk_instance_id
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… 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.
clerk.get_instance_oauth_settings
clerk_instance_id
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 defa… 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.
clerk.get_instance_organization_settings
clerk_instance_id
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… 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.
clerk.get_instance_settings
clerk_instance_id
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 u… 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.
clerk.get_jwks
clerk_instance_id
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 i… 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.
clerk.get_jwt_template
template_id*clerk_instance_id
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 u… 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.
clerk.get_machine
machine_id*clerk_instance_id
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 de… 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.
clerk.get_machine_secret_key
machine_id*clerk_instance_id
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_co… 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.
clerk.get_oauth_application
clerk_instance_idoauth_application_id*
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 o… 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.
clerk.get_organization
organization_id*clerk_instance_id
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 u… 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.
clerk.get_organization_invitation
invitation_id*organization_id*clerk_instance_id
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 defau… 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.
clerk.get_organization_role
role_id*clerk_instance_id
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… 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.
clerk.get_phone_number
phone_number_id*clerk_instance_id
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. Retur… 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.
clerk.get_redirect_url
redirect_url_id*clerk_instance_id
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… 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.
clerk.get_session
session_id*clerk_instance_id
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… 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.
clerk.get_sign_up
sign_up_id*clerk_instance_id
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,… 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.
clerk.get_user
user_id*clerk_instance_id
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,… 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.
clerk.invite_waitlist_entry
ignore_existingclerk_instance_idwaitlist_entry_id*
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 def… 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.
clerk.list_allowlist_identifiers
limitoffsetclerk_instance_id
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… 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.
clerk.list_api_keys
limitqueryoffsetsubject*key_typeinclude_invalid
+1
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 acco… 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.
clerk.list_blocklist_identifiers
limitoffsetclerk_instance_id
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… 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.
clerk.list_domains
clerk_instance_id
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 t… 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.
clerk.list_enterprise_connections
limitactiveoffsetorganization_idclerk_instance_id
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 o… 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.
clerk.list_enterprise_connection_test_runs
limitoffsetstatusconnection_id*clerk_instance_id
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… 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.
clerk.list_invitations
limitoffsetstatusclerk_instance_id
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… 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.
clerk.list_jwt_templates
clerk_instance_id
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… 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.
clerk.list_m2m_tokens
limitoffsetexpiredrevokedsubject*clerk_instance_id
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… 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.
clerk.list_machines
limitqueryoffsetorder_byclerk_instance_id
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… 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.
clerk.list_oauth_applications
clerk_instance_id
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… 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.
clerk.list_organization_domains
limitqueryoffsetverifiedenrollment_modeorganization_id
+1
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 ta… 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.
clerk.list_organization_invitations
limitoffsetstatusorganization_idclerk_instance_id
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 t… 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.
clerk.list_organization_memberships
limitoffsetorganization_id*clerk_instance_id
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. Retu… 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.
clerk.list_organization_permissions
limitqueryoffsetorder_byclerk_instance_id
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… 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.
clerk.list_organization_roles
limitqueryoffsetorder_byclerk_instance_id
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 de… 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.
clerk.list_organizations
limitqueryoffsetclerk_instance_id
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… 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.
clerk.list_redirect_urls
limitoffsetclerk_instance_id
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 d… 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.
clerk.list_sessions
limitoffsetstatususer_idclient_idclerk_instance_id
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 acco… 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.
clerk.list_user_organization_memberships
limitoffsetuser_id*clerk_instance_id
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 def… 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.
clerk.list_users
limitoffsetclerk_instance_id
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… 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.
clerk.list_waitlist_entries
limitqueryoffsetstatusorder_byclerk_instance_id
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 defa… 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.
clerk.reject_waitlist_entry
clerk_instance_idwaitlist_entry_id*
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 de… 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.
clerk.replace_user_metadata
user_id*metadata*metadata_type*clerk_instance_id
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… 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.
clerk.revoke_actor_token
actor_token_id*clerk_instance_id
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… 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.
clerk.revoke_admin_portal_link_token
clerk_instance_idrevocation_reasonadmin_portal_link_token_id*
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 cle… 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.
clerk.revoke_api_key
api_key_id*clerk_instance_idrevocation_reason
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… 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.
clerk.revoke_invitation
invitation_id*clerk_instance_id
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 de… 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.
clerk.revoke_m2m_token
m2m_token_id*clerk_instance_id
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_… 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.
clerk.revoke_organization_invitation
invitation_id*organization_id*clerk_instance_id
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 acco… 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.
clerk.revoke_session
session_id*clerk_instance_id
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… 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.
clerk.revoke_sign_in_token
sign_in_token_id*clerk_instance_id
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.… 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.
clerk.rotate_machine_secret_key
machine_id*clerk_instance_idprevious_token_ttl*
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_acc… 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.
clerk.rotate_oauth_application_secret
clerk_instance_idoauth_application_id*
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… 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.
clerk.unban_users
user_ids*clerk_instance_id
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 o… 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.
clerk.update_api_key
claimsscopessubjectapi_key_id*descriptionclerk_instance_id
+1
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… 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.
clerk.update_domain
namedomain_id*proxy_urlclerk_instance_id
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 defaul… 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.
clerk.update_email_address
primaryverifiedemail_address_id*clerk_instance_id
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. Return… 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.
clerk.update_enterprise_connection
nameoidcsamlactivedomainsconnection_id*
+6
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 t… 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.
clerk.update_instance_communication_settings
clerk_instance_idblocked_country_codes
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 us… 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.
clerk.update_instance_oauth_settings
clerk_instance_idoauth_jwt_access_tokensdynamic_oauth_client_registration
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 defaul… 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.
clerk.update_instance_organization_settings
enabledcreator_roledomains_enabledclerk_instance_idadmin_delete_enableddomains_default_role
+3
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… 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.
clerk.update_instance_restrictions
allowlistblocklistclerk_instance_idblock_email_subaddressesblock_disposable_email_domainsallowlist_blocklist_disabled_on_sign_in
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… 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.
clerk.update_instance_settings
hibptest_modesupport_emailallowed_originsclerk_js_versionclerk_instance_id
+3
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… 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.
clerk.update_jwt_template
nameclaimslifetimesigning_keytemplate_id*clerk_instance_id
+3
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 us… 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.
clerk.update_machine
namemachine_id*clerk_instance_iddefault_token_ttl
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 acco… 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.
clerk.update_oauth_application
namepublicscopesredirect_urisclerk_instance_idoauth_application_id*
+1
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 th… 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.
clerk.update_organization
nameslugorganization_id*public_metadataprivate_metadataclerk_instance_id
+1
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. Re… 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.
clerk.update_organization_domain
verifieddomain_id*enrollment_modeclerk_instance_id
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… 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.
clerk.update_organization_membership
role*user_id*organization_id*clerk_instance_id
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 acco… 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.
clerk.update_organization_membership_metadata
user_id*organization_id*public_metadataprivate_metadataclerk_instance_id
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… 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.
clerk.update_organization_metadata
organization_id*public_metadataprivate_metadataclerk_instance_id
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… 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.
clerk.update_organization_permission
namedescriptionpermission_id*clerk_instance_id
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… 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.
clerk.update_organization_role
namerole_id*descriptionpermissionsclerk_instance_idis_creator_eligible
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 th… 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.
clerk.update_phone_number
primaryverifiedphone_number_id*clerk_instance_idreserved_for_second_factor
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… 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.
clerk.update_user
user_id*usernamelast_namefirst_nameexternal_idclerk_instance_id
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. Re… 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.
clerk.update_user_metadata
user_id*public_metadataunsafe_metadataprivate_metadataclerk_instance_id
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 connectio… 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.
clerk.upload_oauth_application_logo
file_name*uploader_user_idclerk_instance_idoauth_application_id*
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 co… 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.
clerk.verify_organization_domain_ownership
domain_id*clerk_instance_id
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 om… 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.
domains.add_dns_host
ttldomain*address*mx_prefhost_name*record_type*
Add one DNS host record to a managed domain without replacing the full zone. Preserves existing records. The domain must use Namecheap DNS. Call domains.get_dns_hosts afterward if… Add one DNS host record to a managed domain without replacing the full zone. Preserves existing records. The domain must use Namecheap DNS. Call domains.get_dns_hosts afterward if HostIds are needed. Cost = 5 tokens.
domains.check_availability
domains*
Check whether domain names can be registered through Vee3 (Namecheap-backed). Returns a map of each requested domain name to a boolean: true when the domain is available for purch… Check whether domain names can be registered through Vee3 (Namecheap-backed). Returns a map of each requested domain name to a boolean: true when the domain is available for purchase through Vee3, false when it is not. Cost = 5 tokens.
domains.dns_records
domain*subdomain
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). Optiona… 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.
domains.get_dns_hosts
domain*
List DNS host records for one domain this Vee3 account manages. Use for managed Namecheap DNS only. For public DNS lookup of any domain, use domains.dns_records instead. Cost = 3… List DNS host records for one domain this Vee3 account manages. Use for managed Namecheap DNS only. For public DNS lookup of any domain, use domains.dns_records instead. Cost = 3 tokens.
domains.get_managed
domain*
Get full details for one domain this Vee3 account owns or manages. Returns registration status, expiration, privacy, DNS provider type, and registration metadata. Cost = 3 tokens… Get full details for one domain this Vee3 account owns or manages. Returns registration status, expiration, privacy, DNS provider type, and registration metadata. Cost = 3 tokens.
domains.list_managed
pagelimit
List domains this Vee3 account owns or manages (registered through Vee3). Returns domain status, registration dates, lock and privacy settings, and paging metadata. Cost = 2 toke… List domains this Vee3 account owns or manages (registered through Vee3). Returns domain status, registration dates, lock and privacy settings, and paging metadata. Cost = 2 tokens.
domains.list_tlds
pagelimitsearchtld_typeavailability
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 1… 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.
domains.lookup
domain*
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: avai… 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.
domains.metrics
domain*
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… 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.
domains.rdap
domain*
Look up raw RDAP (Registration Data Access Protocol) data for a domain. Returns registrar entities, domain status codes, registration and expiration events, nameservers, DNSSEC de… 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.
domains.register
yearsdomain*contact*enable_privacyexpected_token_cost*
Register a domain through Vee3. The user or agent passes registrant contact details and expected_token_cost from domains.registration_quote. Use a real registrant email address th… Register a domain through Vee3. The user or agent passes registrant contact details and expected_token_cost from domains.registration_quote. Use a real registrant email address the domain owner can access; the registrar may send a verification email that must be completed to keep the domain in good standing. Charges the quoted token cost on success. Cost = 200 tokens + domain registration price in tokens.
domains.registration_quote
yearsdomain*
Quote registration cost in tokens for one domain and year count. Quoted cost is 200 service tokens plus the domain registration price in tokens. Token conversion depends on the ac… Quote registration cost in tokens for one domain and year count. Quoted cost is 200 service tokens plus the domain registration price in tokens. Token conversion depends on the account billing plan. Use before domains.register. Cost = 5 tokens.
domains.remove_dns_host
domain*host_id*
Remove one DNS host record from a managed domain by host_id. Preserves all other records. Get host_id from domains.get_dns_hosts. The domain must use Namecheap DNS. Cost = 5 toke… Remove one DNS host record from a managed domain by host_id. Preserves all other records. Get host_id from domains.get_dns_hosts. The domain must use Namecheap DNS. Cost = 5 tokens.
domains.renew
yearsdomain*expected_token_cost*
Renew a domain already managed through this Vee3 account. The user or agent passes expected_token_cost from domains.renewal_quote. Charges the quoted token cost on success. Premiu… Renew a domain already managed through this Vee3 account. The user or agent passes expected_token_cost from domains.renewal_quote. Charges the quoted token cost on success. Premium domains can only be renewed for 1 year at a time. Cost = 100 tokens + domain renewal price in tokens.
domains.renewal_quote
yearsdomain*
Quote renewal cost in tokens for one managed domain and year count. Only works for domains already managed by this Vee3 account. Quoted cost is 100 service tokens plus the domain… Quote renewal cost in tokens for one managed domain and year count. Only works for domains already managed by this Vee3 account. Quoted cost is 100 service tokens plus the domain renewal price in tokens. Token conversion depends on the account billing plan. Use before domains.renew. Premium domains can only be renewed for 1 year at a time. Cost = 5 tokens.
domains.tld_details
tld*
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, deleg… 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.
domains.whois
domain*include_registrar
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,… 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.
files.delete_file
file_name*
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 se… 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.
files.download_file
file_name*
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… 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.
files.extend_file
file_name*additional_retention_days*
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 sc… 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.
files.list_uploaded_files
folder
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. Us… 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.
files.move_file
source_file_name*destination_file_name*
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 a… 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.
files.upload_file
file_name*existing_filesretention_days
Reserve a direct upload slot for a local file or folder. Pass the desired file_name. For a single file, this becomes the stored name. For a folder, this becomes the destination fo… Reserve a direct upload slot for a local file or folder. Pass the desired file_name. For a single file, this becomes the stored name. For a folder, this becomes the destination folder prefix. To nest further, 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_or_folder_path}` in the terminal. The CLI accepts a file or a folder. A folder uploads every nested file in one command and stores each file under the reserved file_name prefix, preserving relative paths. The CLI resolves the code to signed upload URLs, streams the local file or files to Vee3 storage, and prints each stored file_name after the upload finishes. Use those file_name values in files.list_uploaded_files and other capabilities. The CLI does not need an API key. When a stored file already uses the same name, the upload stops, skips that file, or replaces it. 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. Each file can be up to 2 GB. One folder upload can include up to 500 files. Retention is chosen at reserve time (default 7 days) and applies to every file in the folder. After each upload is detected, Vee3 bills `max(1, ceil(size_gibibytes * retention_days * 2))` tokens per file. 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.
google-maps.languages
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 p… 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.
google-maps.nearby_search
cursorradiusregionkeywordsort_bylanguage
+5
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… 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.
google-maps.place_details
regionlanguageplace_id*
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… 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.
google-maps.place_photos
cursorregionlanguageplace_id*
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 lang… 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.
google-maps.place_reviews
cursorregionsort_bylanguageplace_id*
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, Lowe… 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.
google-maps.place_types
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_sea… 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.
google-maps.review_details
review_id*
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, rat… 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.
google-maps.search
query*cursorradiusregionlanguagelocation
+4
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 curso… 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.
google-search.autocomplete
query*
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 Search autocomplete suggestions for a partial query. Returns the normalized query and an array of suggested search phrases. Cost = 5 tokens.
google-search-console.add_site
site_url*
Add a domain as a Google Search Console property on Vee3's Search Console account. The user or agent can pass a domain, a domain property, or a URL. Vee3-managed domains are added… Add a domain as a Google Search Console property on Vee3's Search Console account. The user or agent can pass a domain, a domain property, or a URL. Vee3-managed domains are added and verified automatically. If the apex host uses URL forwarding, Vee3 writes a Google DNS CNAME record instead of a TXT record. If Google still needs time to verify, the response asks the agent to wait and retry this tool. If Vee3 cannot write DNS, the response includes dns_host_name, dns_record_type, and dns_token. Domains that are not managed by Vee3 return DNS TXT instructions so the user or agent can prove ownership, then retry this tool. After a site is added, call google-search-console.list_sites to see it, then use the other Search Console tools. Cost = 10 tokens.
google-search-console.delete_sitemap
site_urlfeed_path*
Remove a sitemap URL from Search Console for a verified property. Call google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact fe… Remove a sitemap URL from Search Console for a verified property. Call google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact feed_path. Omit site_url to use the default property. This only removes the sitemap from Search Console tracking; it does not delete the sitemap file from the website. Cost = 10 tokens.
google-search-console.get_site
site_url
Get one Search Console property for this account. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url fro… Get one Search Console property for this account. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response, including unverified properties. Returns the property URL and permission level. Cost = 5 tokens.
google-search-console.get_sitemap
site_urlfeed_path*
Get details for one sitemap submitted to Search Console. Call google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact feed_path w… Get details for one sitemap submitted to Search Console. Call google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact feed_path when available. Omit site_url to use the default property. Returns submission status, download time, warnings, errors, and content counts. Cost = 5 tokens.
google-search-console.inspect_url
site_urllanguage_codeinspection_url*
Inspect indexing status for a single URL in Search Console. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact si… Inspect indexing status for a single URL in Search Console. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns indexing verdict, coverage state, crawl details, and canonical information for the inspected URL. URL Inspection has limited daily quota. Each call inspects one URL. Cost = 15 tokens.
google-search-console.list_sitemaps
site_urlsitemap_index
List sitemaps submitted for a Search Console property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_ur… List sitemaps submitted for a Search Console property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns sitemap paths plus submission, download, warning, and error details. Use an exact path from this response with get_sitemap, submit_sitemap, or delete_sitemap. Cost = 5 tokens.
google-search-console.list_sites
List Search Console properties for this account. Returns Vee3-managed domains plus sites added with google-search-console.add_site. Call this to discover sites, then omit site_url… List Search Console properties for this account. Returns Vee3-managed domains plus sites added with google-search-console.add_site. Call this to discover sites, then omit site_url on later calls to use the default property, or pass an exact site_url from this response. If no properties appear, add a site with google-search-console.add_site or register a domain with domains.register. Cost = 5 tokens.
google-search-console.query_search_analytics
end_date*site_urlrow_limitstart_rowdata_statedimensions
+3
Query Search Console search analytics for a verified property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact… Query Search Console search analytics for a verified property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns performance rows with clicks, impressions, CTR, and average position, grouped by the requested dimensions. Daily search analytics typically lag by two to three days. For the Search Console last-24-hours hourly view, group by hour; those rows can include partial hours and cover up to ten days. Cost = 20 tokens.
google-search-console.submit_sitemap
site_urlfeed_path*
Submit a sitemap URL to Search Console for a verified property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exac… Submit a sitemap URL to Search Console for a verified property. Call google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. feed_path must be the full sitemap URL hosted on that property. Cost = 10 tokens.
google-search.keyword_traffic_insights
modeintentkeyword*language*locationmin_search_volume
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, co… 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.
google-search.languages
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 langua… 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.
google-search.locations
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… 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.
google-search.url_traffic_insights
url*intentlanguage*locationmin_search_volume
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… 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.
google-trends.categories
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 categor… 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.
google-trends.interest_by_region
endgpropstart*regioncountrycategory
+2
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… 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.
google-trends.interest_over_time
endgpropstart*regioncountrycategory
+1
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… 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.
google-trends.regions
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… 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.
google-trends.related_queries
endgpropstart*regioncountrycategory
+1
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 ha… 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.
google-trends.suggestions
keyword*
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 exampl… 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.
meta-tools.describe
tool_name*
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-tool… 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.
meta-tools.list_all
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… 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.
meta-tools.list_groups
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 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.
meta-tools.list_group_tools
group_id*
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… 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.
meta-tools.report_bug
summary*description*error_detailsrelated_capability_id
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. Incl… 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.
meta-tools.request_feature
summary*use_casedescription*related_capability_id
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, workf… 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.
meta-tools.search
limitquery*group_id
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… 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.
meta-tools.token_balance
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_per… 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.
pages.create
nameslug*
Create a new static website for this Vee3 account. Returns a page id and public URL at {slug}.vee3.site. Deploy uploaded files next with pages.deploy. Cost = 200 tokens. Create a new static website for this Vee3 account. Returns a page id and public URL at {slug}.vee3.site. Deploy uploaded files next with pages.deploy. Cost = 200 tokens.
pages.delete
page_id*
Delete a hosted static website and its CDN resources. Removes the page from this Vee3 account after deleting upstream resources. Cost = 5 tokens. Delete a hosted static website and its CDN resources. Removes the page from this Vee3 account after deleting upstream resources. Cost = 5 tokens.
pages.deploy
files*page_id*
Deploy uploaded account files to a hosted static website. Pass file_name values from files.upload_file / files.list_uploaded_files. Optional path overrides the destination path on… Deploy uploaded account files to a hosted static website. Pass file_name values from files.upload_file / files.list_uploaded_files. Optional path overrides the destination path on the page (defaults to the file basename). Up to 500 files per deploy. Cost = 100 tokens.
pages.edit
nameslugpage_id*
Update a hosted static website for this Vee3 account. Change the display name and/or the public slug. Changing the slug moves the preview hostname to {slug}.vee3.site and issues a… Update a hosted static website for this Vee3 account. Change the display name and/or the public slug. Changing the slug moves the preview hostname to {slug}.vee3.site and issues a new TLS certificate. An attached custom domain stays in place. Pass at least one of name or slug. Cost = 20 tokens.
pages.get
page_id*
Get details for one static website this Vee3 account hosts. Returns name, status, public URL, preview hostname on vee3.site, attached custom domain if any, and timestamps. Cost =… Get details for one static website this Vee3 account hosts. Returns name, status, public URL, preview hostname on vee3.site, attached custom domain if any, and timestamps. Cost = 5 tokens.
pages.list
pagelimit
List static websites this Vee3 account hosts. Returns page ids, names, slugs, status, public URLs, preview hostnames on vee3.site, attached custom domains if any, and paging metad… List static websites this Vee3 account hosts. Returns page ids, names, slugs, status, public URLs, preview hostnames on vee3.site, attached custom domains if any, and paging metadata. Cost = 10 tokens.
pages.remove_custom_domain
page_id*
Detach the custom hostname from a hosted static website. Removes the custom-domain DNS record and CDN hostname. The page stays online at the preview hostname on vee3.site. Cost =… Detach the custom hostname from a hosted static website. Removes the custom-domain DNS record and CDN hostname. The page stays online at the preview hostname on vee3.site. Cost = 5 tokens.
pages.set_custom_domain
page_id*custom_domain*
Attach a custom hostname to a hosted static website. The hostname must be on a domain this Vee3 account already manages. Vee3 writes DNS and attaches the hostname to the page CDN… Attach a custom hostname to a hosted static website. The hostname must be on a domain this Vee3 account already manages. Vee3 writes DNS and attaches the hostname to the page CDN with TLS. Subdomains use CNAME; the domain apex uses ALIAS. The preview hostname on vee3.site stays available. Setting a new custom domain replaces the previous one. If HTTPS is not ready yet, call this tool again after DNS is live; Vee3 retries TLS issuance. Cost = 50 tokens.
pages.statistics
date_topage_id*date_from
Get CDN traffic for one static website this Vee3 account hosts. Returns request count, bandwidth, cache hit rate, and bandwidth by country for a UTC date range. Request count incl… Get CDN traffic for one static website this Vee3 account hosts. Returns request count, bandwidth, cache hit rate, and bandwidth by country for a UTC date range. Request count includes every file the CDN served, not unique visitors. The range is inclusive. When the user or agent omits dates, the last 7 UTC days including today are used. The range can be at most 31 days. Cost = 10 tokens.
rotten-tomatoes.celebrity_details
celebrity_slug*
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 s… 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.
rotten-tomatoes.movie_cast_and_crew
movie_slug*
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 availa… 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.
rotten-tomatoes.movie_details
movie_slug*
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 P… 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.
rotten-tomatoes.movie_reviews
limitcursormovie_slug*review_type
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 pa… 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.
rotten-tomatoes.search
limitquery*
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.… 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 = 13 tokens.
rotten-tomatoes.tv_show_cast_and_crew
tv_show_slug*
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.… 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.
rotten-tomatoes.tv_show_details
tv_show_slug*
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, Tomat… 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.
rotten-tomatoes.tv_show_episode
tv_show_slug*season_number*episode_number*
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… 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.
rotten-tomatoes.tv_show_season
tv_show_slug*season_number*
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 av… 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.
rotten-tomatoes.tv_show_season_reviews
limitcursorreview_typetv_show_slug*season_number*
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 paginatio… 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.
seo.backlinks
url*include_subdomains
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 backlink… 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.
seo.basic_metrics
url*
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 stren… 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.
seo.country_codes
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. 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.
seo.keyword_metrics
countrykeyword*
Get SEO metrics for a search keyword in a specific country market. Returns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential. Cost = 10 tok… Get SEO metrics for a search keyword in a specific country market. Returns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential. Cost = 10 tokens.
seo.url_metrics
url*
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… 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.
tiktok.comment_replies
countcursorvideo_id*comment_id*
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. 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.
tiktok.download_music
music_idfile_namemusic_url
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 i… 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.
tiktok.download_music_from_video
video_idfile_namevideo_url
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 respo… 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.
tiktok.download_video
qualityvideo_idfile_namevideo_url
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 include… 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.
tiktok.for_you_feed
countregion*
Fetch for-you feed videos for a region. Requires region. Cost = 4 tokens. Fetch for-you feed videos for a region. Requires region. Cost = 4 tokens.
tiktok.music_details
music_idmusic_url
Look up metadata for a TikTok music track. Provide either music_id or music_url, not both. Cost = 2 tokens. Look up metadata for a TikTok music track. Provide either music_id or music_url, not both. Cost = 2 tokens.
tiktok.music_videos
countcursormusic_id*
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. 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.
tiktok.search_photos
countquery*cursorregion
Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens. Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.
tiktok.search_users
countquery*cursorfollower_count
Search TikTok users 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.
tiktok.search_videos
countquery*cursorregionsort_bypublish_time
Search TikTok videos 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.
tiktok.user_followers
countcursoruser_id*
List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens. List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens.
tiktok.user_following
countcursoruser_id*
List accounts a TikTok user follows. 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.
tiktok.user_info
user_idunique_id
Look up a TikTok user profile. Provide either user_id or unique_id, not both. Cost = 2 tokens. Look up a TikTok user profile. Provide either user_id or unique_id, not both. Cost = 2 tokens.
tiktok.user_reposts
countcursoruser_idunique_id
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 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.
tiktok.user_videos
countcursorlatestuser_idunique_id
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… 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.
tiktok.video_comments
countcursorvideo_idvideo_url
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. 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.
tiktok.video_details
video_idvideo_url
Look up metadata for a TikTok video. Provide either video_id or video_url, not both. Cost = 1 token. Look up metadata for a TikTok video. Provide either video_id or video_url, not both. Cost = 1 token.
website-screenshots.capture
url*formatqualitydark_modefile_namefull_page
+6
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… 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.
x-twitter.connected_accounts
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… 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.
x-twitter.create_bookmark
post_id*user_iduser_name
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… 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.
x-twitter.create_post
polltextmediauser_idcard_urinullcast
+8
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… 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.
x-twitter.delete_bookmark
post_id*user_iduser_name
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 defaul… 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.
x-twitter.delete_post
post_id*user_iduser_name
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… 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.
x-twitter.edit_post
textmediapost_id*user_iduser_namemade_with_ai
+1
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 acc… 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.
x-twitter.get_bookmarks
limitcursoruser_iduser_name
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… 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.
x-twitter.reply_to_post
polltextmediauser_idcard_urinullcast
+11
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 accoun… 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.
x-twitter.repost_post
post_id*user_iduser_name
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.… 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.
x-twitter.search
query*cursorsearch_type
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 c… 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.
x-twitter.tweet_info
id*
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, convers… 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.
x-twitter.tweet_replies
id*cursor
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-t… 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.
x-twitter.unrepost_post
post_id*user_iduser_name
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… 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.
x-twitter.user_info
rest_iduser_name
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 p… 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.
x-twitter.user_timeline
cursorrest_iduser_name
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_… 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.
youtube.channel_details
channel_id*
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://w… 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.
youtube.channel_search
query*cursorchannel_id*
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 cur… 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.
youtube.channel_videos
cursorchannel_id*
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 e… 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.
youtube.playlist_details
playlist_id*
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.… 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.
youtube.search
query*cursorsort_bydurationfeatureslanguage
+3
Search public YouTube content by keyword or phrase. Returns matching result cards, estimated result count, and spelling suggestions. Use filter parameters to apply multiple YouTu… 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.
youtube.search_autocomplete
query*languagelocation
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 locali… 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.
youtube.video_comments
cursorsort_byvideo_id*
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,… 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.
youtube.video_details
video_id*