Servidor MCP

Vee3

io.github.Vee3io/vee3
Herramientas para desarrolladores Seguridad Público y accesible MCP 2025-11-25

Qué hace este MCP

Manages Clerk authentication infrastructure, including users, organizations, domains, sessions, tokens, OAuth, SSO, machines, permissions, and webhooks.

clerk.add_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'add_clerk_domainArguments', 'required': ['name', 'is_satellite'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Domain hostname to add.'}, 'proxy_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Proxy Url', 'default': None, 'description': 'Proxy URL when using a satellite domain behind a reverse proxy.'}, 'is_satellite': {'type': 'boolean', 'title': 'Is Satellite', 'description': 'Whether this is a satellite domain.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'AddClerkDomainResponseDomain': {'type': 'object', 'title': 'AddClerkDomainResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk domain id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain hostname.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the domain.'}, 'proxy_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Proxy Url', 'default': None, 'description': 'Proxy URL when using a satellite domain behind a reverse proxy.'}, 'is_satellite': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Satellite', 'default': None, 'description': 'Whether this is a satellite domain.'}, 'cname_targets': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/AddClerkDomainResponseDomainCnameTargetsItem'}}, {'type': 'null'}], 'title': 'Cname Targets', 'default': None, 'description': 'CNAME records required to verify the domain.'}, 'frontend_api_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Frontend Api Url', 'default': None, 'description': 'Frontend API URL for the domain.'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin associated with the domain.'}, 'accounts_portal_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Accounts Portal Url', 'default': None, 'description': 'Accounts portal URL for the domain.'}}, 'additionalProperties': True}, 'AddClerkDomainResponseDomainCnameTargetsItem': {'type': 'object', 'title': 'AddClerkDomainResponseDomainCnameTargetsItem', 'properties': {'host': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host', 'default': None, 'description': 'DNS host label for the CNAME record.'}, 'value': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Value', 'default': None, 'description': 'DNS target value for the CNAME record.'}, 'required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Required', 'default': None, 'description': 'Whether this CNAME record is required for domain verification.'}}, 'additionalProperties': True}}, 'title': 'AddClerkDomainResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/AddClerkDomainResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk domain from the Backend API.'}}, 'additionalProperties': True}
clerk.ban_users
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.
Esquema de entrada
{'type': 'object', 'title': 'ban_clerk_usersArguments', 'required': ['user_ids'], 'properties': {'user_ids': {'type': 'array', 'items': {'type': 'string'}, 'title': 'User Ids', 'description': 'List of one or more Clerk user ids (user_...) to ban.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'BanClerkUsersResponseUsersItem': {'type': 'object', 'title': 'BanClerkUsersResponseUsersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'BanClerkUsersResponse', 'properties': {'users': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/BanClerkUsersResponseUsersItem'}}, {'type': 'null'}], 'title': 'Users', 'default': None, 'description': 'Updated user summaries for all banned users.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Number of users that were banned.'}}, 'additionalProperties': True}
clerk.change_instance_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'change_clerk_instance_domainArguments', 'required': ['home_url'], 'properties': {'home_url': {'type': 'string', 'title': 'Home Url', 'description': 'New home URL for the instance domain.'}, 'is_secondary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Secondary', 'default': None, 'description': 'When true, change the secondary domain instead of the primary.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'ChangeClerkInstanceDomainResponse', 'properties': {'accepted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Accepted', 'default': None, 'description': 'Whether Clerk accepted the domain change request.'}}, 'additionalProperties': True}
clerk.count_users
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.
Esquema de entrada
{'type': 'object', 'title': 'count_clerk_usersArguments', 'properties': {'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Optional filter query forwarded to Clerk (email, phone, username, or external id).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'CountClerkUsersResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of users in the Clerk application.'}}, 'additionalProperties': True}
clerk.create_actor_token
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_actor_tokenArguments', 'required': ['user_id', 'actor_sub'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) of the user being impersonated.'}, 'actor_sub': {'type': 'string', 'title': 'Actor Sub', 'description': 'Clerk user id (user_...) of the impersonating actor (maps to actor.sub).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'expires_in_seconds': {'anyOf': [{'type': 'integer', 'minimum': 1}, {'type': 'null'}], 'title': 'Expires In Seconds', 'default': None, 'description': 'Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour).'}, 'session_max_duration_in_seconds': {'anyOf': [{'type': 'integer', 'minimum': 1}, {'type': 'null'}], 'title': 'Session Max Duration In Seconds', 'default': None, 'description': 'Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes).'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkActorTokenResponseActorToken': {'type': 'object', 'title': 'CreateClerkActorTokenResponseActorToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Actor token id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Optional sign-in URL that includes the actor token.'}, 'actor': {'anyOf': [{'$ref': '#/$defs/CreateClerkActorTokenResponseActorTokenActor'}, {'type': 'null'}], 'default': None, 'description': 'Actor payload; includes sub with the impersonating user id.'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Actor token secret. Treat as high-privilege — do not log.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Token status (pending, accepted, or revoked).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) being impersonated.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}, 'CreateClerkActorTokenResponseActorTokenActor': {'type': 'object', 'title': 'CreateClerkActorTokenResponseActorTokenActor', 'properties': {'sub': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sub', 'default': None, 'description': 'Clerk user id (user_...) of the impersonating actor.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkActorTokenResponse', 'properties': {'actor_token': {'anyOf': [{'$ref': '#/$defs/CreateClerkActorTokenResponseActorToken'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk actor token object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_admin_portal_link_token
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_admin_portal_link_tokenArguments', 'properties': {'scopes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Optional scopes for the link (for example "admin_portal:read").'}, 'it_contact_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'It Contact Id', 'default': None, 'description': 'Optional opaque IT contact reference for the link.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Optional organization id (org_...) to scope the admin portal link.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'seconds_until_expiration': {'anyOf': [{'type': 'integer', 'maximum': 86400, 'minimum': 1}, {'type': 'null'}], 'title': 'Seconds Until Expiration', 'default': None, 'description': 'Link token lifetime in seconds (default 3600, max 86400).'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken': {'type': 'object', 'title': 'CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Admin portal link token id (aplt_...).'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Whether the link token has expired.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the link token has been revoked.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the link token was created.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the link token expires.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...).'}, 'admin_portal_link_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Admin Portal Link Id', 'default': None, 'description': 'Origin admin portal link id (apl_...).'}}, 'additionalProperties': True}}, 'title': 'CreateClerkAdminPortalLinkTokenResponse', 'properties': {'admin_portal_link_token': {'anyOf': [{'$ref': '#/$defs/CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken'}, {'type': 'null'}], 'default': None, 'description': 'Created admin portal link token from the Backend API.'}}, 'additionalProperties': True}
clerk.create_allowlist_identifier
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_allowlist_identifierArguments', 'required': ['identifier'], 'properties': {'notify': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Notify', 'default': None, 'description': 'When true, notify the user by email or SMS that they were added to the allowlist.'}, 'identifier': {'type': 'string', 'title': 'Identifier', 'description': 'Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkAllowlistIdentifierResponseIdentifier': {'type': 'object', 'title': 'CreateClerkAllowlistIdentifierResponseIdentifier', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Allowlist identifier id (alid_...).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'identifier': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier', 'default': None, 'description': 'Allowlisted email, phone, domain pattern, or Web3 wallet address.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'invitation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Invitation Id', 'default': None, 'description': 'Clerk invitation id (inv_...) when the entry was created from an invitation.'}, 'identifier_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier Type', 'default': None, 'description': 'Type of identifier: "email_address", "phone_number", or "web3_wallet".'}}, 'additionalProperties': True}}, 'title': 'CreateClerkAllowlistIdentifierResponse', 'properties': {'identifier': {'anyOf': [{'$ref': '#/$defs/CreateClerkAllowlistIdentifierResponseIdentifier'}, {'type': 'null'}], 'default': None, 'description': 'Created allowlist identifier object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_api_key
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_api_keyArguments', 'required': ['name', 'subject'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Human-readable name for the new API key.'}, 'claims': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Claims', 'default': None, 'description': 'Custom claims to embed in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes to grant the API key.'}, 'subject': {'type': 'string', 'title': 'Subject', 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id to record as the creator of this API key.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'seconds_until_expiration': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Seconds Until Expiration', 'default': None, 'description': 'Seconds from creation until the API key expires.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkApiKeyResponseApiKey': {'type': 'object', 'title': 'CreateClerkApiKeyResponseApiKey', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk API key id (ak_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Human-readable API key name.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/CreateClerkApiKeyResponseApiKeyClaims'}, {'type': 'null'}], 'default': None, 'description': 'Custom claims embedded in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkApiKeyResponseApiKeyScopesItem'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes granted to this API key.'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the API key has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was created.'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id that created the API key, when set.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key expires, if set.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Reason recorded when the API key was revoked.'}}, 'additionalProperties': True}, 'CreateClerkApiKeyResponseApiKeyClaims': {'type': 'object', 'title': 'CreateClerkApiKeyResponseApiKeyClaims', 'properties': {'claim_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Claim Key', 'default': None, 'description': 'A key in the custom claims object.'}}, 'additionalProperties': True}, 'CreateClerkApiKeyResponseApiKeyScopesItem': {'type': 'object', 'title': 'CreateClerkApiKeyResponseApiKeyScopesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'A single scope string.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkApiKeyResponse', 'properties': {'api_key': {'anyOf': [{'$ref': '#/$defs/CreateClerkApiKeyResponseApiKey'}, {'type': 'null'}], 'default': None, 'description': 'Newly created Clerk API key from the Backend API.'}}, 'additionalProperties': True}
clerk.create_blocklist_identifier
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_blocklist_identifierArguments', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'title': 'Identifier', 'description': 'Identifier to block: email, domain, E.164 phone (+15555555555), or Web3 wallet address.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkBlocklistIdentifierResponseIdentifier': {'type': 'object', 'title': 'CreateClerkBlocklistIdentifierResponseIdentifier', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Blocklist identifier id (blid_...).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'identifier': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier', 'default': None, 'description': 'Blocklisted email, domain, phone, or Web3 wallet address.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'identifier_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier Type', 'default': None, 'description': 'Type of identifier: "email_address", "phone_number", or "web3_wallet".'}}, 'additionalProperties': True}}, 'title': 'CreateClerkBlocklistIdentifierResponse', 'properties': {'identifier': {'anyOf': [{'$ref': '#/$defs/CreateClerkBlocklistIdentifierResponseIdentifier'}, {'type': 'null'}], 'default': None, 'description': 'Created blocklist identifier object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_email_address
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_email_addressArguments', 'required': ['user_id', 'email_address'], 'properties': {'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "When true, set this email as the user's primary email address."}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to retrieve or modify.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'When true, the email address is created as verified.'}, 'email_address': {'type': 'string', 'title': 'Email Address', 'description': 'Email address to create for the user.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkEmailAddressResponseEmailAddress': {'type': 'object', 'title': 'CreateClerkEmailAddressResponseEmailAddress', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk email address id (idn_...).'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this is the user's primary email address."}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this email address.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the email address is verified.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address value.'}, 'verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verification Status', 'default': None, 'description': 'Verification status (e.g. verified, unverified, failed).'}}, 'additionalProperties': True}}, 'title': 'CreateClerkEmailAddressResponse', 'properties': {'email_address': {'anyOf': [{'$ref': '#/$defs/CreateClerkEmailAddressResponseEmailAddress'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk email address summary.'}}, 'additionalProperties': True}
clerk.create_enterprise_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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_enterprise_connectionArguments', 'required': ['name', 'provider', 'domains'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Display name for the enterprise connection.'}, 'oidc': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Oidc', 'default': None, 'description': 'OIDC client configuration when provider uses OAuth.'}, 'saml': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Saml', 'default': None, 'description': 'SAML IdP configuration when provider uses SAML.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Domains', 'description': 'Email domains that may use this connection.'}, 'provider': {'type': 'string', 'title': 'Provider', 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) to link to this connection.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether to sync user attributes on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is allowed.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether to block additional identifications for this connection.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkEnterpriseConnectionResponseEnterpriseConnection': {'type': 'object', 'title': 'CreateClerkEnterpriseConnectionResponseEnterpriseConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the connection.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Email domains that may use this connection.'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was last updated.'}, 'oauth_config': {'anyOf': [{'$ref': '#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig'}, {'type': 'null'}], 'default': None, 'description': 'OIDC configuration when the connection uses OAuth.'}, 'logo_public_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Logo Public Url', 'default': None, 'description': 'Public logo URL for the connection when available.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Linked Clerk organization id (org_...) when the connection is org-scoped.'}, 'saml_connection': {'anyOf': [{'$ref': '#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection'}, {'type': 'null'}], 'default': None, 'description': 'SAML configuration when the connection uses SAML.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem'}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether user attributes sync on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is supported.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether users may add additional identifications with this connection.'}}, 'additionalProperties': True}, 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig': {'type': 'object', 'title': 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth config id when the connection uses OIDC.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Custom OIDC provider display name.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id.'}, 'provider_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider Key', 'default': None, 'description': 'OAuth provider key (for example oidc_custom).'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OIDC discovery URL.'}, 'requires_pkce': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Requires Pkce', 'default': None, 'description': 'Whether PKCE is required for this OAuth client.'}}, 'additionalProperties': True}, 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection': {'type': 'object', 'title': 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'SAML connection id when the connection uses SAML.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'SAML connection display name.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the SAML connection is active.'}, 'acs_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Acs Url', 'default': None, 'description': 'Assertion Consumer Service URL.'}, 'idp_sso_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Sso Url', 'default': None, 'description': 'Identity Provider Single Sign-On URL.'}, 'sp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sp Entity Id', 'default': None, 'description': 'Service Provider entity id (Clerk).'}, 'idp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Entity Id', 'default': None, 'description': 'Identity Provider entity id.'}, 'allow_subdomains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Subdomains', 'default': None, 'description': 'Whether email subdomains may use this connection.'}, 'allow_idp_initiated': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Idp Initiated', 'default': None, 'description': 'Whether IdP-initiated SSO is allowed.'}}, 'additionalProperties': True}, 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem': {'type': 'object', 'title': 'CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem', 'properties': {'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Metadata key used to store the attribute on the user.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the custom attribute.'}, 'sso_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sso Path', 'default': None, 'description': 'Path to extract the value from SSO claims.'}, 'scim_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scim Path', 'default': None, 'description': 'GJSON path to extract the value from SCIM resources.'}, 'multi_valued': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Multi Valued', 'default': None, 'description': 'Whether the attribute supports multiple values.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkEnterpriseConnectionResponse', 'properties': {'enterprise_connection': {'anyOf': [{'$ref': '#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnection'}, {'type': 'null'}], 'default': None, 'description': 'Newly created enterprise SSO connection.'}}, 'additionalProperties': True}
clerk.create_enterprise_connection_test_run
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_enterprise_connection_test_runArguments', 'required': ['connection_id'], 'properties': {'connection_id': {'type': 'string', 'title': 'Connection Id', 'description': 'Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'CreateClerkEnterpriseConnectionTestRunResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Short-lived URL to start the enterprise SSO test flow.'}}, 'additionalProperties': True}
clerk.create_invitations
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_invitationsArguments', 'required': ['invitations'], 'properties': {'invitations': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}, 'title': 'Invitations', 'description': 'One or more invitation objects. Each item requires email_address (string). Optional fields per item: role (string), redirect_url (string), public_metadata (object).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkInvitationsResponseInvitationsItem': {'type': 'object', 'title': 'CreateClerkInvitationsResponseInvitationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk invitation id (inv_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: "pending", "accepted", "revoked", or "expired".'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the invitation has been revoked.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the invitation was created.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkInvitationsResponse', 'properties': {'invitations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkInvitationsResponseInvitationsItem'}}, {'type': 'null'}], 'title': 'Invitations', 'default': None, 'description': 'Created Clerk invitation summaries.'}}, 'additionalProperties': True}
clerk.create_jwt_template
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_jwt_templateArguments', 'required': ['name', 'claims'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Unique JWT template name.'}, 'claims': {'type': 'object', 'title': 'Claims', 'description': 'JWT claims template as a JSON object.', 'additionalProperties': True}, 'lifetime': {'anyOf': [{'type': 'integer', 'maximum': 315360000, 'minimum': 30}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Token lifetime in seconds (30–315360000).'}, 'signing_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Key', 'default': None, 'description': 'Custom signing private key (required when custom_signing_key is true).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Custom signing algorithm (required when custom_signing_key is true).'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer', 'maximum': 300, 'minimum': 0}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Allowed clock skew in seconds (0–300).'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Whether to use a custom signing key and algorithm.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkJwtTemplateResponseJwtTemplate': {'type': 'object', 'title': 'CreateClerkJwtTemplateResponseJwtTemplate', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk JWT template id (jtmp_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Unique template name used when minting tokens from this template.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/CreateClerkJwtTemplateResponseJwtTemplateClaims'}, {'type': 'null'}], 'default': None, 'description': 'JWT claims template as a JSON object (may include Clerk shortcodes).'}, 'lifetime': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Token lifetime in seconds (exp claim offset from issuance time).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was last updated.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Custom signing algorithm when custom_signing_key is enabled.'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Allowed clock skew in seconds for the nbf claim.'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Whether this template uses a custom signing key and algorithm.'}}, 'additionalProperties': True}, 'CreateClerkJwtTemplateResponseJwtTemplateClaims': {'type': 'object', 'title': 'CreateClerkJwtTemplateResponseJwtTemplateClaims', 'properties': {'aud': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Aud', 'default': None, 'description': 'Audience claim when set in the template.'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role claim when set in the template.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkJwtTemplateResponse', 'properties': {'jwt_template': {'anyOf': [{'$ref': '#/$defs/CreateClerkJwtTemplateResponseJwtTemplate'}, {'type': 'null'}], 'default': None, 'description': 'Newly created Clerk JWT template summary.'}}, 'additionalProperties': True}
clerk.create_m2m_token
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_m2m_tokenArguments', 'required': ['machine_secret_key'], 'properties': {'claims': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Claims', 'default': None, 'description': 'Optional custom claims embedded in the token.'}, 'token_format': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Format', 'default': None, 'description': 'Token format: "opaque" (default) or "jwt".'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'machine_secret_key': {'type': 'string', 'title': 'Machine Secret Key', 'description': 'Machine secret key (msk_...) used to authenticate the create request.'}, 'seconds_until_expiration': {'anyOf': [{'type': 'number', 'minimum': 0}, {'type': 'null'}], 'title': 'Seconds Until Expiration', 'default': None, 'description': 'Token lifetime in seconds.'}, 'min_remaining_ttl_seconds': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Min Remaining Ttl Seconds', 'default': None, 'description': 'For opaque tokens, reuse an existing token with at least this TTL remaining.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkM2mTokenResponseM2mToken': {'type': 'object', 'title': 'CreateClerkM2mTokenResponseM2mToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'M2M token id (mt_...).'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'M2M token secret when returned on creation. Treat as high-privilege — do not log.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Whether the token has expired.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the token has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Machine id (mch_...) that created or owns the token.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the token expires.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkM2mTokenResponse', 'properties': {'m2m_token': {'anyOf': [{'$ref': '#/$defs/CreateClerkM2mTokenResponseM2mToken'}, {'type': 'null'}], 'default': None, 'description': 'Created M2M token from the Backend API.'}}, 'additionalProperties': True}
clerk.create_machine
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_machineArguments', 'required': ['name'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Machine display name (1–255 characters).'}, 'scoped_machines': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Scoped Machines', 'default': None, 'description': 'Machine ids (mch_...) this machine may access (max 150).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer', 'maximum': 315360000, 'minimum': 1}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Default M2M token lifetime in seconds (minimum 1).'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkMachineResponseMachine': {'type': 'object', 'title': 'CreateClerkMachineResponseMachine', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Machine id (mch_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Machine display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was created.'}, 'secret_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret Key', 'default': None, 'description': 'Machine secret key returned on create. Treat as high-privilege — do not log.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns the machine.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Default token lifetime in seconds for tokens created by this machine.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkMachineResponse', 'properties': {'machine': {'anyOf': [{'$ref': '#/$defs/CreateClerkMachineResponseMachine'}, {'type': 'null'}], 'default': None, 'description': 'Created machine object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_machine_scope
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_machine_scopeArguments', 'required': ['machine_id', 'to_machine_id'], 'properties': {'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'to_machine_id': {'type': 'string', 'title': 'To Machine Id', 'description': 'Target machine id (mch_...) to grant access to.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkMachineScopeResponseMachineScope': {'type': 'object', 'title': 'CreateClerkMachineScopeResponseMachineScope', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type (machine_scope).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the scope was created.'}, 'to_machine_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'To Machine Id', 'default': None, 'description': 'Machine id that can be accessed.'}, 'from_machine_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'From Machine Id', 'default': None, 'description': 'Machine id that was granted access.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkMachineScopeResponse', 'properties': {'machine_scope': {'anyOf': [{'$ref': '#/$defs/CreateClerkMachineScopeResponseMachineScope'}, {'type': 'null'}], 'default': None, 'description': 'Created machine scope from the Backend API.'}}, 'additionalProperties': True}
clerk.create_oauth_application
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_oauth_applicationArguments', 'required': ['name'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Display name for the new OAuth application.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (no client secret; PKCE-capable).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes (e.g. profile email public_metadata).'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether to show the OAuth consent screen during authorization.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOauthApplicationResponseOauthApplication': {'type': 'object', 'title': 'CreateClerkOauthApplicationResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOauthApplicationResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/CreateClerkOauthApplicationResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'Newly created Clerk OAuth application summary.'}}, 'additionalProperties': True}
clerk.create_organization
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organizationArguments', 'required': ['name', 'created_by'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Optional URL-friendly slug for the organization.'}, 'created_by': {'type': 'string', 'title': 'Created By', 'description': 'Clerk user id (user_...) of the user creating the organization.'}, 'public_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Public Metadata', 'default': None, 'description': 'Optional public metadata as a JSON object.'}, 'private_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Private Metadata', 'default': None, 'description': 'Optional private metadata as a JSON object.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'max_allowed_memberships': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Memberships', 'default': None, 'description': 'Optional maximum number of memberships allowed.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationResponseOrganization': {'type': 'object', 'title': 'CreateClerkOrganizationResponseOrganization', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization id (org_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'URL-friendly organization slug, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the organization was created.'}, 'members_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Members Count', 'default': None, 'description': 'Current number of members in the organization.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationResponse', 'properties': {'organization': {'anyOf': [{'$ref': '#/$defs/CreateClerkOrganizationResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Newly created Clerk organization summary.'}}, 'additionalProperties': True}
clerk.create_organization_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organization_domainArguments', 'required': ['organization_id', 'name'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'description': 'Domain name to add (for example example.com).'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the domain is verified. Defaults to true when omitted.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationDomainResponseDomain': {'type': 'object', 'title': 'CreateClerkOrganizationDomainResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization domain id (dmn_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain name (for example example.com).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was last updated.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this domain.'}, 'affiliation_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Email Address', 'default': None, 'description': 'Affiliation email address for the domain, when set.'}, 'total_pending_invitations': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Invitations', 'default': None, 'description': 'Number of pending invitations associated with this domain.'}, 'total_pending_suggestions': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Suggestions', 'default': None, 'description': 'Number of pending membership suggestions associated with this domain.'}, 'ownership_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ownership Verification Status', 'default': None, 'description': 'DNS ownership verification status (unverified, verified, failed, or expired).'}, 'affiliation_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Verification Status', 'default': None, 'description': 'Affiliation verification status (unverified, verified, failed, or expired).'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationDomainResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/CreateClerkOrganizationDomainResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Created organization domain summary.'}}, 'additionalProperties': True}
clerk.create_organization_invitations
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organization_invitationsArguments', 'required': ['organization_id', 'invitations'], 'properties': {'invitations': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}, 'title': 'Invitations', 'description': 'One or more invitation objects. Each item requires email_address (string) and role (string, e.g. org:admin, org:member).'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationInvitationsResponseInvitationsItem': {'type': 'object', 'title': 'CreateClerkOrganizationInvitationsResponseInvitationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization invitation id (inv_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role assigned to the invitee (e.g. org:admin, org:member).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: pending, accepted, or revoked.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this invitation.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationInvitationsResponse', 'properties': {'invitations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkOrganizationInvitationsResponseInvitationsItem'}}, {'type': 'null'}], 'title': 'Invitations', 'default': None, 'description': 'Created invitation summaries.'}}, 'additionalProperties': True}
clerk.create_organization_membership
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organization_membershipArguments', 'required': ['organization_id', 'user_id', 'role'], 'properties': {'role': {'type': 'string', 'title': 'Role', 'description': 'Role to assign to the user in the organization (e.g. org:member, org:admin).'}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) of the user to add.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to add the member to.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationMembershipResponseMembership': {'type': 'object', 'title': 'CreateClerkOrganizationMembershipResponseMembership', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization membership id (orgmem_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role of the member in the organization (e.g. org:admin, org:member).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) of the member.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationMembershipResponse', 'properties': {'membership': {'anyOf': [{'$ref': '#/$defs/CreateClerkOrganizationMembershipResponseMembership'}, {'type': 'null'}], 'default': None, 'description': 'Created organization membership.'}}, 'additionalProperties': True}
clerk.create_organization_permission
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organization_permissionArguments', 'required': ['name', 'key'], 'properties': {'key': {'type': 'string', 'title': 'Key', 'description': 'Unique permission key.'}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Permission display name.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationPermissionResponseOrganizationPermission': {'type': 'object', 'title': 'CreateClerkOrganizationPermissionResponseOrganizationPermission', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationPermissionResponse', 'properties': {'organization_permission': {'anyOf': [{'$ref': '#/$defs/CreateClerkOrganizationPermissionResponseOrganizationPermission'}, {'type': 'null'}], 'default': None, 'description': 'Newly created organization permission summary.'}}, 'additionalProperties': True}
clerk.create_organization_role
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_organization_roleArguments', 'required': ['name', 'key'], 'properties': {'key': {'type': 'string', 'title': 'Key', 'description': 'Unique role key.'}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Role display name.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permission keys to assign to the new role.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'include_in_initial_role_set': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Include In Initial Role Set', 'default': None, 'description': 'Whether to include this role in the initial role set.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkOrganizationRoleResponseOrganizationRole': {'type': 'object', 'title': 'CreateClerkOrganizationRoleResponseOrganizationRole', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization role id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Role key used in memberships.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Role display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permissions assigned to this role.'}, 'is_creator_eligible': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Creator Eligible', 'default': None, 'description': 'Whether this role may be assigned as organization creator.'}}, 'additionalProperties': True}, 'CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem': {'type': 'object', 'title': 'CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkOrganizationRoleResponse', 'properties': {'organization_role': {'anyOf': [{'$ref': '#/$defs/CreateClerkOrganizationRoleResponseOrganizationRole'}, {'type': 'null'}], 'default': None, 'description': 'Newly created organization role summary.'}}, 'additionalProperties': True}
clerk.create_phone_number
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_phone_numberArguments', 'required': ['user_id', 'phone_number'], 'properties': {'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this should be the user's primary phone number."}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to retrieve or modify.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the phone number should be marked verified. Defaults to false.'}, 'phone_number': {'type': 'string', 'title': 'Phone Number', 'description': 'Phone number in E.164 format (e.g. +15551234567).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'reserved_for_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Reserved For Second Factor', 'default': None, 'description': 'Whether to reserve this number for multi-factor authentication.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkPhoneNumberResponsePhoneNumber': {'type': 'object', 'title': 'CreateClerkPhoneNumberResponsePhoneNumber', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk phone number id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the phone number is verified.'}, 'phone_number': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone Number', 'default': None, 'description': 'Phone number in E.164 format.'}, 'default_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Default Second Factor', 'default': None, 'description': "Whether this is the user's default second factor."}, 'reserved_for_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Reserved For Second Factor', 'default': None, 'description': 'Whether the phone number is reserved for multi-factor authentication.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkPhoneNumberResponse', 'properties': {'phone_number': {'anyOf': [{'$ref': '#/$defs/CreateClerkPhoneNumberResponsePhoneNumber'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk phone number object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_redirect_url
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_redirect_urlArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'description': 'Redirect URL to allow for sign-in and sign-up flows.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkRedirectUrlResponseRedirectUrl': {'type': 'object', 'title': 'CreateClerkRedirectUrlResponseRedirectUrl', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk redirect URL id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Allowed redirect URL value.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the redirect URL.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was last updated.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkRedirectUrlResponse', 'properties': {'redirect_url': {'anyOf': [{'$ref': '#/$defs/CreateClerkRedirectUrlResponseRedirectUrl'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk redirect URL from the Backend API.'}}, 'additionalProperties': True}
clerk.create_session
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_sessionArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to create a session for.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'CreateClerkSessionResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk session id (sess_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current status of the session.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this session.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'Clerk client id associated with this session.'}, 'expire_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expire At', 'default': None, 'description': 'Unix timestamp in milliseconds when this session expires.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was last updated.'}, 'last_active_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Last Active At', 'default': None, 'description': 'Unix timestamp in milliseconds of the last activity on this session.'}}, 'additionalProperties': True}
clerk.create_session_token
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_session_tokenArguments', 'required': ['session_id'], 'properties': {'session_id': {'type': 'string', 'title': 'Session Id', 'description': 'Clerk session id (sess_...) to retrieve or modify.'}, 'template_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Template Name', 'default': None, 'description': 'Optional JWT template name. When set, the session token is created from that template.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'CreateClerkSessionTokenResponse', 'properties': {'jwt': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Jwt', 'default': None, 'description': 'Signed JWT for the session. Treat as a secret — do not log.'}}, 'additionalProperties': True}
clerk.create_sign_in_token
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_sign_in_tokenArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'expires_in_seconds': {'anyOf': [{'type': 'integer', 'minimum': 1}, {'type': 'null'}], 'title': 'Expires In Seconds', 'default': None, 'description': 'Token lifetime in seconds (minimum 1). Defaults to 2592000 (30 days).'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkSignInTokenResponseSignInToken': {'type': 'object', 'title': 'CreateClerkSignInTokenResponseSignInToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Sign-in token id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Optional sign-in URL that includes the token.'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Sign-in token secret. Treat as high-privilege — do not log.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Token status (pending, accepted, or revoked).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) the token is for.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkSignInTokenResponse', 'properties': {'sign_in_token': {'anyOf': [{'$ref': '#/$defs/CreateClerkSignInTokenResponseSignInToken'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk sign-in token object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_svix_app
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_svix_appArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkSvixAppResponseSvix': {'type': 'object', 'title': 'CreateClerkSvixAppResponseSvix', 'properties': {'svix_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Svix Url', 'default': None, 'description': 'Temporary Svix URL. Treat as sensitive — do not log.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkSvixAppResponse', 'properties': {'svix': {'anyOf': [{'$ref': '#/$defs/CreateClerkSvixAppResponseSvix'}, {'type': 'null'}], 'default': None, 'description': 'Svix app response from the Clerk Backend API.'}}, 'additionalProperties': True}
clerk.create_svix_dashboard_url
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_svix_dashboard_urlArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkSvixDashboardUrlResponseSvix': {'type': 'object', 'title': 'CreateClerkSvixDashboardUrlResponseSvix', 'properties': {'svix_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Svix Url', 'default': None, 'description': 'Temporary Svix URL. Treat as sensitive — do not log.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkSvixDashboardUrlResponse', 'properties': {'svix': {'anyOf': [{'$ref': '#/$defs/CreateClerkSvixDashboardUrlResponseSvix'}, {'type': 'null'}], 'default': None, 'description': 'Temporary Svix dashboard URL from the Clerk Backend API.'}}, 'additionalProperties': True}
clerk.create_user
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_userArguments', 'required': ['email_address'], 'properties': {'password': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Password', 'default': None, 'description': 'Optional password. Omit to create a user without a password.'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'Optional last name.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'Optional first name.'}, 'email_address': {'type': 'string', 'title': 'Email Address', 'description': 'Primary email address for the new Clerk user.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkUserResponseUser': {'type': 'object', 'title': 'CreateClerkUserResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'email_addresses': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkUserResponseUserEmailAddressesItem'}}, {'type': 'null'}], 'title': 'Email Addresses', 'default': None, 'description': 'Email addresses associated with the user.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}, 'CreateClerkUserResponseUserEmailAddressesItem': {'type': 'object', 'title': 'CreateClerkUserResponseUserEmailAddressesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Email address identifier.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address value.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkUserResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/CreateClerkUserResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Created Clerk user object from the Backend API.'}}, 'additionalProperties': True}
clerk.create_waitlist_entries
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.
Esquema de entrada
{'type': 'object', 'title': 'create_clerk_waitlist_entriesArguments', 'required': ['waitlist_entries'], 'properties': {'waitlist_entries': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}, 'title': 'Waitlist Entries', 'description': 'One or more waitlist entry objects. Each item requires email_address (string). Optional fields per item: notify (boolean; whether to notify the user their email was added; defaults to true).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'CreateClerkWaitlistEntriesResponseWaitlistEntriesItem': {'type': 'object', 'title': 'CreateClerkWaitlistEntriesResponseWaitlistEntriesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Waitlist entry id (wle_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Waitlist status: "pending", "invited", "rejected", or "completed".'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether the entry is locked during batch processing.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address on the waitlist.'}}, 'additionalProperties': True}}, 'title': 'CreateClerkWaitlistEntriesResponse', 'properties': {'waitlist_entries': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/CreateClerkWaitlistEntriesResponseWaitlistEntriesItem'}}, {'type': 'null'}], 'title': 'Waitlist Entries', 'default': None, 'description': 'Created or existing Clerk waitlist entry summaries.'}}, 'additionalProperties': True}
clerk.delete_allowlist_identifier
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_allowlist_identifierArguments', 'required': ['identifier_id'], 'properties': {'identifier_id': {'type': 'string', 'title': 'Identifier Id', 'description': 'Allowlist or blocklist identifier id (alid_... or blid_...) to delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkAllowlistIdentifierResponseDeletedIdentifier': {'type': 'object', 'title': 'DeleteClerkAllowlistIdentifierResponseDeletedIdentifier', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted identifier id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the deleted resource.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the identifier was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkAllowlistIdentifierResponse', 'properties': {'deleted_identifier': {'anyOf': [{'$ref': '#/$defs/DeleteClerkAllowlistIdentifierResponseDeletedIdentifier'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deleted-object payload confirming removal.'}}, 'additionalProperties': True}
clerk.delete_api_key
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_api_keyArguments', 'required': ['api_key_id'], 'properties': {'api_key_id': {'type': 'string', 'title': 'Api Key Id', 'description': 'Clerk API key id (ak_...) to retrieve, update, delete, or revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkApiKeyResponseApiKey': {'type': 'object', 'title': 'DeleteClerkApiKeyResponseApiKey', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted API key id.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Always true when deletion succeeded.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkApiKeyResponse', 'properties': {'api_key': {'anyOf': [{'$ref': '#/$defs/DeleteClerkApiKeyResponseApiKey'}, {'type': 'null'}], 'default': None, 'description': 'Deletion confirmation with API key id and deleted flag.'}}, 'additionalProperties': True}
clerk.delete_blocklist_identifier
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_blocklist_identifierArguments', 'required': ['identifier_id'], 'properties': {'identifier_id': {'type': 'string', 'title': 'Identifier Id', 'description': 'Allowlist or blocklist identifier id (alid_... or blid_...) to delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkBlocklistIdentifierResponseDeletedIdentifier': {'type': 'object', 'title': 'DeleteClerkBlocklistIdentifierResponseDeletedIdentifier', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted identifier id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the deleted resource.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the identifier was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkBlocklistIdentifierResponse', 'properties': {'deleted_identifier': {'anyOf': [{'$ref': '#/$defs/DeleteClerkBlocklistIdentifierResponseDeletedIdentifier'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deleted-object payload confirming removal.'}}, 'additionalProperties': True}
clerk.delete_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_domainArguments', 'required': ['domain_id'], 'properties': {'domain_id': {'type': 'string', 'title': 'Domain Id', 'description': 'Clerk organization domain id (dmn_...) to update, delete, or verify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkDomainResponseDomain': {'type': 'object', 'title': 'DeleteClerkDomainResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted resource id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the deleted resource.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the resource was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkDomainResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/DeleteClerkDomainResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deleted-object payload confirming domain removal.'}}, 'additionalProperties': True}
clerk.delete_email_address
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_email_addressArguments', 'required': ['email_address_id'], 'properties': {'email_address_id': {'type': 'string', 'title': 'Email Address Id', 'description': 'Clerk email address id (idn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkEmailAddressResponseEmailAddress': {'type': 'object', 'title': 'DeleteClerkEmailAddressResponseEmailAddress', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk email address id (idn_...).'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this is the user's primary email address."}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this email address.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the email address is verified.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address value.'}, 'verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verification Status', 'default': None, 'description': 'Verification status (e.g. verified, unverified, failed).'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkEmailAddressResponse', 'properties': {'email_address': {'anyOf': [{'$ref': '#/$defs/DeleteClerkEmailAddressResponseEmailAddress'}, {'type': 'null'}], 'default': None, 'description': 'Deleted Clerk email address summary, when returned by Clerk.'}}, 'additionalProperties': True}
clerk.delete_enterprise_connection
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_enterprise_connectionArguments', 'required': ['connection_id'], 'properties': {'connection_id': {'type': 'string', 'title': 'Connection Id', 'description': 'Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkEnterpriseConnectionResponseEnterpriseConnection': {'type': 'object', 'title': 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the connection.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the connection was deleted.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Email domains that may use this connection.'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was last updated.'}, 'oauth_config': {'anyOf': [{'$ref': '#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig'}, {'type': 'null'}], 'default': None, 'description': 'OIDC configuration when the connection uses OAuth.'}, 'logo_public_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Logo Public Url', 'default': None, 'description': 'Public logo URL for the connection when available.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Linked Clerk organization id (org_...) when the connection is org-scoped.'}, 'saml_connection': {'anyOf': [{'$ref': '#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection'}, {'type': 'null'}], 'default': None, 'description': 'SAML configuration when the connection uses SAML.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem'}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether user attributes sync on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is supported.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether users may add additional identifications with this connection.'}}, 'additionalProperties': True}, 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig': {'type': 'object', 'title': 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth config id when the connection uses OIDC.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Custom OIDC provider display name.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id.'}, 'provider_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider Key', 'default': None, 'description': 'OAuth provider key (for example oidc_custom).'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OIDC discovery URL.'}, 'requires_pkce': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Requires Pkce', 'default': None, 'description': 'Whether PKCE is required for this OAuth client.'}}, 'additionalProperties': True}, 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection': {'type': 'object', 'title': 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'SAML connection id when the connection uses SAML.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'SAML connection display name.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the SAML connection is active.'}, 'acs_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Acs Url', 'default': None, 'description': 'Assertion Consumer Service URL.'}, 'idp_sso_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Sso Url', 'default': None, 'description': 'Identity Provider Single Sign-On URL.'}, 'sp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sp Entity Id', 'default': None, 'description': 'Service Provider entity id (Clerk).'}, 'idp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Entity Id', 'default': None, 'description': 'Identity Provider entity id.'}, 'allow_subdomains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Subdomains', 'default': None, 'description': 'Whether email subdomains may use this connection.'}, 'allow_idp_initiated': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Idp Initiated', 'default': None, 'description': 'Whether IdP-initiated SSO is allowed.'}}, 'additionalProperties': True}, 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem': {'type': 'object', 'title': 'DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem', 'properties': {'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Metadata key used to store the attribute on the user.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the custom attribute.'}, 'sso_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sso Path', 'default': None, 'description': 'Path to extract the value from SSO claims.'}, 'scim_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scim Path', 'default': None, 'description': 'GJSON path to extract the value from SCIM resources.'}, 'multi_valued': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Multi Valued', 'default': None, 'description': 'Whether the attribute supports multiple values.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkEnterpriseConnectionResponse', 'properties': {'enterprise_connection': {'anyOf': [{'$ref': '#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnection'}, {'type': 'null'}], 'default': None, 'description': 'Deleted enterprise connection object returned by Clerk.'}}, 'additionalProperties': True}
clerk.delete_jwt_template
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_jwt_templateArguments', 'required': ['template_id'], 'properties': {'template_id': {'type': 'string', 'title': 'Template Id', 'description': 'Clerk JWT template id (jtmp_...) to retrieve, update, or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkJwtTemplateResponseJwtTemplate': {'type': 'object', 'title': 'DeleteClerkJwtTemplateResponseJwtTemplate', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted JWT template id.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Always true when deletion succeeded.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkJwtTemplateResponse', 'properties': {'jwt_template': {'anyOf': [{'$ref': '#/$defs/DeleteClerkJwtTemplateResponseJwtTemplate'}, {'type': 'null'}], 'default': None, 'description': 'Deletion confirmation with template id and deleted flag.'}}, 'additionalProperties': True}
clerk.delete_machine
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_machineArguments', 'required': ['machine_id'], 'properties': {'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkMachineResponseDeletedMachine': {'type': 'object', 'title': 'DeleteClerkMachineResponseDeletedMachine', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted machine id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the machine was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkMachineResponse', 'properties': {'deleted_machine': {'anyOf': [{'$ref': '#/$defs/DeleteClerkMachineResponseDeletedMachine'}, {'type': 'null'}], 'default': None, 'description': 'Deleted machine confirmation from the Backend API.'}}, 'additionalProperties': True}
clerk.delete_machine_scope
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_machine_scopeArguments', 'required': ['machine_id', 'scope_id'], 'properties': {'scope_id': {'type': 'string', 'title': 'Scope Id', 'description': 'Target machine id (mch_...) for the scope to remove.'}, 'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkMachineScopeResponseDeletedMachineScope': {'type': 'object', 'title': 'DeleteClerkMachineScopeResponseDeletedMachineScope', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type (machine_scope).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the scope was created.'}, 'to_machine_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'To Machine Id', 'default': None, 'description': 'Machine id that can be accessed.'}, 'from_machine_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'From Machine Id', 'default': None, 'description': 'Machine id that was granted access.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkMachineScopeResponse', 'properties': {'deleted_machine_scope': {'anyOf': [{'$ref': '#/$defs/DeleteClerkMachineScopeResponseDeletedMachineScope'}, {'type': 'null'}], 'default': None, 'description': 'Deleted machine scope confirmation from the Backend API.'}}, 'additionalProperties': True}
clerk.delete_oauth_application
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_oauth_applicationArguments', 'required': ['oauth_application_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_application_id': {'type': 'string', 'title': 'Oauth Application Id', 'description': 'Clerk OAuth application id (oa_...) to retrieve, update, or delete.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOauthApplicationResponseOauthApplication': {'type': 'object', 'title': 'DeleteClerkOauthApplicationResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOauthApplicationResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOauthApplicationResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'Deleted Clerk OAuth application object from the Backend API.'}}, 'additionalProperties': True}
clerk.delete_organization
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_organizationArguments', 'required': ['organization_id'], 'properties': {'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOrganizationResponseOrganization': {'type': 'object', 'title': 'DeleteClerkOrganizationResponseOrganization', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted organization id.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Always true when deletion succeeded.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOrganizationResponse', 'properties': {'organization': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOrganizationResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Deletion confirmation with organization id and deleted flag.'}}, 'additionalProperties': True}
clerk.delete_organization_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_organization_domainArguments', 'required': ['domain_id'], 'properties': {'domain_id': {'type': 'string', 'title': 'Domain Id', 'description': 'Clerk organization domain id (dmn_...) to update, delete, or verify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOrganizationDomainResponseDeletedDomain': {'type': 'object', 'title': 'DeleteClerkOrganizationDomainResponseDeletedDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted organization domain id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Deleted object type (deleted).'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Always true when deletion succeeded.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOrganizationDomainResponse', 'properties': {'deleted_domain': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOrganizationDomainResponseDeletedDomain'}, {'type': 'null'}], 'default': None, 'description': 'Deletion confirmation with domain id and deleted flag.'}}, 'additionalProperties': True}
clerk.delete_organization_membership
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_organization_membershipArguments', 'required': ['organization_id', 'user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) of the member to remove.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to remove the member from.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOrganizationMembershipResponseMembership': {'type': 'object', 'title': 'DeleteClerkOrganizationMembershipResponseMembership', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization membership id (orgmem_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role of the member in the organization (e.g. org:admin, org:member).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) of the member.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOrganizationMembershipResponse', 'properties': {'membership': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOrganizationMembershipResponseMembership'}, {'type': 'null'}], 'default': None, 'description': 'Deleted organization membership object, when returned.'}}, 'additionalProperties': True}
clerk.delete_organization_permission
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_organization_permissionArguments', 'required': ['permission_id'], 'properties': {'permission_id': {'type': 'string', 'title': 'Permission Id', 'description': 'Clerk organization permission id to update or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOrganizationPermissionResponseOrganizationPermission': {'type': 'object', 'title': 'DeleteClerkOrganizationPermissionResponseOrganizationPermission', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted permission id.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the permission was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOrganizationPermissionResponse', 'properties': {'organization_permission': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOrganizationPermissionResponseOrganizationPermission'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deletion payload for the organization permission.'}}, 'additionalProperties': True}
clerk.delete_organization_role
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_organization_roleArguments', 'required': ['role_id'], 'properties': {'role_id': {'type': 'string', 'title': 'Role Id', 'description': 'Clerk organization role id to retrieve, update, or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkOrganizationRoleResponseOrganizationRole': {'type': 'object', 'title': 'DeleteClerkOrganizationRoleResponseOrganizationRole', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted role id.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the role was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkOrganizationRoleResponse', 'properties': {'organization_role': {'anyOf': [{'$ref': '#/$defs/DeleteClerkOrganizationRoleResponseOrganizationRole'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deletion payload for the organization role.'}}, 'additionalProperties': True}
clerk.delete_phone_number
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_phone_numberArguments', 'required': ['phone_number_id'], 'properties': {'phone_number_id': {'type': 'string', 'title': 'Phone Number Id', 'description': 'Clerk phone number id (idn_... or phn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkPhoneNumberResponseDeleted': {'type': 'object', 'title': 'DeleteClerkPhoneNumberResponseDeleted', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted phone number id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type that was deleted.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the object was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkPhoneNumberResponse', 'properties': {'deleted': {'anyOf': [{'$ref': '#/$defs/DeleteClerkPhoneNumberResponseDeleted'}, {'type': 'null'}], 'default': None, 'description': 'Deleted object confirmation from the Clerk Backend API.'}}, 'additionalProperties': True}
clerk.delete_redirect_url
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_redirect_urlArguments', 'required': ['redirect_url_id'], 'properties': {'redirect_url_id': {'type': 'string', 'title': 'Redirect Url Id', 'description': 'Clerk redirect URL id to retrieve or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkRedirectUrlResponseRedirectUrl': {'type': 'object', 'title': 'DeleteClerkRedirectUrlResponseRedirectUrl', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted resource id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the deleted resource.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the resource was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkRedirectUrlResponse', 'properties': {'redirect_url': {'anyOf': [{'$ref': '#/$defs/DeleteClerkRedirectUrlResponseRedirectUrl'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deleted-object payload confirming redirect URL removal.'}}, 'additionalProperties': True}
clerk.delete_svix_app
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_svix_appArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkSvixAppResponseSvix': {'type': 'object', 'title': 'DeleteClerkSvixAppResponseSvix', 'properties': {'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'True when the Svix app was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkSvixAppResponse', 'properties': {'svix': {'anyOf': [{'$ref': '#/$defs/DeleteClerkSvixAppResponseSvix'}, {'type': 'null'}], 'default': None, 'description': 'Deletion confirmation for the Svix app.'}}, 'additionalProperties': True}
clerk.delete_user
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_userArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserResponseUser': {'type': 'object', 'title': 'DeleteClerkUserResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Deleted Clerk user object from the Backend API, when returned.'}}, 'additionalProperties': True}
clerk.delete_user_backup_codes
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_user_backup_codesArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserBackupCodesResponseUser': {'type': 'object', 'title': 'DeleteClerkUserBackupCodesResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserBackupCodesResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserBackupCodesResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after backup codes were removed.'}}, 'additionalProperties': True}
clerk.delete_user_external_account
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_user_external_accountArguments', 'required': ['user_id', 'external_account_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'external_account_id': {'type': 'string', 'title': 'External Account Id', 'description': 'External account id (for example ea_...) to unlink.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserExternalAccountResponseExternalAccount': {'type': 'object', 'title': 'DeleteClerkUserExternalAccountResponseExternalAccount', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'External account id (ea_...).'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'OAuth provider id (for example oauth_google).'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserExternalAccountResponse', 'properties': {'external_account': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserExternalAccountResponseExternalAccount'}, {'type': 'null'}], 'default': None, 'description': 'Deleted external account object from the Clerk Backend API.'}}, 'additionalProperties': True}
clerk.delete_user_passkey
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_user_passkeyArguments', 'required': ['user_id', 'passkey_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'passkey_id': {'type': 'string', 'title': 'Passkey Id', 'description': 'Passkey identification id to delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserPasskeyResponseUser': {'type': 'object', 'title': 'DeleteClerkUserPasskeyResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserPasskeyResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserPasskeyResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after the passkey was removed.'}}, 'additionalProperties': True}
clerk.delete_user_totp
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_user_totpArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserTotpResponseUser': {'type': 'object', 'title': 'DeleteClerkUserTotpResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserTotpResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserTotpResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after TOTP was removed.'}}, 'additionalProperties': True}
clerk.delete_user_web3_wallet
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_user_web3_walletArguments', 'required': ['user_id', 'web3_wallet_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'web3_wallet_id': {'type': 'string', 'title': 'Web3 Wallet Id', 'description': 'Web3 wallet identification id to delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkUserWeb3WalletResponseUser': {'type': 'object', 'title': 'DeleteClerkUserWeb3WalletResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkUserWeb3WalletResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DeleteClerkUserWeb3WalletResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after the Web3 wallet was removed.'}}, 'additionalProperties': True}
clerk.delete_waitlist_entry
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_clerk_waitlist_entryArguments', 'required': ['waitlist_entry_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'waitlist_entry_id': {'type': 'string', 'title': 'Waitlist Entry Id', 'description': 'Clerk waitlist entry id (wle_...) to operate on.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DeleteClerkWaitlistEntryResponseDeleted': {'type': 'object', 'title': 'DeleteClerkWaitlistEntryResponseDeleted', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Deleted identifier id.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the deleted resource.'}, 'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the identifier was deleted.'}}, 'additionalProperties': True}}, 'title': 'DeleteClerkWaitlistEntryResponse', 'properties': {'deleted': {'anyOf': [{'$ref': '#/$defs/DeleteClerkWaitlistEntryResponseDeleted'}, {'type': 'null'}], 'default': None, 'description': 'Clerk deleted-object payload.'}}, 'additionalProperties': True}
clerk.disable_user_mfa
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.
Esquema de entrada
{'type': 'object', 'title': 'disable_clerk_user_mfaArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DisableClerkUserMfaResponseUser': {'type': 'object', 'title': 'DisableClerkUserMfaResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'DisableClerkUserMfaResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/DisableClerkUserMfaResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after MFA was disabled.'}}, 'additionalProperties': True}
clerk.get_api_key
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_api_keyArguments', 'required': ['api_key_id'], 'properties': {'api_key_id': {'type': 'string', 'title': 'Api Key Id', 'description': 'Clerk API key id (ak_...) to retrieve, update, delete, or revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkApiKeyResponseApiKey': {'type': 'object', 'title': 'GetClerkApiKeyResponseApiKey', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk API key id (ak_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Human-readable API key name.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/GetClerkApiKeyResponseApiKeyClaims'}, {'type': 'null'}], 'default': None, 'description': 'Custom claims embedded in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkApiKeyResponseApiKeyScopesItem'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes granted to this API key.'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the API key has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was created.'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id that created the API key, when set.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key expires, if set.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Reason recorded when the API key was revoked.'}}, 'additionalProperties': True}, 'GetClerkApiKeyResponseApiKeyClaims': {'type': 'object', 'title': 'GetClerkApiKeyResponseApiKeyClaims', 'properties': {'claim_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Claim Key', 'default': None, 'description': 'A key in the custom claims object.'}}, 'additionalProperties': True}, 'GetClerkApiKeyResponseApiKeyScopesItem': {'type': 'object', 'title': 'GetClerkApiKeyResponseApiKeyScopesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'A single scope string.'}}, 'additionalProperties': True}}, 'title': 'GetClerkApiKeyResponse', 'properties': {'api_key': {'anyOf': [{'$ref': '#/$defs/GetClerkApiKeyResponseApiKey'}, {'type': 'null'}], 'default': None, 'description': 'Clerk API key metadata from the Backend API.'}}, 'additionalProperties': True}
clerk.get_api_key_secret
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_api_key_secretArguments', 'required': ['api_key_id'], 'properties': {'api_key_id': {'type': 'string', 'title': 'Api Key Id', 'description': 'Clerk API key id (ak_...) to retrieve, update, delete, or revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkApiKeySecretResponse', 'properties': {'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}}, 'additionalProperties': True}
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 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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_connected_accountsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkConnectedAccountsResponseAccountsItem': {'type': 'object', 'title': 'GetClerkConnectedAccountsResponseAccountsItem', 'properties': {'is_default': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Default', 'default': None, 'description': 'Whether this account is used when clerk_instance_id is omitted on Clerk calls.'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Name', 'default': None, 'description': 'Connected Clerk application label shown in the dashboard.'}, 'environment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Environment Type', 'default': None, 'description': 'Clerk environment for the connection: development or production.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) to pass as clerk_instance_id on Clerk calls.'}}, 'additionalProperties': True}}, 'title': 'GetClerkConnectedAccountsResponse', 'properties': {'accounts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkConnectedAccountsResponseAccountsItem'}}, {'type': 'null'}], 'title': 'Accounts', 'default': None, 'description': 'Active connected Clerk applications for the authenticated Vee3 account.'}}, 'additionalProperties': True}
clerk.get_development_api_keys
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_development_api_keysArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkDevelopmentApiKeysResponse', 'properties': {'secret_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret Key', 'default': None, 'description': 'Clerk Secret Key (sk_test_...). Treat as high-privilege — do not log.'}, 'publishable_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Publishable Key', 'default': None, 'description': 'Clerk Publishable Key (pk_test_...). Safe for frontend env vars; do not treat as a secret equivalent to the Secret Key.'}, 'environment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Environment Type', 'default': None, 'description': 'Always "development" when this capability succeeds.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) for the connected development app.'}}, 'additionalProperties': True}
clerk.get_email_address
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_email_addressArguments', 'required': ['email_address_id'], 'properties': {'email_address_id': {'type': 'string', 'title': 'Email Address Id', 'description': 'Clerk email address id (idn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkEmailAddressResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk email address id (idn_...).'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this is the user's primary email address."}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this email address.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the email address is verified.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address value.'}, 'verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verification Status', 'default': None, 'description': 'Verification status (e.g. verified, unverified, failed).'}}, 'additionalProperties': True}
clerk.get_enterprise_connection
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_enterprise_connectionArguments', 'required': ['connection_id'], 'properties': {'connection_id': {'type': 'string', 'title': 'Connection Id', 'description': 'Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkEnterpriseConnectionResponseEnterpriseConnection': {'type': 'object', 'title': 'GetClerkEnterpriseConnectionResponseEnterpriseConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the connection.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Email domains that may use this connection.'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was last updated.'}, 'oauth_config': {'anyOf': [{'$ref': '#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig'}, {'type': 'null'}], 'default': None, 'description': 'OIDC configuration when the connection uses OAuth.'}, 'logo_public_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Logo Public Url', 'default': None, 'description': 'Public logo URL for the connection when available.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Linked Clerk organization id (org_...) when the connection is org-scoped.'}, 'saml_connection': {'anyOf': [{'$ref': '#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection'}, {'type': 'null'}], 'default': None, 'description': 'SAML configuration when the connection uses SAML.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem'}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether user attributes sync on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is supported.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether users may add additional identifications with this connection.'}}, 'additionalProperties': True}, 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig': {'type': 'object', 'title': 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth config id when the connection uses OIDC.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Custom OIDC provider display name.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id.'}, 'provider_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider Key', 'default': None, 'description': 'OAuth provider key (for example oidc_custom).'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OIDC discovery URL.'}, 'requires_pkce': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Requires Pkce', 'default': None, 'description': 'Whether PKCE is required for this OAuth client.'}}, 'additionalProperties': True}, 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection': {'type': 'object', 'title': 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'SAML connection id when the connection uses SAML.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'SAML connection display name.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the SAML connection is active.'}, 'acs_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Acs Url', 'default': None, 'description': 'Assertion Consumer Service URL.'}, 'idp_sso_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Sso Url', 'default': None, 'description': 'Identity Provider Single Sign-On URL.'}, 'sp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sp Entity Id', 'default': None, 'description': 'Service Provider entity id (Clerk).'}, 'idp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Entity Id', 'default': None, 'description': 'Identity Provider entity id.'}, 'allow_subdomains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Subdomains', 'default': None, 'description': 'Whether email subdomains may use this connection.'}, 'allow_idp_initiated': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Idp Initiated', 'default': None, 'description': 'Whether IdP-initiated SSO is allowed.'}}, 'additionalProperties': True}, 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem': {'type': 'object', 'title': 'GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem', 'properties': {'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Metadata key used to store the attribute on the user.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the custom attribute.'}, 'sso_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sso Path', 'default': None, 'description': 'Path to extract the value from SSO claims.'}, 'scim_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scim Path', 'default': None, 'description': 'GJSON path to extract the value from SCIM resources.'}, 'multi_valued': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Multi Valued', 'default': None, 'description': 'Whether the attribute supports multiple values.'}}, 'additionalProperties': True}}, 'title': 'GetClerkEnterpriseConnectionResponse', 'properties': {'enterprise_connection': {'anyOf': [{'$ref': '#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnection'}, {'type': 'null'}], 'default': None, 'description': 'Enterprise SSO connection details.'}}, 'additionalProperties': True}
clerk.get_instance
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_instanceArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkInstanceResponseInstance': {'type': 'object', 'title': 'GetClerkInstanceResponseInstance', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk instance id (ins_...).'}, 'environment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Environment Type', 'default': None, 'description': 'Clerk environment: development or production.'}}, 'additionalProperties': True}}, 'title': 'GetClerkInstanceResponse', 'properties': {'instance': {'anyOf': [{'$ref': '#/$defs/GetClerkInstanceResponseInstance'}, {'type': 'null'}], 'default': None, 'description': 'Connected Clerk instance metadata.'}}, 'additionalProperties': True}
clerk.get_instance_communication_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_instance_communication_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkInstanceCommunicationSettingsResponseCommunicationSettings': {'type': 'object', 'title': 'GetClerkInstanceCommunicationSettingsResponseCommunicationSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for communication settings.'}, 'blocked_country_codes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Blocked Country Codes', 'default': None, 'description': 'ISO country codes blocked from receiving SMS messages.'}}, 'additionalProperties': True}}, 'title': 'GetClerkInstanceCommunicationSettingsResponse', 'properties': {'communication_settings': {'anyOf': [{'$ref': '#/$defs/GetClerkInstanceCommunicationSettingsResponseCommunicationSettings'}, {'type': 'null'}], 'default': None, 'description': 'Clerk instance communication settings from the Backend API.'}}, 'additionalProperties': True}
clerk.get_instance_oauth_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_instance_oauth_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkInstanceOauthSettingsResponseOauthSettings': {'type': 'object', 'title': 'GetClerkInstanceOauthSettingsResponseOauthSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for OAuth settings.'}, 'oauth_jwt_access_tokens': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Oauth Jwt Access Tokens', 'default': None, 'description': 'Whether OAuth access tokens are issued as JWTs.'}, 'dynamic_oauth_client_registration': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamic Oauth Client Registration', 'default': None, 'description': 'Whether dynamic OAuth client registration is enabled.'}}, 'additionalProperties': True}}, 'title': 'GetClerkInstanceOauthSettingsResponse', 'properties': {'oauth_settings': {'anyOf': [{'$ref': '#/$defs/GetClerkInstanceOauthSettingsResponseOauthSettings'}, {'type': 'null'}], 'default': None, 'description': 'Clerk instance OAuth settings from the Backend API.'}}, 'additionalProperties': True}
clerk.get_instance_organization_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_instance_organization_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkInstanceOrganizationSettingsResponseOrganizationSettings': {'type': 'object', 'title': 'GetClerkInstanceOrganizationSettingsResponseOrganizationSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for organization settings.'}, 'enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Enabled', 'default': None, 'description': 'Whether organizations are enabled for the instance.'}, 'creator_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Creator Role', 'default': None, 'description': 'Default role assigned to the organization creator.'}, 'slug_disabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Slug Disabled', 'default': None, 'description': 'Whether organization slugs are disabled.'}, 'domains_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Domains Enabled', 'default': None, 'description': 'Whether organization domains are enabled.'}, 'max_allowed_roles': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Roles', 'default': None, 'description': 'Maximum custom roles allowed per organization.'}, 'max_allowed_domains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Domains', 'default': None, 'description': 'Maximum verified domains allowed per organization.'}, 'admin_delete_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Admin Delete Enabled', 'default': None, 'description': 'Whether organization admins can delete their organization.'}, 'domains_default_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domains Default Role', 'default': None, 'description': 'Default role for members who join via a verified organization domain.'}, 'initial_role_set_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Initial Role Set Key', 'default': None, 'description': 'Initial role set key applied to new organizations.'}, 'max_role_sets_allowed': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Role Sets Allowed', 'default': None, 'description': 'Maximum role sets allowed per organization.'}, 'max_allowed_memberships': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Memberships', 'default': None, 'description': 'Maximum organization memberships allowed per user.'}, 'domains_enrollment_modes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem'}}, {'type': 'null'}], 'title': 'Domains Enrollment Modes', 'default': None, 'description': 'Allowed organization domain enrollment modes.'}}, 'additionalProperties': True}, 'GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem': {'type': 'object', 'title': 'GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'An enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}}, 'additionalProperties': True}}, 'title': 'GetClerkInstanceOrganizationSettingsResponse', 'properties': {'organization_settings': {'anyOf': [{'$ref': '#/$defs/GetClerkInstanceOrganizationSettingsResponseOrganizationSettings'}, {'type': 'null'}], 'default': None, 'description': 'Clerk instance organization settings from the Backend API.'}}, 'additionalProperties': True}
clerk.get_instance_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_instance_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkInstanceSettingsResponseInstanceSettings': {'type': 'object', 'title': 'GetClerkInstanceSettingsResponseInstanceSettings', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk instance id (ins_...).'}, 'hibp': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hibp', 'default': None, 'description': 'Whether Have I Been Pwned password checking is enabled.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the instance.'}, 'test_mode': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Test Mode', 'default': None, 'description': 'Whether the instance is in test mode.'}, 'support_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Support Email', 'default': None, 'description': 'Support email address shown to end users.'}, 'allowed_origins': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Allowed Origins', 'default': None, 'description': 'Allowed browser origins for the instance.'}, 'clerk_js_version': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Js Version', 'default': None, 'description': 'Pinned Clerk.js version for the instance, when set.'}, 'environment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Environment Type', 'default': None, 'description': 'Instance environment type (development or production).'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin URL for local testing.'}, 'url_based_session_syncing': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Url Based Session Syncing', 'default': None, 'description': 'Whether URL-based session syncing is enabled.'}, 'preferred_sign_in_strategy_when_password_required': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Preferred Sign In Strategy When Password Required', 'default': None, 'description': 'Preferred sign-in strategy when a password is required: "password" or "otp".'}}, 'additionalProperties': True}}, 'title': 'GetClerkInstanceSettingsResponse', 'properties': {'instance_settings': {'anyOf': [{'$ref': '#/$defs/GetClerkInstanceSettingsResponseInstanceSettings'}, {'type': 'null'}], 'default': None, 'description': 'Core Clerk instance settings from the Backend API.'}}, 'additionalProperties': True}
clerk.get_jwks
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_jwksArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkJwksResponseJwks': {'type': 'object', 'title': 'GetClerkJwksResponseJwks', 'properties': {'keys': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkJwksResponseJwksKeysItem'}}, {'type': 'null'}], 'title': 'Keys', 'default': None, 'description': 'Public signing keys for verifying Clerk JWTs.'}}, 'additionalProperties': True}, 'GetClerkJwksResponseJwksKeysItem': {'type': 'object', 'title': 'GetClerkJwksResponseJwksKeysItem', 'properties': {'alg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Alg', 'default': None, 'description': 'Signing algorithm for the key.'}, 'kid': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Kid', 'default': None, 'description': 'Key id used to match JWT headers to a public key.'}, 'kty': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Kty', 'default': None, 'description': 'Key type, for example "RSA" or "EC".'}, 'use': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Use', 'default': None, 'description': 'Key usage, typically "sig" for signing.'}}, 'additionalProperties': True}}, 'title': 'GetClerkJwksResponse', 'properties': {'jwks': {'anyOf': [{'$ref': '#/$defs/GetClerkJwksResponseJwks'}, {'type': 'null'}], 'default': None, 'description': 'Clerk JWKS payload from the Backend API.'}}, 'additionalProperties': True}
clerk.get_jwt_template
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_jwt_templateArguments', 'required': ['template_id'], 'properties': {'template_id': {'type': 'string', 'title': 'Template Id', 'description': 'Clerk JWT template id (jtmp_...) to retrieve, update, or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkJwtTemplateResponseJwtTemplate': {'type': 'object', 'title': 'GetClerkJwtTemplateResponseJwtTemplate', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk JWT template id (jtmp_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Unique template name used when minting tokens from this template.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/GetClerkJwtTemplateResponseJwtTemplateClaims'}, {'type': 'null'}], 'default': None, 'description': 'JWT claims template as a JSON object (may include Clerk shortcodes).'}, 'lifetime': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Token lifetime in seconds (exp claim offset from issuance time).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was last updated.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Custom signing algorithm when custom_signing_key is enabled.'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Allowed clock skew in seconds for the nbf claim.'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Whether this template uses a custom signing key and algorithm.'}}, 'additionalProperties': True}, 'GetClerkJwtTemplateResponseJwtTemplateClaims': {'type': 'object', 'title': 'GetClerkJwtTemplateResponseJwtTemplateClaims', 'properties': {'aud': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Aud', 'default': None, 'description': 'Audience claim when set in the template.'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role claim when set in the template.'}}, 'additionalProperties': True}}, 'title': 'GetClerkJwtTemplateResponse', 'properties': {'jwt_template': {'anyOf': [{'$ref': '#/$defs/GetClerkJwtTemplateResponseJwtTemplate'}, {'type': 'null'}], 'default': None, 'description': 'Clerk JWT template details.'}}, 'additionalProperties': True}
clerk.get_machine
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_machineArguments', 'required': ['machine_id'], 'properties': {'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkMachineResponseMachine': {'type': 'object', 'title': 'GetClerkMachineResponseMachine', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Machine id (mch_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Machine display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was created.'}, 'secret_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret Key', 'default': None, 'description': 'Machine secret key returned on create. Treat as high-privilege — do not log.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns the machine.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Default token lifetime in seconds for tokens created by this machine.'}}, 'additionalProperties': True}}, 'title': 'GetClerkMachineResponse', 'properties': {'machine': {'anyOf': [{'$ref': '#/$defs/GetClerkMachineResponseMachine'}, {'type': 'null'}], 'default': None, 'description': 'Machine object from the Backend API.'}}, 'additionalProperties': True}
clerk.get_machine_secret_key
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_machine_secret_keyArguments', 'required': ['machine_id'], 'properties': {'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkMachineSecretKeyResponseMachineSecretKey': {'type': 'object', 'title': 'GetClerkMachineSecretKeyResponseMachineSecretKey', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type (machine_secret_key).'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'Machine secret key. Treat as high-privilege — do not log.'}}, 'additionalProperties': True}}, 'title': 'GetClerkMachineSecretKeyResponse', 'properties': {'machine_secret_key': {'anyOf': [{'$ref': '#/$defs/GetClerkMachineSecretKeyResponseMachineSecretKey'}, {'type': 'null'}], 'default': None, 'description': 'Machine secret key payload from the Backend API.'}}, 'additionalProperties': True}
clerk.get_oauth_application
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_oauth_applicationArguments', 'required': ['oauth_application_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_application_id': {'type': 'string', 'title': 'Oauth Application Id', 'description': 'Clerk OAuth application id (oa_...) to retrieve, update, or delete.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkOauthApplicationResponseOauthApplication': {'type': 'object', 'title': 'GetClerkOauthApplicationResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'GetClerkOauthApplicationResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/GetClerkOauthApplicationResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'Clerk OAuth application summary.'}}, 'additionalProperties': True}
clerk.get_organization
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_organizationArguments', 'required': ['organization_id'], 'properties': {'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkOrganizationResponseOrganization': {'type': 'object', 'title': 'GetClerkOrganizationResponseOrganization', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization id (org_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'URL-friendly organization slug, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the organization was created.'}, 'members_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Members Count', 'default': None, 'description': 'Current number of members in the organization.'}}, 'additionalProperties': True}}, 'title': 'GetClerkOrganizationResponse', 'properties': {'organization': {'anyOf': [{'$ref': '#/$defs/GetClerkOrganizationResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Clerk organization details.'}}, 'additionalProperties': True}
clerk.get_organization_invitation
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_organization_invitationArguments', 'required': ['organization_id', 'invitation_id'], 'properties': {'invitation_id': {'type': 'string', 'title': 'Invitation Id', 'description': 'Clerk organization invitation id (orginv_...).'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkOrganizationInvitationResponseInvitation': {'type': 'object', 'title': 'GetClerkOrganizationInvitationResponseInvitation', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization invitation id (inv_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role assigned to the invitee (e.g. org:admin, org:member).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: pending, accepted, or revoked.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this invitation.'}}, 'additionalProperties': True}}, 'title': 'GetClerkOrganizationInvitationResponse', 'properties': {'invitation': {'anyOf': [{'$ref': '#/$defs/GetClerkOrganizationInvitationResponseInvitation'}, {'type': 'null'}], 'default': None, 'description': 'Requested organization invitation summary.'}}, 'additionalProperties': True}
clerk.get_organization_role
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_organization_roleArguments', 'required': ['role_id'], 'properties': {'role_id': {'type': 'string', 'title': 'Role Id', 'description': 'Clerk organization role id to retrieve, update, or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkOrganizationRoleResponseOrganizationRole': {'type': 'object', 'title': 'GetClerkOrganizationRoleResponseOrganizationRole', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization role id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Role key used in memberships.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Role display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permissions assigned to this role.'}, 'is_creator_eligible': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Creator Eligible', 'default': None, 'description': 'Whether this role may be assigned as organization creator.'}}, 'additionalProperties': True}, 'GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem': {'type': 'object', 'title': 'GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'GetClerkOrganizationRoleResponse', 'properties': {'organization_role': {'anyOf': [{'$ref': '#/$defs/GetClerkOrganizationRoleResponseOrganizationRole'}, {'type': 'null'}], 'default': None, 'description': 'Organization role summary.'}}, 'additionalProperties': True}
clerk.get_phone_number
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_phone_numberArguments', 'required': ['phone_number_id'], 'properties': {'phone_number_id': {'type': 'string', 'title': 'Phone Number Id', 'description': 'Clerk phone number id (idn_... or phn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkPhoneNumberResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk phone number id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the phone number is verified.'}, 'phone_number': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone Number', 'default': None, 'description': 'Phone number in E.164 format.'}, 'default_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Default Second Factor', 'default': None, 'description': "Whether this is the user's default second factor."}, 'reserved_for_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Reserved For Second Factor', 'default': None, 'description': 'Whether the phone number is reserved for multi-factor authentication.'}}, 'additionalProperties': True}
clerk.get_redirect_url
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_redirect_urlArguments', 'required': ['redirect_url_id'], 'properties': {'redirect_url_id': {'type': 'string', 'title': 'Redirect Url Id', 'description': 'Clerk redirect URL id to retrieve or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkRedirectUrlResponseRedirectUrl': {'type': 'object', 'title': 'GetClerkRedirectUrlResponseRedirectUrl', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk redirect URL id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Allowed redirect URL value.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the redirect URL.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was last updated.'}}, 'additionalProperties': True}}, 'title': 'GetClerkRedirectUrlResponse', 'properties': {'redirect_url': {'anyOf': [{'$ref': '#/$defs/GetClerkRedirectUrlResponseRedirectUrl'}, {'type': 'null'}], 'default': None, 'description': 'Clerk redirect URL from the Backend API.'}}, 'additionalProperties': True}
clerk.get_session
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_sessionArguments', 'required': ['session_id'], 'properties': {'session_id': {'type': 'string', 'title': 'Session Id', 'description': 'Clerk session id (sess_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkSessionResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk session id (sess_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current status of the session.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this session.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'Clerk client id associated with this session.'}, 'expire_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expire At', 'default': None, 'description': 'Unix timestamp in milliseconds when this session expires.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was last updated.'}, 'last_active_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Last Active At', 'default': None, 'description': 'Unix timestamp in milliseconds of the last activity on this session.'}}, 'additionalProperties': True}
clerk.get_sign_up
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_sign_upArguments', 'required': ['sign_up_id'], 'properties': {'sign_up_id': {'type': 'string', 'title': 'Sign Up Id', 'description': 'Clerk sign-up id (su_...) to retrieve.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetClerkSignUpResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk sign-up id (su_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Sign-up status: "missing_requirements", "complete", or "abandoned".'}, 'username': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Username', 'default': None, 'description': 'Username associated with the in-progress sign-up.'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'Last name collected during sign-up.'}, 'abandon_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Abandon At', 'default': None, 'description': 'Unix timestamp in milliseconds when the sign-up will be abandoned.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'First name collected during sign-up.'}, 'phone_number': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone Number', 'default': None, 'description': 'Phone number associated with the in-progress sign-up.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address associated with the in-progress sign-up.'}, 'missing_fields': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Missing Fields', 'default': None, 'description': 'Fields still required before the sign-up can complete.'}, 'created_user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created User Id', 'default': None, 'description': 'Clerk user id created when the sign-up completed.'}, 'unverified_fields': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Unverified Fields', 'default': None, 'description': 'Fields that still need verification.'}, 'created_session_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created Session Id', 'default': None, 'description': 'Clerk session id created when the sign-up completed.'}}, 'additionalProperties': True}
clerk.get_user
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.
Esquema de entrada
{'type': 'object', 'title': 'get_clerk_userArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to retrieve.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetClerkUserResponseUser': {'type': 'object', 'title': 'GetClerkUserResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'GetClerkUserResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/GetClerkUserResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Requested Clerk user summary.'}}, 'additionalProperties': True}
clerk.invite_waitlist_entry
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.
Esquema de entrada
{'type': 'object', 'title': 'invite_clerk_waitlist_entryArguments', 'required': ['waitlist_entry_id'], 'properties': {'ignore_existing': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Ignore Existing', 'default': None, 'description': 'When true, create an invitation even if one already exists for this email.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'waitlist_entry_id': {'type': 'string', 'title': 'Waitlist Entry Id', 'description': 'Clerk waitlist entry id (wle_...) to operate on.'}}}
Esquema de salida
{'type': 'object', '$defs': {'InviteClerkWaitlistEntryResponseWaitlistEntry': {'type': 'object', 'title': 'InviteClerkWaitlistEntryResponseWaitlistEntry', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Waitlist entry id (wle_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Waitlist status: "pending", "invited", "rejected", or "completed".'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether the entry is locked during batch processing.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address on the waitlist.'}}, 'additionalProperties': True}}, 'title': 'InviteClerkWaitlistEntryResponse', 'properties': {'waitlist_entry': {'anyOf': [{'$ref': '#/$defs/InviteClerkWaitlistEntryResponseWaitlistEntry'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk waitlist entry after inviting.'}}, 'additionalProperties': True}
clerk.list_allowlist_identifiers
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_allowlist_identifiersArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'description': 'Maximum number of identifiers to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'description': 'Number of identifiers to skip before returning results.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkAllowlistIdentifiersResponseIdentifiersItem': {'type': 'object', 'title': 'ListClerkAllowlistIdentifiersResponseIdentifiersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Allowlist identifier id (alid_...).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'identifier': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier', 'default': None, 'description': 'Allowlisted email, phone, domain pattern, or Web3 wallet address.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'invitation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Invitation Id', 'default': None, 'description': 'Clerk invitation id (inv_...) when the entry was created from an invitation.'}, 'identifier_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier Type', 'default': None, 'description': 'Type of identifier: "email_address", "phone_number", or "web3_wallet".'}}, 'additionalProperties': True}}, 'title': 'ListClerkAllowlistIdentifiersResponse', 'properties': {'identifiers': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkAllowlistIdentifiersResponseIdentifiersItem'}}, {'type': 'null'}], 'title': 'Identifiers', 'default': None, 'description': 'Allowlist identifiers returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of allowlist identifiers for the instance.'}}, 'additionalProperties': True}
clerk.list_api_keys
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_api_keysArguments', 'required': ['subject'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of API keys to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Search query to filter API keys by name.'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of API keys to skip before returning results.'}, 'subject': {'type': 'string', 'title': 'Subject', 'description': 'Subject to list API keys for (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'Filter by API key type (typically "api_key").'}, 'include_invalid': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Include Invalid', 'default': None, 'description': 'When true, include revoked or expired API keys.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkApiKeysResponseApiKeysItem': {'type': 'object', 'title': 'ListClerkApiKeysResponseApiKeysItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk API key id (ak_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Human-readable API key name.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/ListClerkApiKeysResponseApiKeysItemClaims'}, {'type': 'null'}], 'default': None, 'description': 'Custom claims embedded in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkApiKeysResponseApiKeysItemScopesItem'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes granted to this API key.'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the API key has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was created.'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id that created the API key, when set.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key expires, if set.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Reason recorded when the API key was revoked.'}}, 'additionalProperties': True}, 'ListClerkApiKeysResponseApiKeysItemClaims': {'type': 'object', 'title': 'ListClerkApiKeysResponseApiKeysItemClaims', 'properties': {'claim_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Claim Key', 'default': None, 'description': 'A key in the custom claims object.'}}, 'additionalProperties': True}, 'ListClerkApiKeysResponseApiKeysItemScopesItem': {'type': 'object', 'title': 'ListClerkApiKeysResponseApiKeysItemScopesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'A single scope string.'}}, 'additionalProperties': True}}, 'title': 'ListClerkApiKeysResponse', 'properties': {'api_keys': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkApiKeysResponseApiKeysItem'}}, {'type': 'null'}], 'title': 'Api Keys', 'default': None, 'description': 'API keys matching the request.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of API keys matching the filters.'}}, 'additionalProperties': True}
clerk.list_blocklist_identifiers
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_blocklist_identifiersArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'description': 'Maximum number of identifiers to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'description': 'Number of identifiers to skip before returning results.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkBlocklistIdentifiersResponseIdentifiersItem': {'type': 'object', 'title': 'ListClerkBlocklistIdentifiersResponseIdentifiersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Blocklist identifier id (blid_...).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'identifier': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier', 'default': None, 'description': 'Blocklisted email, domain, phone, or Web3 wallet address.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'identifier_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Identifier Type', 'default': None, 'description': 'Type of identifier: "email_address", "phone_number", or "web3_wallet".'}}, 'additionalProperties': True}}, 'title': 'ListClerkBlocklistIdentifiersResponse', 'properties': {'identifiers': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkBlocklistIdentifiersResponseIdentifiersItem'}}, {'type': 'null'}], 'title': 'Identifiers', 'default': None, 'description': 'Blocklist identifiers returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of blocklist identifiers for the instance.'}}, 'additionalProperties': True}
clerk.list_domains
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_domainsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkDomainsResponseDomainsItem': {'type': 'object', 'title': 'ListClerkDomainsResponseDomainsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk domain id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain hostname.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the domain.'}, 'proxy_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Proxy Url', 'default': None, 'description': 'Proxy URL when using a satellite domain behind a reverse proxy.'}, 'is_satellite': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Satellite', 'default': None, 'description': 'Whether this is a satellite domain.'}, 'cname_targets': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkDomainsResponseDomainsItemCnameTargetsItem'}}, {'type': 'null'}], 'title': 'Cname Targets', 'default': None, 'description': 'CNAME records required to verify the domain.'}, 'frontend_api_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Frontend Api Url', 'default': None, 'description': 'Frontend API URL for the domain.'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin associated with the domain.'}, 'accounts_portal_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Accounts Portal Url', 'default': None, 'description': 'Accounts portal URL for the domain.'}}, 'additionalProperties': True}, 'ListClerkDomainsResponseDomainsItemCnameTargetsItem': {'type': 'object', 'title': 'ListClerkDomainsResponseDomainsItemCnameTargetsItem', 'properties': {'host': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host', 'default': None, 'description': 'DNS host label for the CNAME record.'}, 'value': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Value', 'default': None, 'description': 'DNS target value for the CNAME record.'}, 'required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Required', 'default': None, 'description': 'Whether this CNAME record is required for domain verification.'}}, 'additionalProperties': True}}, 'title': 'ListClerkDomainsResponse', 'properties': {'domains': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkDomainsResponseDomainsItem'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Custom domains configured for the connected Clerk instance.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of domains.'}}, 'additionalProperties': True}
clerk.list_enterprise_connections
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_enterprise_connectionsArguments', 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of results to return (1–500).'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Filter by active status. Omit to return all connections.'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of results to skip before returning.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Filter connections linked to this Clerk organization id (org_...).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the connection.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Email domains that may use this connection.'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was last updated.'}, 'oauth_config': {'anyOf': [{'$ref': '#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig'}, {'type': 'null'}], 'default': None, 'description': 'OIDC configuration when the connection uses OAuth.'}, 'logo_public_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Logo Public Url', 'default': None, 'description': 'Public logo URL for the connection when available.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Linked Clerk organization id (org_...) when the connection is org-scoped.'}, 'saml_connection': {'anyOf': [{'$ref': '#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection'}, {'type': 'null'}], 'default': None, 'description': 'SAML configuration when the connection uses SAML.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem'}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether user attributes sync on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is supported.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether users may add additional identifications with this connection.'}}, 'additionalProperties': True}, 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth config id when the connection uses OIDC.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Custom OIDC provider display name.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id.'}, 'provider_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider Key', 'default': None, 'description': 'OAuth provider key (for example oidc_custom).'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OIDC discovery URL.'}, 'requires_pkce': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Requires Pkce', 'default': None, 'description': 'Whether PKCE is required for this OAuth client.'}}, 'additionalProperties': True}, 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'SAML connection id when the connection uses SAML.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'SAML connection display name.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the SAML connection is active.'}, 'acs_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Acs Url', 'default': None, 'description': 'Assertion Consumer Service URL.'}, 'idp_sso_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Sso Url', 'default': None, 'description': 'Identity Provider Single Sign-On URL.'}, 'sp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sp Entity Id', 'default': None, 'description': 'Service Provider entity id (Clerk).'}, 'idp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Entity Id', 'default': None, 'description': 'Identity Provider entity id.'}, 'allow_subdomains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Subdomains', 'default': None, 'description': 'Whether email subdomains may use this connection.'}, 'allow_idp_initiated': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Idp Initiated', 'default': None, 'description': 'Whether IdP-initiated SSO is allowed.'}}, 'additionalProperties': True}, 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem', 'properties': {'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Metadata key used to store the attribute on the user.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the custom attribute.'}, 'sso_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sso Path', 'default': None, 'description': 'Path to extract the value from SSO claims.'}, 'scim_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scim Path', 'default': None, 'description': 'GJSON path to extract the value from SCIM resources.'}, 'multi_valued': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Multi Valued', 'default': None, 'description': 'Whether the attribute supports multiple values.'}}, 'additionalProperties': True}}, 'title': 'ListClerkEnterpriseConnectionsResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of enterprise connections matching the query.'}, 'enterprise_connections': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem'}}, {'type': 'null'}], 'title': 'Enterprise Connections', 'default': None, 'description': 'Enterprise SSO connections in the connected Clerk application.'}}, 'additionalProperties': True}
clerk.list_enterprise_connection_test_runs
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_enterprise_connection_test_runsArguments', 'required': ['connection_id'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of results to return (1–500).'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of results to skip before returning.'}, 'status': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Filter by test run status: "pending", "success", or "failed".'}, 'connection_id': {'type': 'string', 'title': 'Connection Id', 'description': 'Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection test run id.'}, 'logs': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem'}}, {'type': 'null'}], 'title': 'Logs', 'default': None, 'description': 'Log entries captured during the test run.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Test run status: "pending", "success", or "failed".'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the test run was created.'}, 'connection_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Connection Type', 'default': None, 'description': 'Connection type tested: "saml" or "oauth".'}, 'parsed_user_info': {'anyOf': [{'$ref': '#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo'}, {'type': 'null'}], 'default': None, 'description': 'User attributes parsed from the IdP response.'}}, 'additionalProperties': True}, 'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem', 'properties': {'code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Optional machine-readable log code.'}, 'level': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Level', 'default': None, 'description': 'Log level (for example info, warn, or error).'}, 'message': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Message', 'default': None, 'description': 'Log message text.'}, 'short_message': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Short Message', 'default': None, 'description': 'Optional short log summary.'}}, 'additionalProperties': True}, 'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo': {'type': 'object', 'title': 'ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo', 'properties': {'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'User id parsed from the IdP response.'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'Last name parsed from the IdP response.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'First name parsed from the IdP response.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address parsed from the IdP response.'}}, 'additionalProperties': True}}, 'title': 'ListClerkEnterpriseConnectionTestRunsResponse', 'properties': {'test_runs': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem'}}, {'type': 'null'}], 'title': 'Test Runs', 'default': None, 'description': 'Enterprise connection SSO test runs.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of test runs matching the query.'}}, 'additionalProperties': True}
clerk.list_invitations
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_invitationsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'description': 'Maximum number of invitations to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'description': 'Number of invitations to skip before returning results.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Optional status filter: "pending", "accepted", "revoked", or "expired".'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkInvitationsResponseInvitationsItem': {'type': 'object', 'title': 'ListClerkInvitationsResponseInvitationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk invitation id (inv_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: "pending", "accepted", "revoked", or "expired".'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the invitation has been revoked.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the invitation was created.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}}, 'additionalProperties': True}}, 'title': 'ListClerkInvitationsResponse', 'properties': {'invitations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkInvitationsResponseInvitationsItem'}}, {'type': 'null'}], 'title': 'Invitations', 'default': None, 'description': 'Invitations returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of invitations returned on this page.'}}, 'additionalProperties': True}
clerk.list_jwt_templates
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_jwt_templatesArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkJwtTemplatesResponseJwtTemplatesItem': {'type': 'object', 'title': 'ListClerkJwtTemplatesResponseJwtTemplatesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk JWT template id (jtmp_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Unique template name used when minting tokens from this template.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/ListClerkJwtTemplatesResponseJwtTemplatesItemClaims'}, {'type': 'null'}], 'default': None, 'description': 'JWT claims template as a JSON object (may include Clerk shortcodes).'}, 'lifetime': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Token lifetime in seconds (exp claim offset from issuance time).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was last updated.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Custom signing algorithm when custom_signing_key is enabled.'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Allowed clock skew in seconds for the nbf claim.'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Whether this template uses a custom signing key and algorithm.'}}, 'additionalProperties': True}, 'ListClerkJwtTemplatesResponseJwtTemplatesItemClaims': {'type': 'object', 'title': 'ListClerkJwtTemplatesResponseJwtTemplatesItemClaims', 'properties': {'aud': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Aud', 'default': None, 'description': 'Audience claim when set in the template.'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role claim when set in the template.'}}, 'additionalProperties': True}}, 'title': 'ListClerkJwtTemplatesResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of JWT templates.'}, 'jwt_templates': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkJwtTemplatesResponseJwtTemplatesItem'}}, {'type': 'null'}], 'title': 'Jwt Templates', 'default': None, 'description': 'JWT templates in the connected Clerk application.'}}, 'additionalProperties': True}
clerk.list_m2m_tokens
List M2M tokens for a machine in a connected Clerk instance. **Sensitive** — returns token metadata for active machine credentials. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns M2M token summaries plus total_count. JWT-format tokens are not listed. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_m2m_tokensArguments', 'required': ['subject'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of results to return (1–500).'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of results to skip before returning.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Include expired tokens (default false).'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Include revoked tokens (default false).'}, 'subject': {'type': 'string', 'title': 'Subject', 'description': 'Machine id (mch_...) whose tokens to list.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkM2mTokensResponseM2mTokensItem': {'type': 'object', 'title': 'ListClerkM2mTokensResponseM2mTokensItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'M2M token id (mt_...).'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'M2M token secret when returned on creation. Treat as high-privilege — do not log.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Whether the token has expired.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the token has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Machine id (mch_...) that created or owns the token.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the token expires.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}}, 'title': 'ListClerkM2mTokensResponse', 'properties': {'m2m_tokens': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkM2mTokensResponseM2mTokensItem'}}, {'type': 'null'}], 'title': 'M2M Tokens', 'default': None, 'description': 'M2M tokens for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of matching M2M tokens.'}}, 'additionalProperties': True}
clerk.list_machines
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_machinesArguments', 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of results to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Filter by machine id (exact) or name (partial match).'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of results to skip before returning.'}, 'order_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order By', 'default': None, 'description': 'Sort by name or created_at; prefix with - for descending (default -created_at).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkMachinesResponseMachinesItem': {'type': 'object', 'title': 'ListClerkMachinesResponseMachinesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Machine id (mch_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Machine display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was created.'}, 'secret_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret Key', 'default': None, 'description': 'Machine secret key returned on create. Treat as high-privilege — do not log.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns the machine.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Default token lifetime in seconds for tokens created by this machine.'}}, 'additionalProperties': True}}, 'title': 'ListClerkMachinesResponse', 'properties': {'machines': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkMachinesResponseMachinesItem'}}, {'type': 'null'}], 'title': 'Machines', 'default': None, 'description': 'Machines for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of machines in the instance.'}}, 'additionalProperties': True}
clerk.list_oauth_applications
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_oauth_applicationsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOauthApplicationsResponseOauthApplicationsItem': {'type': 'object', 'title': 'ListClerkOauthApplicationsResponseOauthApplicationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOauthApplicationsResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of OAuth applications.'}, 'oauth_applications': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOauthApplicationsResponseOauthApplicationsItem'}}, {'type': 'null'}], 'title': 'Oauth Applications', 'default': None, 'description': 'OAuth applications in the connected Clerk application.'}}, 'additionalProperties': True}
clerk.list_organization_domains
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organization_domainsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of results to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Search domains by name or organization id. Values starting with org_ match organization id exactly; otherwise performs a case-insensitive partial match on the domain name.'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of results to skip before returning.'}, 'verified': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Filter by verification status: "true" or "false".'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Filter domains to a specific Clerk organization id (org_...).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationDomainsResponseDomainsItem': {'type': 'object', 'title': 'ListClerkOrganizationDomainsResponseDomainsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization domain id (dmn_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain name (for example example.com).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was last updated.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this domain.'}, 'affiliation_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Email Address', 'default': None, 'description': 'Affiliation email address for the domain, when set.'}, 'total_pending_invitations': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Invitations', 'default': None, 'description': 'Number of pending invitations associated with this domain.'}, 'total_pending_suggestions': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Suggestions', 'default': None, 'description': 'Number of pending membership suggestions associated with this domain.'}, 'ownership_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ownership Verification Status', 'default': None, 'description': 'DNS ownership verification status (unverified, verified, failed, or expired).'}, 'affiliation_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Verification Status', 'default': None, 'description': 'Affiliation verification status (unverified, verified, failed, or expired).'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationDomainsResponse', 'properties': {'domains': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationDomainsResponseDomainsItem'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Organization domains returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of domains matching the filter.'}}, 'additionalProperties': True}
clerk.list_organization_invitations
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organization_invitationsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of results to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of results to skip before returning.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Filter by invitation status: pending, accepted, revoked, or expired.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Filter invitations to a specific Clerk organization id (org_...).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationInvitationsResponseInvitationsItem': {'type': 'object', 'title': 'ListClerkOrganizationInvitationsResponseInvitationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization invitation id (inv_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role assigned to the invitee (e.g. org:admin, org:member).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: pending, accepted, or revoked.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this invitation.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationInvitationsResponse', 'properties': {'invitations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationInvitationsResponseInvitationsItem'}}, {'type': 'null'}], 'title': 'Invitations', 'default': None, 'description': 'Invitations returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of invitations matching the filter.'}}, 'additionalProperties': True}
clerk.list_organization_memberships
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organization_membershipsArguments', 'required': ['organization_id'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of organization memberships to return (1–500).'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of organization memberships to skip before returning results.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) whose members to list.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationMembershipsResponseMembershipsItem': {'type': 'object', 'title': 'ListClerkOrganizationMembershipsResponseMembershipsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization membership id (orgmem_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role of the member in the organization (e.g. org:admin, org:member).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) of the member.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationMembershipsResponse', 'properties': {'memberships': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationMembershipsResponseMembershipsItem'}}, {'type': 'null'}], 'title': 'Memberships', 'default': None, 'description': 'Memberships returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of members in the organization.'}}, 'additionalProperties': True}
clerk.list_organization_permissions
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organization_permissionsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of results to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Search by name or key.'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of results to skip before returning.'}, 'order_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order By', 'default': None, 'description': 'Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem': {'type': 'object', 'title': 'ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationPermissionsResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of organization permissions.'}, 'organization_permissions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem'}}, {'type': 'null'}], 'title': 'Organization Permissions', 'default': None, 'description': 'Organization permissions in the connected Clerk application.'}}, 'additionalProperties': True}
clerk.list_organization_roles
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organization_rolesArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of results to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Search by name or key.'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of results to skip before returning.'}, 'order_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order By', 'default': None, 'description': 'Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationRolesResponseOrganizationRolesItem': {'type': 'object', 'title': 'ListClerkOrganizationRolesResponseOrganizationRolesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization role id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Role key used in memberships.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Role display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permissions assigned to this role.'}, 'is_creator_eligible': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Creator Eligible', 'default': None, 'description': 'Whether this role may be assigned as organization creator.'}}, 'additionalProperties': True}, 'ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem': {'type': 'object', 'title': 'ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationRolesResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of organization roles.'}, 'organization_roles': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationRolesResponseOrganizationRolesItem'}}, {'type': 'null'}], 'title': 'Organization Roles', 'default': None, 'description': 'Organization roles in the connected Clerk application.'}}, 'additionalProperties': True}
clerk.list_organizations
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_organizationsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of organizations to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Optional search string to filter organizations by name or slug.'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of organizations to skip before returning results.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkOrganizationsResponseOrganizationsItem': {'type': 'object', 'title': 'ListClerkOrganizationsResponseOrganizationsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization id (org_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'URL-friendly organization slug, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the organization was created.'}, 'members_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Members Count', 'default': None, 'description': 'Current number of members in the organization.'}}, 'additionalProperties': True}}, 'title': 'ListClerkOrganizationsResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of organizations in the Clerk application.'}, 'organizations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkOrganizationsResponseOrganizationsItem'}}, {'type': 'null'}], 'title': 'Organizations', 'default': None, 'description': 'Organizations returned for the requested page.'}}, 'additionalProperties': True}
clerk.list_redirect_urls
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_redirect_urlsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of redirect URLs to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of redirect URLs to skip before returning results.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkRedirectUrlsResponseRedirectUrlsItem': {'type': 'object', 'title': 'ListClerkRedirectUrlsResponseRedirectUrlsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk redirect URL id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Allowed redirect URL value.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the redirect URL.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the redirect URL was last updated.'}}, 'additionalProperties': True}}, 'title': 'ListClerkRedirectUrlsResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of redirect URLs.'}, 'redirect_urls': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkRedirectUrlsResponseRedirectUrlsItem'}}, {'type': 'null'}], 'title': 'Redirect Urls', 'default': None, 'description': 'Allowed redirect URLs returned for the requested page.'}}, 'additionalProperties': True}
clerk.list_sessions
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_sessionsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of sessions to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of sessions to skip before returning results.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Filter sessions by status. Accepted values: abandoned, active, ended, expired, removed, replaced, revoked.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Filter sessions to those belonging to this Clerk user id (user_...). Clerk requires user_id or client_id when listing sessions; pass user_id here.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'Filter sessions to those belonging to this Clerk client id (client_...).'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkSessionsResponseSessionsItem': {'type': 'object', 'title': 'ListClerkSessionsResponseSessionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk session id (sess_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current status of the session.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this session.'}, 'expire_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expire At', 'default': None, 'description': 'Unix timestamp in milliseconds when this session expires.'}, 'last_active_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Last Active At', 'default': None, 'description': 'Unix timestamp in milliseconds of the last activity on this session.'}}, 'additionalProperties': True}}, 'title': 'ListClerkSessionsResponse', 'properties': {'sessions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkSessionsResponseSessionsItem'}}, {'type': 'null'}], 'title': 'Sessions', 'default': None, 'description': 'Sessions returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of sessions returned.'}}, 'additionalProperties': True}
clerk.list_user_organization_memberships
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_user_organization_membershipsArguments', 'required': ['user_id'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 500, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of organization memberships to return (1–500).'}, 'offset': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Offset', 'default': None, 'description': 'Number of organization memberships to skip before returning results.'}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) whose memberships to list.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkUserOrganizationMembershipsResponseMembershipsItem': {'type': 'object', 'title': 'ListClerkUserOrganizationMembershipsResponseMembershipsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Organization membership id.'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Member role within the organization (e.g. org:admin, org:member).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was last updated.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...).'}}, 'additionalProperties': True}}, 'title': 'ListClerkUserOrganizationMembershipsResponse', 'properties': {'memberships': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkUserOrganizationMembershipsResponseMembershipsItem'}}, {'type': 'null'}], 'title': 'Memberships', 'default': None, 'description': 'Organization memberships for the user.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of organization memberships for the user.'}}, 'additionalProperties': True}
clerk.list_users
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_usersArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'maximum': 500, 'minimum': 1, 'description': 'Maximum number of users to return (1–500).'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'minimum': 0, 'description': 'Number of users to skip before returning results.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkUsersResponseUsersItem': {'type': 'object', 'title': 'ListClerkUsersResponseUsersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'ListClerkUsersResponse', 'properties': {'users': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkUsersResponseUsersItem'}}, {'type': 'null'}], 'title': 'Users', 'default': None, 'description': 'Users returned for the requested page.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of users in the Clerk application.'}}, 'additionalProperties': True}
clerk.list_waitlist_entries
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.
Esquema de entrada
{'type': 'object', 'title': 'list_clerk_waitlist_entriesArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 10, 'description': 'Maximum number of waitlist entries to return (1–500).'}, 'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Filter by email address or waitlist entry id.'}, 'offset': {'type': 'integer', 'title': 'Offset', 'default': 0, 'description': 'Number of waitlist entries to skip before returning results.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Optional status filter: "pending", "invited", "rejected", or "completed".'}, 'order_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order By', 'default': None, 'description': 'Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListClerkWaitlistEntriesResponseWaitlistEntriesItem': {'type': 'object', 'title': 'ListClerkWaitlistEntriesResponseWaitlistEntriesItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Waitlist entry id (wle_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Waitlist status: "pending", "invited", "rejected", or "completed".'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether the entry is locked during batch processing.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address on the waitlist.'}}, 'additionalProperties': True}}, 'title': 'ListClerkWaitlistEntriesResponse', 'properties': {'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Total number of waitlist entries on this page.'}, 'waitlist_entries': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListClerkWaitlistEntriesResponseWaitlistEntriesItem'}}, {'type': 'null'}], 'title': 'Waitlist Entries', 'default': None, 'description': 'Waitlist entries returned for the requested page.'}}, 'additionalProperties': True}
clerk.reject_waitlist_entry
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.
Esquema de entrada
{'type': 'object', 'title': 'reject_clerk_waitlist_entryArguments', 'required': ['waitlist_entry_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'waitlist_entry_id': {'type': 'string', 'title': 'Waitlist Entry Id', 'description': 'Clerk waitlist entry id (wle_...) to operate on.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RejectClerkWaitlistEntryResponseWaitlistEntry': {'type': 'object', 'title': 'RejectClerkWaitlistEntryResponseWaitlistEntry', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Waitlist entry id (wle_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Waitlist status: "pending", "invited", "rejected", or "completed".'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether the entry is locked during batch processing.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the entry was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address on the waitlist.'}}, 'additionalProperties': True}}, 'title': 'RejectClerkWaitlistEntryResponse', 'properties': {'waitlist_entry': {'anyOf': [{'$ref': '#/$defs/RejectClerkWaitlistEntryResponseWaitlistEntry'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk waitlist entry after rejection.'}}, 'additionalProperties': True}
clerk.replace_user_metadata
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.
Esquema de entrada
{'type': 'object', 'title': 'replace_clerk_user_metadataArguments', 'required': ['user_id', 'metadata_type', 'metadata'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) whose metadata to replace.'}, 'metadata': {'type': 'object', 'title': 'Metadata', 'description': 'New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys.', 'additionalProperties': True}, 'metadata_type': {'type': 'string', 'title': 'Metadata Type', 'description': 'Metadata namespace to replace.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ReplaceClerkUserMetadataResponseUser': {'type': 'object', 'title': 'ReplaceClerkUserMetadataResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'ReplaceClerkUserMetadataResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/ReplaceClerkUserMetadataResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after the metadata replacement.'}}, 'additionalProperties': True}
clerk.revoke_actor_token
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_actor_tokenArguments', 'required': ['actor_token_id'], 'properties': {'actor_token_id': {'type': 'string', 'title': 'Actor Token Id', 'description': 'Clerk actor token id to revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkActorTokenResponseActorToken': {'type': 'object', 'title': 'RevokeClerkActorTokenResponseActorToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Actor token id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Optional sign-in URL that includes the actor token.'}, 'actor': {'anyOf': [{'$ref': '#/$defs/RevokeClerkActorTokenResponseActorTokenActor'}, {'type': 'null'}], 'default': None, 'description': 'Actor payload; includes sub with the impersonating user id.'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Actor token secret. Treat as high-privilege — do not log.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Token status (pending, accepted, or revoked).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) being impersonated.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}, 'RevokeClerkActorTokenResponseActorTokenActor': {'type': 'object', 'title': 'RevokeClerkActorTokenResponseActorTokenActor', 'properties': {'sub': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sub', 'default': None, 'description': 'Clerk user id (user_...) of the impersonating actor.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkActorTokenResponse', 'properties': {'actor_token': {'anyOf': [{'$ref': '#/$defs/RevokeClerkActorTokenResponseActorToken'}, {'type': 'null'}], 'default': None, 'description': 'Revoked Clerk actor token object from the Backend API.'}}, 'additionalProperties': True}
clerk.revoke_admin_portal_link_token
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_admin_portal_link_tokenArguments', 'required': ['admin_portal_link_token_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Optional reason recorded when revoking the link token.'}, 'admin_portal_link_token_id': {'type': 'string', 'title': 'Admin Portal Link Token Id', 'description': 'Admin portal link token id (aplt_...) to revoke.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken': {'type': 'object', 'title': 'RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Admin portal link token id (aplt_...).'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Whether the link token has expired.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the link token has been revoked.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the link token was created.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the link token expires.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...).'}, 'admin_portal_link_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Admin Portal Link Id', 'default': None, 'description': 'Origin admin portal link id (apl_...).'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkAdminPortalLinkTokenResponse', 'properties': {'admin_portal_link_token': {'anyOf': [{'$ref': '#/$defs/RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken'}, {'type': 'null'}], 'default': None, 'description': 'Revoked admin portal link token from the Backend API.'}}, 'additionalProperties': True}
clerk.revoke_api_key
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_api_keyArguments', 'required': ['api_key_id'], 'properties': {'api_key_id': {'type': 'string', 'title': 'Api Key Id', 'description': 'Clerk API key id (ak_...) to retrieve, update, delete, or revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Optional reason recorded when revoking the API key.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkApiKeyResponseApiKey': {'type': 'object', 'title': 'RevokeClerkApiKeyResponseApiKey', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk API key id (ak_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Human-readable API key name.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/RevokeClerkApiKeyResponseApiKeyClaims'}, {'type': 'null'}], 'default': None, 'description': 'Custom claims embedded in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RevokeClerkApiKeyResponseApiKeyScopesItem'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes granted to this API key.'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the API key has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was created.'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id that created the API key, when set.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key expires, if set.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Reason recorded when the API key was revoked.'}}, 'additionalProperties': True}, 'RevokeClerkApiKeyResponseApiKeyClaims': {'type': 'object', 'title': 'RevokeClerkApiKeyResponseApiKeyClaims', 'properties': {'claim_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Claim Key', 'default': None, 'description': 'A key in the custom claims object.'}}, 'additionalProperties': True}, 'RevokeClerkApiKeyResponseApiKeyScopesItem': {'type': 'object', 'title': 'RevokeClerkApiKeyResponseApiKeyScopesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'A single scope string.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkApiKeyResponse', 'properties': {'api_key': {'anyOf': [{'$ref': '#/$defs/RevokeClerkApiKeyResponseApiKey'}, {'type': 'null'}], 'default': None, 'description': 'Revoked Clerk API key from the Backend API.'}}, 'additionalProperties': True}
clerk.revoke_invitation
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_invitationArguments', 'required': ['invitation_id'], 'properties': {'invitation_id': {'type': 'string', 'title': 'Invitation Id', 'description': 'Clerk application invitation id (inv_...) to revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkInvitationResponseInvitation': {'type': 'object', 'title': 'RevokeClerkInvitationResponseInvitation', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk invitation id (inv_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: "pending", "accepted", "revoked", or "expired".'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the invitation has been revoked.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the invitation was created.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkInvitationResponse', 'properties': {'invitation': {'anyOf': [{'$ref': '#/$defs/RevokeClerkInvitationResponseInvitation'}, {'type': 'null'}], 'default': None, 'description': 'Revoked Clerk invitation object from the Backend API.'}}, 'additionalProperties': True}
clerk.revoke_m2m_token
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_m2m_tokenArguments', 'required': ['m2m_token_id'], 'properties': {'m2m_token_id': {'type': 'string', 'title': 'M2M Token Id', 'description': 'Clerk M2M token id (mt_...) to revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkM2mTokenResponseM2mToken': {'type': 'object', 'title': 'RevokeClerkM2mTokenResponseM2mToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'M2M token id (mt_...).'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'M2M token secret when returned on creation. Treat as high-privilege — do not log.'}, 'expired': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Expired', 'default': None, 'description': 'Whether the token has expired.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the token has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Machine id (mch_...) that created or owns the token.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the token expires.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkM2mTokenResponse', 'properties': {'m2m_token': {'anyOf': [{'$ref': '#/$defs/RevokeClerkM2mTokenResponseM2mToken'}, {'type': 'null'}], 'default': None, 'description': 'Revoked M2M token from the Backend API.'}}, 'additionalProperties': True}
clerk.revoke_organization_invitation
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_organization_invitationArguments', 'required': ['organization_id', 'invitation_id'], 'properties': {'invitation_id': {'type': 'string', 'title': 'Invitation Id', 'description': 'Clerk organization invitation id (orginv_...).'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkOrganizationInvitationResponseInvitation': {'type': 'object', 'title': 'RevokeClerkOrganizationInvitationResponseInvitation', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization invitation id (inv_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role assigned to the invitee (e.g. org:admin, org:member).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Invitation status: pending, accepted, or revoked.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address the invitation was sent to.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this invitation.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkOrganizationInvitationResponse', 'properties': {'invitation': {'anyOf': [{'$ref': '#/$defs/RevokeClerkOrganizationInvitationResponseInvitation'}, {'type': 'null'}], 'default': None, 'description': 'Revoked organization invitation summary.'}}, 'additionalProperties': True}
clerk.revoke_session
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_sessionArguments', 'required': ['session_id'], 'properties': {'session_id': {'type': 'string', 'title': 'Session Id', 'description': 'Clerk session id (sess_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', 'title': 'RevokeClerkSessionResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk session id (sess_...).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current status of the session.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this session.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'Clerk client id associated with this session.'}, 'expire_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expire At', 'default': None, 'description': 'Unix timestamp in milliseconds when this session expires.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the session was last updated.'}, 'last_active_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Last Active At', 'default': None, 'description': 'Unix timestamp in milliseconds of the last activity on this session.'}}, 'additionalProperties': True}
clerk.revoke_sign_in_token
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.
Esquema de entrada
{'type': 'object', 'title': 'revoke_clerk_sign_in_tokenArguments', 'required': ['sign_in_token_id'], 'properties': {'sign_in_token_id': {'type': 'string', 'title': 'Sign In Token Id', 'description': 'Clerk sign-in token id to revoke.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RevokeClerkSignInTokenResponseSignInToken': {'type': 'object', 'title': 'RevokeClerkSignInTokenResponseSignInToken', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Sign-in token id.'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Optional sign-in URL that includes the token.'}, 'token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token', 'default': None, 'description': 'Sign-in token secret. Treat as high-privilege — do not log.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Token status (pending, accepted, or revoked).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) the token is for.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the token was last updated.'}}, 'additionalProperties': True}}, 'title': 'RevokeClerkSignInTokenResponse', 'properties': {'sign_in_token': {'anyOf': [{'$ref': '#/$defs/RevokeClerkSignInTokenResponseSignInToken'}, {'type': 'null'}], 'default': None, 'description': 'Revoked Clerk sign-in token object from the Backend API.'}}, 'additionalProperties': True}
clerk.rotate_machine_secret_key
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.
Esquema de entrada
{'type': 'object', 'title': 'rotate_clerk_machine_secret_keyArguments', 'required': ['machine_id', 'previous_token_ttl'], 'properties': {'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'previous_token_ttl': {'type': 'integer', 'title': 'Previous Token Ttl', 'maximum': 28800, 'minimum': 0, 'description': 'Seconds the previous secret key remains valid after rotation (0–28800).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RotateClerkMachineSecretKeyResponseMachineSecretKey': {'type': 'object', 'title': 'RotateClerkMachineSecretKeyResponseMachineSecretKey', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Object type (machine_secret_key).'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'Machine secret key. Treat as high-privilege — do not log.'}}, 'additionalProperties': True}}, 'title': 'RotateClerkMachineSecretKeyResponse', 'properties': {'machine_secret_key': {'anyOf': [{'$ref': '#/$defs/RotateClerkMachineSecretKeyResponseMachineSecretKey'}, {'type': 'null'}], 'default': None, 'description': 'Rotated machine secret key payload from the Backend API.'}}, 'additionalProperties': True}
clerk.rotate_oauth_application_secret
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.
Esquema de entrada
{'type': 'object', 'title': 'rotate_clerk_oauth_application_secretArguments', 'required': ['oauth_application_id'], 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_application_id': {'type': 'string', 'title': 'Oauth Application Id', 'description': 'Clerk OAuth application id (oa_...) to retrieve, update, or delete.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RotateClerkOauthApplicationSecretResponseOauthApplication': {'type': 'object', 'title': 'RotateClerkOauthApplicationSecretResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'RotateClerkOauthApplicationSecretResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/RotateClerkOauthApplicationSecretResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'OAuth application summary with the new client_secret.'}}, 'additionalProperties': True}
clerk.unban_users
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.
Esquema de entrada
{'type': 'object', 'title': 'unban_clerk_usersArguments', 'required': ['user_ids'], 'properties': {'user_ids': {'type': 'array', 'items': {'type': 'string'}, 'title': 'User Ids', 'description': 'List of one or more Clerk user ids (user_...) to unban.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UnbanClerkUsersResponseUsersItem': {'type': 'object', 'title': 'UnbanClerkUsersResponseUsersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'UnbanClerkUsersResponse', 'properties': {'users': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UnbanClerkUsersResponseUsersItem'}}, {'type': 'null'}], 'title': 'Users', 'default': None, 'description': 'Updated user summaries for all unbanned users.'}, 'total_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Count', 'default': None, 'description': 'Number of users that were unbanned.'}}, 'additionalProperties': True}
clerk.update_api_key
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_api_keyArguments', 'required': ['api_key_id'], 'properties': {'claims': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Claims', 'default': None, 'description': 'Updated custom claims for tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Updated permission scopes for the API key.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Updated subject (user_... or org_...).'}, 'api_key_id': {'type': 'string', 'title': 'Api Key Id', 'description': 'Clerk API key id (ak_...) to retrieve, update, delete, or revoke.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Updated description for the API key.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'seconds_until_expiration': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Seconds Until Expiration', 'default': None, 'description': 'Updated seconds until expiration from now.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkApiKeyResponseApiKey': {'type': 'object', 'title': 'UpdateClerkApiKeyResponseApiKey', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk API key id (ak_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Human-readable API key name.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/UpdateClerkApiKeyResponseApiKeyClaims'}, {'type': 'null'}], 'default': None, 'description': 'Custom claims embedded in tokens minted from this API key.'}, 'scopes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UpdateClerkApiKeyResponseApiKeyScopesItem'}}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Permission scopes granted to this API key.'}, 'secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret', 'default': None, 'description': 'API key secret value. Treat as high-privilege — do not log.'}, 'revoked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Revoked', 'default': None, 'description': 'Whether the API key has been revoked.'}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subject', 'default': None, 'description': 'Subject the API key is scoped to (user_... or org_...).'}, 'key_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key Type', 'default': None, 'description': 'API key type (typically "api_key").'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was created.'}, 'created_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created By', 'default': None, 'description': 'User id that created the API key, when set.'}, 'expiration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Expiration', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key expires, if set.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the API key was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Optional description for the API key.'}, 'revocation_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Revocation Reason', 'default': None, 'description': 'Reason recorded when the API key was revoked.'}}, 'additionalProperties': True}, 'UpdateClerkApiKeyResponseApiKeyClaims': {'type': 'object', 'title': 'UpdateClerkApiKeyResponseApiKeyClaims', 'properties': {'claim_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Claim Key', 'default': None, 'description': 'A key in the custom claims object.'}}, 'additionalProperties': True}, 'UpdateClerkApiKeyResponseApiKeyScopesItem': {'type': 'object', 'title': 'UpdateClerkApiKeyResponseApiKeyScopesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'A single scope string.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkApiKeyResponse', 'properties': {'api_key': {'anyOf': [{'$ref': '#/$defs/UpdateClerkApiKeyResponseApiKey'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk API key from the Backend API.'}}, 'additionalProperties': True}
clerk.update_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_domainArguments', 'required': ['domain_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Updated domain hostname.'}, 'domain_id': {'type': 'string', 'title': 'Domain Id', 'description': 'Clerk organization domain id (dmn_...) to update, delete, or verify.'}, 'proxy_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Proxy Url', 'default': None, 'description': 'Updated proxy URL for a satellite domain.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkDomainResponseDomain': {'type': 'object', 'title': 'UpdateClerkDomainResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk domain id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain hostname.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the domain.'}, 'proxy_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Proxy Url', 'default': None, 'description': 'Proxy URL when using a satellite domain behind a reverse proxy.'}, 'is_satellite': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Satellite', 'default': None, 'description': 'Whether this is a satellite domain.'}, 'cname_targets': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UpdateClerkDomainResponseDomainCnameTargetsItem'}}, {'type': 'null'}], 'title': 'Cname Targets', 'default': None, 'description': 'CNAME records required to verify the domain.'}, 'frontend_api_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Frontend Api Url', 'default': None, 'description': 'Frontend API URL for the domain.'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin associated with the domain.'}, 'accounts_portal_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Accounts Portal Url', 'default': None, 'description': 'Accounts portal URL for the domain.'}}, 'additionalProperties': True}, 'UpdateClerkDomainResponseDomainCnameTargetsItem': {'type': 'object', 'title': 'UpdateClerkDomainResponseDomainCnameTargetsItem', 'properties': {'host': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host', 'default': None, 'description': 'DNS host label for the CNAME record.'}, 'value': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Value', 'default': None, 'description': 'DNS target value for the CNAME record.'}, 'required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Required', 'default': None, 'description': 'Whether this CNAME record is required for domain verification.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkDomainResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/UpdateClerkDomainResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk domain from the Backend API.'}}, 'additionalProperties': True}
clerk.update_email_address
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_email_addressArguments', 'required': ['email_address_id'], 'properties': {'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "When true, set this email as the user's primary email address."}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'When true, mark the email address as verified.'}, 'email_address_id': {'type': 'string', 'title': 'Email Address Id', 'description': 'Clerk email address id (idn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkEmailAddressResponseEmailAddress': {'type': 'object', 'title': 'UpdateClerkEmailAddressResponseEmailAddress', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk email address id (idn_...).'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this is the user's primary email address."}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) that owns this email address.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the email address is verified.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the email address was last updated.'}, 'email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email Address', 'default': None, 'description': 'Email address value.'}, 'verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verification Status', 'default': None, 'description': 'Verification status (e.g. verified, unverified, failed).'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkEmailAddressResponse', 'properties': {'email_address': {'anyOf': [{'$ref': '#/$defs/UpdateClerkEmailAddressResponseEmailAddress'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk email address summary.'}}, 'additionalProperties': True}
clerk.update_enterprise_connection
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_enterprise_connectionArguments', 'required': ['connection_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Updated display name for the connection.'}, 'oidc': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Oidc', 'default': None, 'description': 'Updated OIDC client configuration.'}, 'saml': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Saml', 'default': None, 'description': 'Updated SAML IdP configuration.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Updated domain list (replaces existing domains when provided).'}, 'connection_id': {'type': 'string', 'title': 'Connection Id', 'description': 'Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) to link to this connection.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Updated custom attribute mappings.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether to sync user attributes on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is allowed.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether to block additional identifications for this connection.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkEnterpriseConnectionResponseEnterpriseConnection': {'type': 'object', 'title': 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Enterprise connection id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the connection.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the connection is active.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Email domains that may use this connection.'}, 'provider': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider', 'default': None, 'description': 'Identity provider key (for example saml_custom or oidc_custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the connection was last updated.'}, 'oauth_config': {'anyOf': [{'$ref': '#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig'}, {'type': 'null'}], 'default': None, 'description': 'OIDC configuration when the connection uses OAuth.'}, 'logo_public_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Logo Public Url', 'default': None, 'description': 'Public logo URL for the connection when available.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Linked Clerk organization id (org_...) when the connection is org-scoped.'}, 'saml_connection': {'anyOf': [{'$ref': '#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection'}, {'type': 'null'}], 'default': None, 'description': 'SAML configuration when the connection uses SAML.'}, 'custom_attributes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem'}}, {'type': 'null'}], 'title': 'Custom Attributes', 'default': None, 'description': 'Custom attribute mappings from the IdP to user metadata.'}, 'sync_user_attributes': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Sync User Attributes', 'default': None, 'description': 'Whether user attributes sync on each sign-in.'}, 'allow_organization_account_linking': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Organization Account Linking', 'default': None, 'description': 'Whether account linking via organization membership is supported.'}, 'disable_additional_identifications': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Disable Additional Identifications', 'default': None, 'description': 'Whether users may add additional identifications with this connection.'}}, 'additionalProperties': True}, 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig': {'type': 'object', 'title': 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth config id when the connection uses OIDC.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Custom OIDC provider display name.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id.'}, 'provider_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Provider Key', 'default': None, 'description': 'OAuth provider key (for example oidc_custom).'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OIDC discovery URL.'}, 'requires_pkce': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Requires Pkce', 'default': None, 'description': 'Whether PKCE is required for this OAuth client.'}}, 'additionalProperties': True}, 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection': {'type': 'object', 'title': 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'SAML connection id when the connection uses SAML.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'SAML connection display name.'}, 'active': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Active', 'default': None, 'description': 'Whether the SAML connection is active.'}, 'acs_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Acs Url', 'default': None, 'description': 'Assertion Consumer Service URL.'}, 'idp_sso_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Sso Url', 'default': None, 'description': 'Identity Provider Single Sign-On URL.'}, 'sp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sp Entity Id', 'default': None, 'description': 'Service Provider entity id (Clerk).'}, 'idp_entity_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Idp Entity Id', 'default': None, 'description': 'Identity Provider entity id.'}, 'allow_subdomains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Subdomains', 'default': None, 'description': 'Whether email subdomains may use this connection.'}, 'allow_idp_initiated': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allow Idp Initiated', 'default': None, 'description': 'Whether IdP-initiated SSO is allowed.'}}, 'additionalProperties': True}, 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem': {'type': 'object', 'title': 'UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem', 'properties': {'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Metadata key used to store the attribute on the user.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the custom attribute.'}, 'sso_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sso Path', 'default': None, 'description': 'Path to extract the value from SSO claims.'}, 'scim_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scim Path', 'default': None, 'description': 'GJSON path to extract the value from SCIM resources.'}, 'multi_valued': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Multi Valued', 'default': None, 'description': 'Whether the attribute supports multiple values.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkEnterpriseConnectionResponse', 'properties': {'enterprise_connection': {'anyOf': [{'$ref': '#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnection'}, {'type': 'null'}], 'default': None, 'description': 'Updated enterprise SSO connection.'}}, 'additionalProperties': True}
clerk.update_instance_communication_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_instance_communication_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'blocked_country_codes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Blocked Country Codes', 'default': None, 'description': 'ISO country codes to block from receiving SMS messages (up to 250).'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings': {'type': 'object', 'title': 'UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for communication settings.'}, 'blocked_country_codes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Blocked Country Codes', 'default': None, 'description': 'ISO country codes blocked from receiving SMS messages.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkInstanceCommunicationSettingsResponse', 'properties': {'communication_settings': {'anyOf': [{'$ref': '#/$defs/UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk instance communication settings from the Backend API.'}}, 'additionalProperties': True}
clerk.update_instance_oauth_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_instance_oauth_settingsArguments', 'properties': {'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_jwt_access_tokens': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Oauth Jwt Access Tokens', 'default': None, 'description': 'Whether OAuth access tokens should be issued as JWTs.'}, 'dynamic_oauth_client_registration': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamic Oauth Client Registration', 'default': None, 'description': 'Whether dynamic OAuth client registration should be enabled.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkInstanceOauthSettingsResponseOauthSettings': {'type': 'object', 'title': 'UpdateClerkInstanceOauthSettingsResponseOauthSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for OAuth settings.'}, 'oauth_jwt_access_tokens': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Oauth Jwt Access Tokens', 'default': None, 'description': 'Whether OAuth access tokens are issued as JWTs.'}, 'dynamic_oauth_client_registration': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamic Oauth Client Registration', 'default': None, 'description': 'Whether dynamic OAuth client registration is enabled.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkInstanceOauthSettingsResponse', 'properties': {'oauth_settings': {'anyOf': [{'$ref': '#/$defs/UpdateClerkInstanceOauthSettingsResponseOauthSettings'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk instance OAuth settings from the Backend API.'}}, 'additionalProperties': True}
clerk.update_instance_organization_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_instance_organization_settingsArguments', 'properties': {'enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Enabled', 'default': None, 'description': 'Whether organizations should be enabled for the instance.'}, 'creator_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Creator Role', 'default': None, 'description': 'Default role assigned to the organization creator.'}, 'domains_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Domains Enabled', 'default': None, 'description': 'Whether organization domains should be enabled.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'admin_delete_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Admin Delete Enabled', 'default': None, 'description': 'Whether organization admins can delete their organization.'}, 'domains_default_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domains Default Role', 'default': None, 'description': 'Default role for members who join via a verified organization domain.'}, 'initial_role_set_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Initial Role Set Key', 'default': None, 'description': 'Initial role set key applied to new organizations.'}, 'max_allowed_memberships': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Memberships', 'default': None, 'description': 'Maximum organization memberships allowed per user.'}, 'domains_enrollment_modes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Domains Enrollment Modes', 'default': None, 'description': 'Allowed organization domain enrollment modes: manual_invitation, automatic_invitation, or automatic_suggestion.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings': {'type': 'object', 'title': 'UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for organization settings.'}, 'enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Enabled', 'default': None, 'description': 'Whether organizations are enabled for the instance.'}, 'creator_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Creator Role', 'default': None, 'description': 'Default role assigned to the organization creator.'}, 'slug_disabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Slug Disabled', 'default': None, 'description': 'Whether organization slugs are disabled.'}, 'domains_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Domains Enabled', 'default': None, 'description': 'Whether organization domains are enabled.'}, 'max_allowed_roles': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Roles', 'default': None, 'description': 'Maximum custom roles allowed per organization.'}, 'max_allowed_domains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Domains', 'default': None, 'description': 'Maximum verified domains allowed per organization.'}, 'admin_delete_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Admin Delete Enabled', 'default': None, 'description': 'Whether organization admins can delete their organization.'}, 'domains_default_role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domains Default Role', 'default': None, 'description': 'Default role for members who join via a verified organization domain.'}, 'initial_role_set_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Initial Role Set Key', 'default': None, 'description': 'Initial role set key applied to new organizations.'}, 'max_role_sets_allowed': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Role Sets Allowed', 'default': None, 'description': 'Maximum role sets allowed per organization.'}, 'max_allowed_memberships': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Memberships', 'default': None, 'description': 'Maximum organization memberships allowed per user.'}, 'domains_enrollment_modes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem'}}, {'type': 'null'}], 'title': 'Domains Enrollment Modes', 'default': None, 'description': 'Allowed organization domain enrollment modes.'}}, 'additionalProperties': True}, 'UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem': {'type': 'object', 'title': 'UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem', 'properties': {'item': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Item', 'default': None, 'description': 'An enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkInstanceOrganizationSettingsResponse', 'properties': {'organization_settings': {'anyOf': [{'$ref': '#/$defs/UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk instance organization settings from the Backend API.'}}, 'additionalProperties': True}
clerk.update_instance_restrictions
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_instance_restrictionsArguments', 'properties': {'allowlist': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allowlist', 'default': None, 'description': 'Whether the allowlist restriction should be enabled.'}, 'blocklist': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Blocklist', 'default': None, 'description': 'Whether the blocklist restriction should be enabled.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'block_email_subaddresses': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Block Email Subaddresses', 'default': None, 'description': 'Whether email subaddresses (plus-addressing) should be blocked.'}, 'block_disposable_email_domains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Block Disposable Email Domains', 'default': None, 'description': 'Whether disposable email domains should be blocked.'}, 'allowlist_blocklist_disabled_on_sign_in': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allowlist Blocklist Disabled On Sign In', 'default': None, 'description': 'Whether allowlist and blocklist checks should be skipped during sign-in.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkInstanceRestrictionsResponseRestrictions': {'type': 'object', 'title': 'UpdateClerkInstanceRestrictionsResponseRestrictions', 'properties': {'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for instance restrictions.'}, 'allowlist': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allowlist', 'default': None, 'description': 'Whether the allowlist restriction is enabled.'}, 'blocklist': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Blocklist', 'default': None, 'description': 'Whether the blocklist restriction is enabled.'}, 'block_email_subaddresses': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Block Email Subaddresses', 'default': None, 'description': 'Whether email subaddresses (plus-addressing) are blocked.'}, 'block_disposable_email_domains': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Block Disposable Email Domains', 'default': None, 'description': 'Whether disposable email domains are blocked.'}, 'allowlist_blocklist_disabled_on_sign_in': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Allowlist Blocklist Disabled On Sign In', 'default': None, 'description': 'Whether allowlist and blocklist checks are skipped during sign-in.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkInstanceRestrictionsResponse', 'properties': {'restrictions': {'anyOf': [{'$ref': '#/$defs/UpdateClerkInstanceRestrictionsResponseRestrictions'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk instance restrictions from the Backend API.'}}, 'additionalProperties': True}
clerk.update_instance_settings
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_instance_settingsArguments', 'properties': {'hibp': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hibp', 'default': None, 'description': 'Whether Have I Been Pwned password checking should be enabled.'}, 'test_mode': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Test Mode', 'default': None, 'description': 'Whether the instance should run in test mode.'}, 'support_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Support Email', 'default': None, 'description': 'Support email address shown to end users.'}, 'allowed_origins': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Allowed Origins', 'default': None, 'description': 'Allowed browser origins for the instance.'}, 'clerk_js_version': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Js Version', 'default': None, 'description': 'Pinned Clerk.js version for the instance.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin URL for local testing.'}, 'url_based_session_syncing': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Url Based Session Syncing', 'default': None, 'description': 'Whether URL-based session syncing should be enabled.'}, 'preferred_sign_in_strategy_when_password_required': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Preferred Sign In Strategy When Password Required', 'default': None, 'description': 'Preferred sign-in strategy when a password is required: "password" or "otp".'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkInstanceSettingsResponseInstanceSettings': {'type': 'object', 'title': 'UpdateClerkInstanceSettingsResponseInstanceSettings', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk instance id (ins_...).'}, 'hibp': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hibp', 'default': None, 'description': 'Whether Have I Been Pwned password checking is enabled.'}, 'object': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Object', 'default': None, 'description': 'Clerk object type for the instance.'}, 'test_mode': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Test Mode', 'default': None, 'description': 'Whether the instance is in test mode.'}, 'support_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Support Email', 'default': None, 'description': 'Support email address shown to end users.'}, 'allowed_origins': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Allowed Origins', 'default': None, 'description': 'Allowed browser origins for the instance.'}, 'clerk_js_version': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Js Version', 'default': None, 'description': 'Pinned Clerk.js version for the instance, when set.'}, 'environment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Environment Type', 'default': None, 'description': 'Instance environment type (development or production).'}, 'development_origin': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Development Origin', 'default': None, 'description': 'Development origin URL for local testing.'}, 'url_based_session_syncing': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Url Based Session Syncing', 'default': None, 'description': 'Whether URL-based session syncing is enabled.'}, 'preferred_sign_in_strategy_when_password_required': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Preferred Sign In Strategy When Password Required', 'default': None, 'description': 'Preferred sign-in strategy when a password is required: "password" or "otp".'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkInstanceSettingsResponse', 'properties': {'instance_settings': {'anyOf': [{'$ref': '#/$defs/UpdateClerkInstanceSettingsResponseInstanceSettings'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk instance settings from the Backend API.'}}, 'additionalProperties': True}
clerk.update_jwt_template
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_jwt_templateArguments', 'required': ['template_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Optional new unique template name.'}, 'claims': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Claims', 'default': None, 'description': 'Optional new JWT claims template as a JSON object.'}, 'lifetime': {'anyOf': [{'type': 'integer', 'maximum': 315360000, 'minimum': 30}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Optional new token lifetime in seconds (30–315360000).'}, 'signing_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Key', 'default': None, 'description': 'Optional custom signing private key.'}, 'template_id': {'type': 'string', 'title': 'Template Id', 'description': 'Clerk JWT template id (jtmp_...) to retrieve, update, or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Optional custom signing algorithm.'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer', 'maximum': 300, 'minimum': 0}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Optional new allowed clock skew in seconds (0–300).'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Optional flag to enable or disable a custom signing key.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkJwtTemplateResponseJwtTemplate': {'type': 'object', 'title': 'UpdateClerkJwtTemplateResponseJwtTemplate', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk JWT template id (jtmp_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Unique template name used when minting tokens from this template.'}, 'claims': {'anyOf': [{'$ref': '#/$defs/UpdateClerkJwtTemplateResponseJwtTemplateClaims'}, {'type': 'null'}], 'default': None, 'description': 'JWT claims template as a JSON object (may include Clerk shortcodes).'}, 'lifetime': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lifetime', 'default': None, 'description': 'Token lifetime in seconds (exp claim offset from issuance time).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the template was last updated.'}, 'signing_algorithm': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Signing Algorithm', 'default': None, 'description': 'Custom signing algorithm when custom_signing_key is enabled.'}, 'allowed_clock_skew': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Allowed Clock Skew', 'default': None, 'description': 'Allowed clock skew in seconds for the nbf claim.'}, 'custom_signing_key': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Custom Signing Key', 'default': None, 'description': 'Whether this template uses a custom signing key and algorithm.'}}, 'additionalProperties': True}, 'UpdateClerkJwtTemplateResponseJwtTemplateClaims': {'type': 'object', 'title': 'UpdateClerkJwtTemplateResponseJwtTemplateClaims', 'properties': {'aud': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Aud', 'default': None, 'description': 'Audience claim when set in the template.'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role claim when set in the template.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkJwtTemplateResponse', 'properties': {'jwt_template': {'anyOf': [{'$ref': '#/$defs/UpdateClerkJwtTemplateResponseJwtTemplate'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk JWT template summary.'}}, 'additionalProperties': True}
clerk.update_machine
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_machineArguments', 'required': ['machine_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Updated machine display name.'}, 'machine_id': {'type': 'string', 'title': 'Machine Id', 'description': 'Clerk machine id (mch_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer', 'maximum': 315360000, 'minimum': 1}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Updated default M2M token lifetime in seconds.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkMachineResponseMachine': {'type': 'object', 'title': 'UpdateClerkMachineResponseMachine', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Machine id (mch_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Machine display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was created.'}, 'secret_key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Secret Key', 'default': None, 'description': 'Machine secret key returned on create. Treat as high-privilege — do not log.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the machine was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns the machine.'}, 'default_token_ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Default Token Ttl', 'default': None, 'description': 'Default token lifetime in seconds for tokens created by this machine.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkMachineResponse', 'properties': {'machine': {'anyOf': [{'$ref': '#/$defs/UpdateClerkMachineResponseMachine'}, {'type': 'null'}], 'default': None, 'description': 'Updated machine object from the Backend API.'}}, 'additionalProperties': True}
clerk.update_oauth_application
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_oauth_applicationArguments', 'required': ['oauth_application_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'New display name for the OAuth application.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (no client secret; PKCE-capable).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes (e.g. profile email public_metadata).'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Replacement list of allowed redirect URIs.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_application_id': {'type': 'string', 'title': 'Oauth Application Id', 'description': 'Clerk OAuth application id (oa_...) to retrieve, update, or delete.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether to show the OAuth consent screen during authorization.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOauthApplicationResponseOauthApplication': {'type': 'object', 'title': 'UpdateClerkOauthApplicationResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOauthApplicationResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOauthApplicationResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk OAuth application summary.'}}, 'additionalProperties': True}
clerk.update_organization
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organizationArguments', 'required': ['organization_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Optional new display name for the organization.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Optional new URL-friendly slug.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'public_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Public Metadata', 'default': None, 'description': 'Optional public metadata to merge into the organization.'}, 'private_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Private Metadata', 'default': None, 'description': 'Optional private metadata to merge into the organization.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'max_allowed_memberships': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Allowed Memberships', 'default': None, 'description': 'Optional new maximum number of memberships allowed.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationResponseOrganization': {'type': 'object', 'title': 'UpdateClerkOrganizationResponseOrganization', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization id (org_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'URL-friendly organization slug, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the organization was created.'}, 'members_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Members Count', 'default': None, 'description': 'Current number of members in the organization.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationResponse', 'properties': {'organization': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk organization summary.'}}, 'additionalProperties': True}
clerk.update_organization_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_domainArguments', 'required': ['domain_id'], 'properties': {'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the domain is verified.'}, 'domain_id': {'type': 'string', 'title': 'Domain Id', 'description': 'Clerk organization domain id (dmn_...) to update, delete, or verify.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationDomainResponseDomain': {'type': 'object', 'title': 'UpdateClerkOrganizationDomainResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization domain id (dmn_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain name (for example example.com).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was last updated.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this domain.'}, 'affiliation_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Email Address', 'default': None, 'description': 'Affiliation email address for the domain, when set.'}, 'total_pending_invitations': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Invitations', 'default': None, 'description': 'Number of pending invitations associated with this domain.'}, 'total_pending_suggestions': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Suggestions', 'default': None, 'description': 'Number of pending membership suggestions associated with this domain.'}, 'ownership_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ownership Verification Status', 'default': None, 'description': 'DNS ownership verification status (unverified, verified, failed, or expired).'}, 'affiliation_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Verification Status', 'default': None, 'description': 'Affiliation verification status (unverified, verified, failed, or expired).'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationDomainResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationDomainResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Updated organization domain summary.'}}, 'additionalProperties': True}
clerk.update_organization_membership
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_membershipArguments', 'required': ['organization_id', 'user_id', 'role'], 'properties': {'role': {'type': 'string', 'title': 'Role', 'description': 'New role for the member (e.g. org:member, org:admin).'}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) of the member to update.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) containing the member.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationMembershipResponseMembership': {'type': 'object', 'title': 'UpdateClerkOrganizationMembershipResponseMembership', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization membership id (orgmem_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role of the member in the organization (e.g. org:admin, org:member).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) of the member.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationMembershipResponse', 'properties': {'membership': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationMembershipResponseMembership'}, {'type': 'null'}], 'default': None, 'description': 'Updated organization membership.'}}, 'additionalProperties': True}
clerk.update_organization_membership_metadata
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_membership_metadataArguments', 'required': ['organization_id', 'user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) of the member.'}, 'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) containing the membership.'}, 'public_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Public Metadata', 'default': None, 'description': 'Public metadata to merge into the membership.'}, 'private_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Private Metadata', 'default': None, 'description': 'Private metadata to merge into the membership.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationMembershipMetadataResponseMembership': {'type': 'object', 'title': 'UpdateClerkOrganizationMembershipMetadataResponseMembership', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization membership id (orgmem_...).'}, 'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Role', 'default': None, 'description': 'Role of the member in the organization (e.g. org:admin, org:member).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Clerk user id (user_...) of the member.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the membership was created.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationMembershipMetadataResponse', 'properties': {'membership': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationMembershipMetadataResponseMembership'}, {'type': 'null'}], 'default': None, 'description': 'Updated organization membership.'}}, 'additionalProperties': True}
clerk.update_organization_metadata
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_metadataArguments', 'required': ['organization_id'], 'properties': {'organization_id': {'type': 'string', 'title': 'Organization Id', 'description': 'Clerk organization id (org_...) to operate on.'}, 'public_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Public Metadata', 'default': None, 'description': 'Public metadata to merge into the organization.'}, 'private_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Private Metadata', 'default': None, 'description': 'Private metadata to merge into the organization.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationMetadataResponseOrganization': {'type': 'object', 'title': 'UpdateClerkOrganizationMetadataResponseOrganization', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization id (org_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Organization display name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'URL-friendly organization slug, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the organization was created.'}, 'members_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Members Count', 'default': None, 'description': 'Current number of members in the organization.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationMetadataResponse', 'properties': {'organization': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationMetadataResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk organization summary.'}}, 'additionalProperties': True}
clerk.update_organization_permission
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_permissionArguments', 'required': ['permission_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Updated permission display name.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Updated permission description.'}, 'permission_id': {'type': 'string', 'title': 'Permission Id', 'description': 'Clerk organization permission id to update or delete.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationPermissionResponseOrganizationPermission': {'type': 'object', 'title': 'UpdateClerkOrganizationPermissionResponseOrganizationPermission', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationPermissionResponse', 'properties': {'organization_permission': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationPermissionResponseOrganizationPermission'}, {'type': 'null'}], 'default': None, 'description': 'Updated organization permission summary.'}}, 'additionalProperties': True}
clerk.update_organization_role
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_organization_roleArguments', 'required': ['role_id'], 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Updated role display name.'}, 'role_id': {'type': 'string', 'title': 'Role Id', 'description': 'Clerk organization role id to retrieve, update, or delete.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Updated role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permission keys to assign to the role.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'is_creator_eligible': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Creator Eligible', 'default': None, 'description': 'Whether this role may be assigned as organization creator.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkOrganizationRoleResponseOrganizationRole': {'type': 'object', 'title': 'UpdateClerkOrganizationRoleResponseOrganizationRole', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization role id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Role key used in memberships.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Role display name.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the role was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Role description.'}, 'permissions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem'}}, {'type': 'null'}], 'title': 'Permissions', 'default': None, 'description': 'Permissions assigned to this role.'}, 'is_creator_eligible': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Creator Eligible', 'default': None, 'description': 'Whether this role may be assigned as organization creator.'}}, 'additionalProperties': True}, 'UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem': {'type': 'object', 'title': 'UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization permission id.'}, 'key': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Key', 'default': None, 'description': 'Permission key used in role assignments.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Permission display name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Permission type (system or custom).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the permission was last updated.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Permission description.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkOrganizationRoleResponse', 'properties': {'organization_role': {'anyOf': [{'$ref': '#/$defs/UpdateClerkOrganizationRoleResponseOrganizationRole'}, {'type': 'null'}], 'default': None, 'description': 'Updated organization role summary.'}}, 'additionalProperties': True}
clerk.update_phone_number
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_phone_numberArguments', 'required': ['phone_number_id'], 'properties': {'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Primary', 'default': None, 'description': "Whether this should be the user's primary phone number."}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the phone number should be marked verified.'}, 'phone_number_id': {'type': 'string', 'title': 'Phone Number Id', 'description': 'Clerk phone number id (idn_... or phn_...) to retrieve or modify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'reserved_for_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Reserved For Second Factor', 'default': None, 'description': 'Whether to reserve this number for multi-factor authentication.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkPhoneNumberResponsePhoneNumber': {'type': 'object', 'title': 'UpdateClerkPhoneNumberResponsePhoneNumber', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk phone number id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the phone number is verified.'}, 'phone_number': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone Number', 'default': None, 'description': 'Phone number in E.164 format.'}, 'default_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Default Second Factor', 'default': None, 'description': "Whether this is the user's default second factor."}, 'reserved_for_second_factor': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Reserved For Second Factor', 'default': None, 'description': 'Whether the phone number is reserved for multi-factor authentication.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkPhoneNumberResponse', 'properties': {'phone_number': {'anyOf': [{'$ref': '#/$defs/UpdateClerkPhoneNumberResponsePhoneNumber'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk phone number object from the Backend API.'}}, 'additionalProperties': True}
clerk.update_user
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_userArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) to update.'}, 'username': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Username', 'default': None, 'description': 'Optional username.'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'Optional last name.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'Optional first name.'}, 'external_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'External Id', 'default': None, 'description': 'Optional external id for the user.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkUserResponseUser': {'type': 'object', 'title': 'UpdateClerkUserResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkUserResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/UpdateClerkUserResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user summary.'}}, 'additionalProperties': True}
clerk.update_user_metadata
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.
Esquema de entrada
{'type': 'object', 'title': 'update_clerk_user_metadataArguments', 'required': ['user_id'], 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Clerk user id (user_...) whose metadata to update.'}, 'public_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Public Metadata', 'default': None, 'description': 'Public metadata fields to merge. Existing keys not listed are preserved.'}, 'unsafe_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Unsafe Metadata', 'default': None, 'description': 'Unsafe metadata fields to merge. Existing keys not listed are preserved.'}, 'private_metadata': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Private Metadata', 'default': None, 'description': 'Private metadata fields to merge. Existing keys not listed are preserved.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UpdateClerkUserMetadataResponseUser': {'type': 'object', 'title': 'UpdateClerkUserMetadataResponseUser', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk user id (user_...).'}, 'last_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Name', 'default': None, 'description': 'User last name, if set.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the user was created.'}, 'first_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Name', 'default': None, 'description': 'User first name, if set.'}, 'primary_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Primary Email Address', 'default': None, 'description': 'Primary email address for the user, if available.'}}, 'additionalProperties': True}}, 'title': 'UpdateClerkUserMetadataResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/UpdateClerkUserMetadataResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Updated Clerk user object after the metadata merge.'}}, 'additionalProperties': True}
clerk.upload_oauth_application_logo
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.
Esquema de entrada
{'type': 'object', 'title': 'upload_clerk_oauth_application_logoArguments', 'required': ['oauth_application_id', 'file_name'], 'properties': {'file_name': {'type': 'string', 'title': 'File Name', 'description': 'Stored file name from files.list_uploaded_files. Upload with files.upload_file first.'}, 'uploader_user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Uploader User Id', 'default': None, 'description': 'Clerk user id (user_...) credited with the image upload.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}, 'oauth_application_id': {'type': 'string', 'title': 'Oauth Application Id', 'description': 'Clerk OAuth application id (oa_...) to retrieve, update, or delete.'}}}
Esquema de salida
{'type': 'object', '$defs': {'UploadClerkOauthApplicationLogoResponseOauthApplication': {'type': 'object', 'title': 'UploadClerkOauthApplicationLogoResponseOauthApplication', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'OAuth application id (oa_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'OAuth application display name.'}, 'public': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Public', 'default': None, 'description': 'Whether this is a public OAuth client (PKCE-capable, no client secret).'}, 'scopes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scopes', 'default': None, 'description': 'Space-delimited scopes granted by this OAuth application.'}, 'client_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Id', 'default': None, 'description': 'OAuth client id issued to authorized clients.'}, 'client_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Uri', 'default': None, 'description': 'Homepage URI for the OAuth client.'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the OAuth application was last updated.'}, 'instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) that owns this OAuth application.'}, 'authorize_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Authorize Url', 'default': None, 'description': 'Authorization endpoint URL for this OAuth application.'}, 'client_secret': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Secret', 'default': None, 'description': 'OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.'}, 'discovery_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Discovery Url', 'default': None, 'description': 'OpenID Connect discovery document URL.'}, 'pkce_required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Pkce Required', 'default': None, 'description': 'Whether PKCE is required for the authorization flow.'}, 'redirect_uris': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Redirect Uris', 'default': None, 'description': 'Allowed redirect URIs for the OAuth authorization flow.'}, 'token_fetch_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Token Fetch Url', 'default': None, 'description': 'Token endpoint URL for exchanging authorization codes.'}, 'client_image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Client Image Url', 'default': None, 'description': 'URL of the OAuth application logo when set.'}, 'consent_screen_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Consent Screen Enabled', 'default': None, 'description': 'Whether the consent screen is shown during authorization.'}, 'dynamically_registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dynamically Registered', 'default': None, 'description': 'Whether the OAuth application was registered dynamically.'}}, 'additionalProperties': True}}, 'title': 'UploadClerkOauthApplicationLogoResponse', 'properties': {'oauth_application': {'anyOf': [{'$ref': '#/$defs/UploadClerkOauthApplicationLogoResponseOauthApplication'}, {'type': 'null'}], 'default': None, 'description': 'OAuth application summary with updated client_image_url.'}}, 'additionalProperties': True}
clerk.verify_organization_domain_ownership
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.
Esquema de entrada
{'type': 'object', 'title': 'verify_clerk_organization_domain_ownershipArguments', 'required': ['domain_id'], 'properties': {'domain_id': {'type': 'string', 'title': 'Domain Id', 'description': 'Clerk organization domain id (dmn_...) to update, delete, or verify.'}, 'clerk_instance_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Clerk Instance Id', 'default': None, 'description': 'Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'VerifyClerkOrganizationDomainOwnershipResponseDomain': {'type': 'object', 'title': 'VerifyClerkOrganizationDomainOwnershipResponseDomain', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Clerk organization domain id (dmn_...).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Domain name (for example example.com).'}, 'created_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was created.'}, 'updated_at': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'Unix timestamp in milliseconds when the domain was last updated.'}, 'enrollment_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Enrollment Mode', 'default': None, 'description': 'Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.'}, 'organization_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization Id', 'default': None, 'description': 'Clerk organization id (org_...) that owns this domain.'}, 'affiliation_email_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Email Address', 'default': None, 'description': 'Affiliation email address for the domain, when set.'}, 'total_pending_invitations': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Invitations', 'default': None, 'description': 'Number of pending invitations associated with this domain.'}, 'total_pending_suggestions': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Pending Suggestions', 'default': None, 'description': 'Number of pending membership suggestions associated with this domain.'}, 'ownership_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ownership Verification Status', 'default': None, 'description': 'DNS ownership verification status (unverified, verified, failed, or expired).'}, 'affiliation_verification_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Affiliation Verification Status', 'default': None, 'description': 'Affiliation verification status (unverified, verified, failed, or expired).'}}, 'additionalProperties': True}}, 'title': 'VerifyClerkOrganizationDomainOwnershipResponse', 'properties': {'domain': {'anyOf': [{'$ref': '#/$defs/VerifyClerkOrganizationDomainOwnershipResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Organization domain summary after ownership verification.'}}, 'additionalProperties': True}
domains.add_dns_host
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.
Esquema de entrada
{'type': 'object', 'title': 'add_dns_hostArguments', 'required': ['domain', 'host_name', 'record_type', 'address'], 'properties': {'ttl': {'type': 'integer', 'title': 'Ttl', 'default': 1800, 'maximum': 60000, 'minimum': 60, 'description': 'TTL in seconds (60 to 60000). Defaults to 1800.'}, 'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name (for example example.com).'}, 'address': {'type': 'string', 'title': 'Address', 'description': 'Record value (IP, hostname, URL, or TXT content depending on type).'}, 'mx_pref': {'anyOf': [{'type': 'integer', 'maximum': 65535, 'minimum': 0}, {'type': 'null'}], 'title': 'Mx Pref', 'default': None, 'description': 'MX preference. Required when record_type is MX or MXE.'}, 'host_name': {'type': 'string', 'title': 'Host Name', 'description': 'Host label to create, for example @, www, or mail.'}, 'record_type': {'type': 'string', 'title': 'Record Type', 'description': 'DNS record type. Supported values: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsAddDnsHostResponseHostsItem': {'type': 'object', 'title': 'DomainsAddDnsHostResponseHostsItem', 'properties': {'ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ttl', 'default': None, 'description': 'TTL in seconds.'}, 'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Record value.'}, 'host_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Id', 'default': None, 'description': 'Namecheap host record id.'}, 'mx_pref': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mx Pref', 'default': None, 'description': 'MX preference when record_type is MX or MXE.'}, 'host_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Name', 'default': None, 'description': 'Host label, for example @ or www.'}, 'record_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Record Type', 'default': None, 'description': 'DNS record type.'}}, 'additionalProperties': True}}, 'title': 'DomainsAddDnsHostResponse', 'properties': {'hosts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsAddDnsHostResponseHostsItem'}}, {'type': 'null'}], 'title': 'Hosts', 'default': None, 'description': 'Full DNS host list after the addition.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Managed domain name.'}, 'is_using_namecheap_dns': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Using Namecheap Dns', 'default': None, 'description': 'Whether the domain currently uses Namecheap DNS.'}}, 'additionalProperties': True}
domains.check_availability
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.
Esquema de entrada
{'type': 'object', 'title': 'check_domain_availabilityArguments', 'required': ['domains'], 'properties': {'domains': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Domains', 'maxItems': 10, 'minItems': 1, 'description': 'Domain names to check (maximum 10).'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsAvailabilityResponse', 'properties': {}, 'additionalProperties': True}
domains.dns_records
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_dns_recordsArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'maxLength': 253, 'description': 'Domain name to look up (for example example.com).'}, 'subdomain': {'anyOf': [{'type': 'string', 'maxLength': 253}, {'type': 'null'}], 'title': 'Subdomain', 'default': None, 'description': 'Optional subdomain label to include (for example www or blog).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsDnsRecordsResponseRecordsItem': {'type': 'object', 'title': 'DomainsDnsRecordsResponseRecordsItem', 'properties': {'ttl': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ttl', 'default': None, 'description': 'Time to live in seconds.'}, 'data': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Data', 'default': None, 'description': 'Record value.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Record host name.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'DNS record type (A, AAAA, CNAME, MX, NS, SOA, TXT, …).'}}, 'additionalProperties': True}}, 'title': 'DomainsDnsRecordsResponse', 'properties': {'records': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsDnsRecordsResponseRecordsItem'}}, {'type': 'null'}], 'title': 'Records', 'default': None, 'description': 'DNS records returned for the domain.'}}, 'additionalProperties': True}
domains.get_dns_hosts
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.
Esquema de entrada
{'type': 'object', 'title': 'get_dns_hostsArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name (for example example.com).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsGetDnsHostsResponseHostsItem': {'type': 'object', 'title': 'DomainsGetDnsHostsResponseHostsItem', 'properties': {'ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ttl', 'default': None, 'description': 'TTL in seconds.'}, 'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Record value.'}, 'host_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Id', 'default': None, 'description': 'Namecheap host record id.'}, 'mx_pref': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mx Pref', 'default': None, 'description': 'MX preference when record_type is MX or MXE.'}, 'host_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Name', 'default': None, 'description': 'Host label, for example @ or www.'}, 'record_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Record Type', 'default': None, 'description': 'DNS record type.'}}, 'additionalProperties': True}}, 'title': 'DomainsGetDnsHostsResponse', 'properties': {'hosts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsGetDnsHostsResponseHostsItem'}}, {'type': 'null'}], 'title': 'Hosts', 'default': None, 'description': 'DNS host records. Each item includes host_id, host_name, record_type, address, optional mx_pref, and optional ttl.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Managed domain name.'}, 'is_using_namecheap_dns': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Using Namecheap Dns', 'default': None, 'description': 'Whether the domain currently uses Namecheap DNS.'}}, 'additionalProperties': True}
domains.get_managed
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.
Esquema de entrada
{'type': 'object', 'title': 'get_managed_domainArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name to look up (for example example.com).'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsGetManagedResponse', 'properties': {'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Managed domain name.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current domain status in Vee3 inventory.'}, 'is_owner': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Owner', 'default': None, 'description': 'Whether this Vee3 account is the domain owner.'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether registrar transfer lock is enabled.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the domain was registered through Vee3.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'Domain expiration timestamp.'}, 'is_premium': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Premium', 'default': None, 'description': 'Whether the domain was registered as a premium name.'}, 'privacy_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Privacy Enabled', 'default': None, 'description': 'Whether WhoisGuard privacy protection is enabled.'}, 'years_registered': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years Registered', 'default': None, 'description': 'Registration term in years at purchase.'}, 'dns_provider_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Dns Provider Type', 'default': None, 'description': 'DNS provider type configured for the domain.'}, 'privacy_expired_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Privacy Expired At', 'default': None, 'description': 'When privacy protection expired, if applicable.'}, 'namecheap_domain_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Namecheap Domain Id', 'default': None, 'description': 'Namecheap domain identifier for the managed domain.'}, 'token_cost_at_registration': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost At Registration', 'default': None, 'description': 'Tokens charged when the domain was registered.'}}, 'additionalProperties': True}
domains.list_managed
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.
Esquema de entrada
{'type': 'object', 'title': 'list_managed_domainsArguments', 'properties': {'page': {'type': 'integer', 'title': 'Page', 'default': 1, 'minimum': 1, 'description': 'Page number for paginated results.'}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 50, 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of domains to return.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsListManagedResponsePaging': {'type': 'object', 'title': 'DomainsListManagedResponsePaging', 'properties': {'page_size': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Page Size', 'default': None, 'description': 'Number of domains returned per page.'}, 'total_items': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Items', 'default': None, 'description': 'Total managed domains matching the query.'}, 'current_page': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Current Page', 'default': None, 'description': 'Current page number.'}}, 'additionalProperties': True}, 'DomainsListManagedResponseDomainsItem': {'type': 'object', 'title': 'DomainsListManagedResponseDomainsItem', 'properties': {'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Managed domain name.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current domain status in Vee3 inventory.'}, 'is_locked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Locked', 'default': None, 'description': 'Whether registrar transfer lock is enabled.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the domain was registered through Vee3.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'Domain expiration timestamp.'}, 'privacy_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Privacy Enabled', 'default': None, 'description': 'Whether WhoisGuard privacy protection is enabled.'}, 'years_registered': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years Registered', 'default': None, 'description': 'Registration term in years at purchase.'}}, 'additionalProperties': True}}, 'title': 'DomainsListManagedResponse', 'properties': {'paging': {'anyOf': [{'$ref': '#/$defs/DomainsListManagedResponsePaging'}, {'type': 'null'}], 'default': None, 'description': 'Pagination metadata for the result set.'}, 'domains': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsListManagedResponseDomainsItem'}}, {'type': 'null'}], 'title': 'Domains', 'default': None, 'description': 'Managed domains for this Vee3 account.'}}, 'additionalProperties': True}
domains.list_tlds
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.
Esquema de entrada
{'type': 'object', 'title': 'list_domain_tldsArguments', 'properties': {'page': {'anyOf': [{'type': 'integer', 'minimum': 1}, {'type': 'null'}], 'title': 'Page', 'default': None, 'description': 'Page number for paginated results.'}, 'limit': {'anyOf': [{'type': 'integer', 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of TLDs to return. Defaults to 100 when omitted.'}, 'search': {'anyOf': [{'type': 'string', 'maxLength': 63}, {'type': 'null'}], 'title': 'Search', 'default': None, 'description': 'Return TLDs whose suffix contains this substring.'}, 'tld_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tld Type', 'default': None, 'description': 'Filter by TLD category: country-code, generic, generic-restricted, infrastructure, or sponsored.'}, 'availability': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Availability', 'default': None, 'description': 'Filter by registration phase: general-availability (normal public registration) or sunrise (early trademark-holder period).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsTldsResponseTldsItem': {'type': 'object', 'title': 'DomainsTldsResponseTldsItem', 'properties': {'tld': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tld', 'default': None, 'description': 'TLD suffix without a leading dot (for example com).'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'TLD category (for example country-code or generic). Null when the upstream registry has not classified the TLD.'}, 'level': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Level', 'default': None, 'description': 'TLD level (1 for standard TLDs).'}, 'changed': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Changed', 'default': None, 'description': 'TLD record last changed timestamp.'}, 'created': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created', 'default': None, 'description': 'TLD delegation created timestamp.'}, 'availability': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Availability', 'default': None, 'description': 'Registration phase for the TLD. Null on unfiltered list results when the upstream registry has not published phase metadata.'}, 'organization': {'anyOf': [{'$ref': '#/$defs/DomainsTldsResponseTldsItemOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Registry operator contact details.'}, 'whois_server': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Whois Server', 'default': None, 'description': 'Authoritative WHOIS server host name.'}, 'domains_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Domains Count', 'default': None, 'description': 'Approximate registered domain count when reported by the registry.'}}, 'additionalProperties': True}, 'DomainsTldsResponseTldsItemOrganization': {'type': 'object', 'title': 'DomainsTldsResponseTldsItemOrganization', 'properties': {'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Registry operator postal address.'}, 'organisation': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organisation', 'default': None, 'description': 'Registry operator name.'}}, 'additionalProperties': True}}, 'title': 'DomainsTldsResponse', 'properties': {'tlds': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsTldsResponseTldsItem'}}, {'type': 'null'}], 'title': 'Tlds', 'default': None, 'description': 'Matching top-level domain records.'}}, 'additionalProperties': True}
domains.lookup
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_lookupArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'description': 'Domain name to look up (for example example.com).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsLookupResponseDates': {'type': 'object', 'title': 'DomainsLookupResponseDates', 'properties': {'expiry': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expiry', 'default': None, 'description': 'Expiration timestamp.'}, 'created': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created', 'default': None, 'description': 'Domain creation timestamp.'}, 'updated': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updated', 'default': None, 'description': 'Last update timestamp.'}}, 'additionalProperties': True}, 'DomainsLookupResponseContacts': {'type': 'object', 'title': 'DomainsLookupResponseContacts', 'properties': {'tech': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseContactsTech'}, {'type': 'null'}], 'default': None, 'description': 'Technical contact details.'}, 'admin': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseContactsAdmin'}, {'type': 'null'}], 'default': None, 'description': 'Administrative contact details.'}, 'billing': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseContactsBilling'}, {'type': 'null'}], 'default': None, 'description': 'Billing contact details.'}, 'registrant': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseContactsRegistrant'}, {'type': 'null'}], 'default': None, 'description': 'Registrant contact details.'}}, 'additionalProperties': True}, 'DomainsLookupResponseRegistrar': {'type': 'object', 'title': 'DomainsLookupResponseRegistrar', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Registrar name.'}, 'ianaId': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ianaid', 'default': None, 'description': 'Registrar IANA identifier.'}}, 'additionalProperties': True}, 'DomainsLookupResponseContactsTech': {'type': 'object', 'title': 'DomainsLookupResponseContactsTech', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Contact name.'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email', 'default': None, 'description': 'Contact email address.'}}, 'additionalProperties': True}, 'DomainsLookupResponseContactsAdmin': {'type': 'object', 'title': 'DomainsLookupResponseContactsAdmin', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Contact name.'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email', 'default': None, 'description': 'Contact email address.'}}, 'additionalProperties': True}, 'DomainsLookupResponseContactsBilling': {'type': 'object', 'title': 'DomainsLookupResponseContactsBilling', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Contact name.'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email', 'default': None, 'description': 'Contact email address.'}}, 'additionalProperties': True}, 'DomainsLookupResponseContactsRegistrant': {'type': 'object', 'title': 'DomainsLookupResponseContactsRegistrant', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Contact name.'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Email', 'default': None, 'description': 'Contact email address.'}, 'organization': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organization', 'default': None, 'description': 'Contact organization.'}}, 'additionalProperties': True}}, 'title': 'DomainsLookupResponse', 'properties': {'tld': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tld', 'default': None, 'description': 'Top-level domain suffix.'}, 'dates': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseDates'}, {'type': 'null'}], 'default': None, 'description': 'Registration lifecycle dates.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Looked-up domain name.'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Source', 'default': None, 'description': 'Primary data source used for the normalized response.'}, 'status': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Normalized EPP status codes.'}, 'keyword': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Keyword', 'default': None, 'description': 'Second-level domain label without the TLD.'}, 'contacts': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseContacts'}, {'type': 'null'}], 'default': None, 'description': 'Registrant, admin, tech, and billing contact records.'}, 'registrar': {'anyOf': [{'$ref': '#/$defs/DomainsLookupResponseRegistrar'}, {'type': 'null'}], 'default': None, 'description': 'Registrar summary data.'}, 'nameservers': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Nameservers', 'default': None, 'description': 'Authoritative nameserver host names.'}, 'availability': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Availability', 'default': None, 'description': 'Availability state (for example registered or available).'}}, 'additionalProperties': True}
domains.metrics
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_metricsArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'maxLength': 253, 'description': 'Domain name to analyze (for example example.com).'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsMetricsResponse', 'properties': {'mozDA': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mozda', 'default': None, 'description': 'Moz domain authority score (0-100).'}, 'mozPA': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mozpa', 'default': None, 'description': 'Moz page authority score (0-100).'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Analyzed domain name.'}, 'ahrefsDR': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrefsdr', 'default': None, 'description': 'Ahrefs domain rating (0-100).'}, 'stumbles': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Stumbles', 'default': None, 'description': 'Total StumbleUpon shares.'}, 'FB_shares': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Fb Shares', 'default': None, 'description': 'Total Facebook shares.'}, 'ahrefsRank': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrefsrank', 'default': None, 'description': 'Global website ranking from Ahrefs.'}, 'majesticCF': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Majesticcf', 'default': None, 'description': 'Majestic citation flow score (0-100).'}, 'majesticTF': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Majestictf', 'default': None, 'description': 'Majestic trust flow score (0-100).'}, 'FB_comments': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Fb Comments', 'default': None, 'description': 'Total Facebook comments.'}, 'last_updated': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Updated', 'default': None, 'description': 'When the metrics snapshot was last updated.'}, 'ahrefsTraffic': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ahrefstraffic', 'default': None, 'description': 'Estimated monthly organic traffic.'}, 'majesticLinks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Majesticlinks', 'default': None, 'description': 'Total links from the Majestic database.'}, 'pinterest_pins': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Pinterest Pins', 'default': None, 'description': 'Total Pinterest saves.'}, 'ahrefsBacklinks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrefsbacklinks', 'default': None, 'description': 'Total number of backlinks from Ahrefs.'}, 'ahrefsRefDomains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrefsrefdomains', 'default': None, 'description': 'Number of unique referring domains from Ahrefs.'}, 'ahrefsTrafficValue': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ahrefstrafficvalue', 'default': None, 'description': 'Estimated value of organic traffic.'}, 'ahrefsOrganicKeywords': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrefsorganickeywords', 'default': None, 'description': 'Number of ranking organic keywords.'}}, 'additionalProperties': True}
domains.rdap
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_rdapArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'maxLength': 253, 'description': 'Domain name to look up (for example example.com).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsRdapResponseSecureDNS': {'type': 'object', 'title': 'DomainsRdapResponseSecureDNS', 'properties': {'delegationSigned': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Delegationsigned', 'default': None, 'description': 'Whether the domain is DNSSEC delegation-signed.'}}, 'additionalProperties': True}, 'DomainsRdapResponseEventsItem': {'type': 'object', 'title': 'DomainsRdapResponseEventsItem', 'properties': {'eventDate': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Eventdate', 'default': None, 'description': 'ISO 8601 event timestamp.'}, 'eventAction': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Eventaction', 'default': None, 'description': 'Event type (for example registration or expiration).'}}, 'additionalProperties': True}, 'DomainsRdapResponseEntitiesItem': {'type': 'object', 'title': 'DomainsRdapResponseEntitiesItem', 'properties': {'objectClassName': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Objectclassname', 'default': None, 'description': 'RDAP entity object class.'}}, 'additionalProperties': True}, 'DomainsRdapResponseNameserversItem': {'type': 'object', 'title': 'DomainsRdapResponseNameserversItem', 'properties': {'ldhName': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ldhname', 'default': None, 'description': 'Nameserver host name.'}}, 'additionalProperties': True}}, 'title': 'DomainsRdapResponse', 'properties': {'events': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsRdapResponseEventsItem'}}, {'type': 'null'}], 'title': 'Events', 'default': None, 'description': 'Registration, expiration, and last-changed timestamps.'}, 'status': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'EPP status codes for the domain.'}, 'ldhName': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Ldhname', 'default': None, 'description': 'Domain name in LDH form.'}, 'entities': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsRdapResponseEntitiesItem'}}, {'type': 'null'}], 'title': 'Entities', 'default': None, 'description': 'Registrar, registrant, and related RDAP entities.'}, 'secureDNS': {'anyOf': [{'$ref': '#/$defs/DomainsRdapResponseSecureDNS'}, {'type': 'null'}], 'default': None, 'description': 'DNSSEC delegation and DS record data.'}, 'nameservers': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsRdapResponseNameserversItem'}}, {'type': 'null'}], 'title': 'Nameservers', 'default': None, 'description': 'Authoritative nameservers for the domain.'}, 'objectClassName': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Objectclassname', 'default': None, 'description': 'RDAP object class (for example domain).'}}, 'additionalProperties': True}
domains.register
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.
Esquema de entrada
{'type': 'object', 'title': 'register_domainArguments', 'required': ['domain', 'expected_token_cost', 'contact'], 'properties': {'years': {'type': 'integer', 'title': 'Years', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Registration term in years.'}, 'domain': {'type': 'string', 'title': 'Domain', 'description': 'Domain name to register (for example example.com).'}, 'contact': {'type': 'object', 'title': 'Contact', 'description': 'Registrant contact used for Registrant, Admin, Tech, and AuxBilling roles. Object with first_name, last_name, address1, city, state_province, postal_code, country (two-letter code), phone (format +NNN.NNNNNNNNNN), and email_address (a real inbox the registrant can access; the registrar may send a verification email that must be completed). Optional fields: address2 and organization_name.', 'additionalProperties': True}, 'enable_privacy': {'type': 'boolean', 'title': 'Enable Privacy', 'default': True, 'description': 'Whether to enable free WhoisGuard privacy protection when available.'}, 'expected_token_cost': {'type': 'integer', 'title': 'Expected Token Cost', 'description': 'Token cost from a fresh domains.registration_quote response. Required to prevent surprise charges.'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsRegisterResponse', 'properties': {'years': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years', 'default': None, 'description': 'Registration term in years.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Registered domain name.'}, 'order_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order Id', 'default': None, 'description': 'Namecheap order identifier for the registration purchase.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'Domain expiration timestamp when known.'}, 'registered': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Registered', 'default': None, 'description': 'Whether registration completed successfully.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Tokens charged for this registration (200 service tokens plus the domain price in tokens).'}, 'privacy_enabled': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Privacy Enabled', 'default': None, 'description': 'Whether WhoisGuard privacy protection is enabled.'}, 'namecheap_domain_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Namecheap Domain Id', 'default': None, 'description': 'Namecheap domain identifier for the managed domain.'}}, 'additionalProperties': True}
domains.registration_quote
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_registration_quoteArguments', 'required': ['domain'], 'properties': {'years': {'type': 'integer', 'title': 'Years', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Registration term in years.'}, 'domain': {'type': 'string', 'title': 'Domain', 'description': 'Domain name to quote (for example example.com).'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsRegistrationQuoteResponse', 'properties': {'years': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years', 'default': None, 'description': 'Registration term in years.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Quoted domain name.'}, 'available': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Available', 'default': None, 'description': 'Whether the domain can be registered through Vee3.'}, 'is_premium': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Premium', 'default': None, 'description': 'Whether the domain is priced as a premium name.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Token cost to register this domain for the quoted term on the account billing plan (200 service tokens plus the domain price).'}, 'unavailable_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Unavailable Reason', 'default': None, 'description': 'Reason the domain cannot be registered, when available is false.'}}, 'additionalProperties': True}
domains.remove_dns_host
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.
Esquema de entrada
{'type': 'object', 'title': 'remove_dns_hostArguments', 'required': ['domain', 'host_id'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name (for example example.com).'}, 'host_id': {'type': 'string', 'title': 'Host Id', 'description': 'Host record id from domains.get_dns_hosts.'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsRemoveDnsHostResponseHostsItem': {'type': 'object', 'title': 'DomainsRemoveDnsHostResponseHostsItem', 'properties': {'ttl': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ttl', 'default': None, 'description': 'TTL in seconds.'}, 'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Record value.'}, 'host_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Id', 'default': None, 'description': 'Namecheap host record id.'}, 'mx_pref': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mx Pref', 'default': None, 'description': 'MX preference when record_type is MX or MXE.'}, 'host_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Host Name', 'default': None, 'description': 'Host label, for example @ or www.'}, 'record_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Record Type', 'default': None, 'description': 'DNS record type.'}}, 'additionalProperties': True}}, 'title': 'DomainsRemoveDnsHostResponse', 'properties': {'hosts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsRemoveDnsHostResponseHostsItem'}}, {'type': 'null'}], 'title': 'Hosts', 'default': None, 'description': 'Full DNS host list after the removal.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Managed domain name.'}, 'is_using_namecheap_dns': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Using Namecheap Dns', 'default': None, 'description': 'Whether the domain currently uses Namecheap DNS.'}}, 'additionalProperties': True}
domains.renew
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.
Esquema de entrada
{'type': 'object', 'title': 'renew_domainArguments', 'required': ['domain', 'expected_token_cost'], 'properties': {'years': {'type': 'integer', 'title': 'Years', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Renewal term in years. Premium domains support 1 year only.'}, 'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name to renew (for example example.com).'}, 'expected_token_cost': {'type': 'integer', 'title': 'Expected Token Cost', 'description': 'Token cost from a fresh domains.renewal_quote response. Required to prevent surprise charges.'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsRenewResponse', 'properties': {'years': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years', 'default': None, 'description': 'Renewal term in years.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Renewed domain name.'}, 'renewed': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Renewed', 'default': None, 'description': 'Whether renewal completed successfully.'}, 'order_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Order Id', 'default': None, 'description': 'Namecheap order identifier for the renewal purchase.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'Updated domain expiration timestamp when known.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Tokens charged for this renewal (100 service tokens plus the domain renewal price in tokens).'}, 'namecheap_domain_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Namecheap Domain Id', 'default': None, 'description': 'Namecheap domain identifier for the managed domain.'}}, 'additionalProperties': True}
domains.renewal_quote
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_renewal_quoteArguments', 'required': ['domain'], 'properties': {'years': {'type': 'integer', 'title': 'Years', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Renewal term in years. Premium domains support 1 year only.'}, 'domain': {'type': 'string', 'title': 'Domain', 'description': 'Managed domain name to quote for renewal (for example example.com).'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsRenewalQuoteResponse', 'properties': {'years': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Years', 'default': None, 'description': 'Renewal term in years.'}, 'domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain', 'default': None, 'description': 'Quoted domain name.'}, 'available': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Available', 'default': None, 'description': 'Whether the domain can be renewed through Vee3 for the quoted term.'}, 'is_premium': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Premium', 'default': None, 'description': 'Whether the domain is priced as a premium name.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Token cost to renew this domain for the quoted term on the account billing plan (100 service tokens plus the domain price).'}, 'unavailable_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Unavailable Reason', 'default': None, 'description': 'Reason the domain cannot be renewed, when available is false.'}}, 'additionalProperties': True}
domains.tld_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_tld_detailsArguments', 'required': ['tld'], 'properties': {'tld': {'type': 'string', 'title': 'Tld', 'maxLength': 63, 'description': 'TLD suffix to look up without a leading dot (for example io).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DomainsTldDetailsResponseContactsItem': {'type': 'object', 'title': 'DomainsTldDetailsResponseContactsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Contact name.'}, 'phone': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone', 'default': None, 'description': 'Contact phone number.'}, 'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Contact postal address.'}, 'contact': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Contact', 'default': None, 'description': 'Contact role (for example administrative or technical).'}, 'organisation': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organisation', 'default': None, 'description': 'Contact organization name.'}}, 'additionalProperties': True}, 'DomainsTldDetailsResponseOrganization': {'type': 'object', 'title': 'DomainsTldDetailsResponseOrganization', 'properties': {'address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Address', 'default': None, 'description': 'Registry operator postal address.'}, 'organisation': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Organisation', 'default': None, 'description': 'Registry operator name.'}}, 'additionalProperties': True}}, 'title': 'DomainsTldDetailsResponse', 'properties': {'tld': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tld', 'default': None, 'description': 'TLD suffix without a leading dot.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'TLD category (for example country-code or generic).'}, 'level': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Level', 'default': None, 'description': 'TLD level (1 for standard TLDs).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Delegation status (for example ACTIVE).'}, 'changed': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Changed', 'default': None, 'description': 'TLD record last changed timestamp.'}, 'created': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created', 'default': None, 'description': 'TLD delegation created timestamp.'}, 'remarks': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Remarks', 'default': None, 'description': 'Additional registry notes or links.'}, 'contacts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DomainsTldDetailsResponseContactsItem'}}, {'type': 'null'}], 'title': 'Contacts', 'default': None, 'description': 'Registry contact records.'}, 'rdap_server': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rdap Server', 'default': None, 'description': 'Authoritative RDAP server URL.'}, 'availability': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Availability', 'default': None, 'description': 'Registration phase for the TLD.'}, 'organization': {'anyOf': [{'$ref': '#/$defs/DomainsTldDetailsResponseOrganization'}, {'type': 'null'}], 'default': None, 'description': 'Registry operator contact details.'}, 'registry_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Registry Url', 'default': None, 'description': 'Registry web site URL.'}, 'whois_server': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Whois Server', 'default': None, 'description': 'Authoritative WHOIS server host name.'}, 'domains_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Domains Count', 'default': None, 'description': 'Approximate registered domain count when reported by the registry.'}}, 'additionalProperties': True}
domains.whois
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.
Esquema de entrada
{'type': 'object', 'title': 'get_domain_whoisArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain', 'description': 'Domain name to look up (for example example.com).'}, 'include_registrar': {'type': 'boolean', 'title': 'Include Registrar', 'default': False, 'description': 'When true, query registry and registrar WHOIS servers for more complete data. When false (default), query the registry server only.'}}}
Esquema de salida
{'type': 'object', 'title': 'DomainsWhoisResponse', 'properties': {}, 'additionalProperties': True}
files.delete_file
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_fileArguments', 'required': ['file_name'], 'properties': {'file_name': {'type': 'string', 'title': 'File Name', 'maxLength': 255, 'description': 'Relative file name or path to delete. Use files.list_uploaded_files to see available names.'}}}
Esquema de salida
{'type': 'object', 'title': 'DeleteFileResponse', 'properties': {'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Deleted file name.'}}, 'additionalProperties': True}
files.download_file
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.
Esquema de entrada
{'type': 'object', 'title': 'download_fileArguments', 'required': ['file_name'], 'properties': {'file_name': {'type': 'string', 'title': 'File Name', 'maxLength': 255, 'description': 'Relative file name or path to download. Use files.list_uploaded_files to see available names.'}}}
Esquema de salida
{'type': 'object', 'title': 'DownloadFileResponse', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Stored file name.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Size Bytes', 'default': None, 'description': 'Object size in bytes when known.'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved download.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type on the stored object when known.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/get-file CLI.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}}, 'additionalProperties': True}
files.extend_file
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.
Esquema de entrada
{'type': 'object', 'title': 'extend_fileArguments', 'required': ['file_name', 'additional_retention_days'], 'properties': {'file_name': {'type': 'string', 'title': 'File Name', 'maxLength': 255, 'description': 'Relative file name or path to extend. Use files.list_uploaded_files and choose a file that includes retained_until.'}, 'additional_retention_days': {'type': 'integer', 'title': 'Additional Retention Days', 'maximum': 90, 'minimum': 1, 'description': "Days to add to the file's retention schedule."}}}
Esquema de salida
{'type': 'object', 'title': 'ExtendFileResponse', 'properties': {'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Extended file name.'}, 'size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Size Bytes', 'default': None, 'description': 'File size in bytes used for billing.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Tokens billed for this extension.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when the file is now scheduled to be removed.'}, 'additional_retention_days': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Additional Retention Days', 'default': None, 'description': 'Days added in this request.'}}, 'additionalProperties': True}
files.list_uploaded_files
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.
Esquema de entrada
{'type': 'object', 'title': 'list_uploaded_filesArguments', 'properties': {'folder': {'anyOf': [{'type': 'string', 'maxLength': 200}, {'type': 'null'}], 'title': 'Folder', 'default': None, 'description': "Optional folder path (for example media/clips). When set, only files under that folder (including nested subfolders) are returned. Do not use '..' or absolute paths."}}}
Esquema de salida
{'type': 'object', '$defs': {'ListUploadedFilesResponseFilesItem': {'type': 'object', 'title': 'ListUploadedFilesResponseFilesItem', 'properties': {'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Stored file name, including folders when used (for example media/clips/launch-video.mp4).'}, 'upload_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Upload Id', 'default': None, 'description': 'Upload session identifier when Vee3 can match this file to a prior files.upload_file reservation.'}, 'size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Size Bytes', 'default': None, 'description': 'File size in bytes.'}, 'uploaded_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Uploaded At', 'default': None, 'description': 'ISO 8601 timestamp when the file was uploaded.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type of the file.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when the file is scheduled to be removed. Present when Vee3 matched the file to a completed upload session.'}}, 'additionalProperties': True}}, 'title': 'ListUploadedFilesResponse', 'properties': {'files': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListUploadedFilesResponseFilesItem'}}, {'type': 'null'}], 'title': 'Files', 'default': None, 'description': 'Files currently stored for the authenticated account, newest first.'}}, 'additionalProperties': True}
files.move_file
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.
Esquema de entrada
{'type': 'object', 'title': 'move_fileArguments', 'required': ['source_file_name', 'destination_file_name'], 'properties': {'source_file_name': {'type': 'string', 'title': 'Source File Name', 'maxLength': 255, 'description': 'Current relative file name or path. Use files.list_uploaded_files to see available names.'}, 'destination_file_name': {'type': 'string', 'title': 'Destination File Name', 'maxLength': 255, 'description': 'New relative file name or path. Must not already exist in account storage.'}}}
Esquema de salida
{'type': 'object', 'title': 'MoveFileResponse', 'properties': {'source_file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Source File Name', 'default': None, 'description': 'Previous file name.'}, 'destination_file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Destination File Name', 'default': None, 'description': 'New file name after the move.'}}, 'additionalProperties': True}
files.upload_file
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.
Esquema de entrada
{'type': 'object', 'title': 'upload_fileArguments', 'required': ['file_name'], 'properties': {'file_name': {'type': 'string', 'title': 'File Name', 'maxLength': 255, 'description': "Desired file name or path for the uploaded file. Use folder/subfolder/.../file_name to organize files in folders. Extension is optional and is replaced based on detected file type. Do not use '..' or absolute paths."}, 'existing_files': {'anyOf': [{'enum': ['stop', 'continue', 'replace'], 'type': 'string'}, {'type': 'null'}], 'title': 'Existing Files', 'default': 'stop', 'description': "What to do when a stored file already uses the same name. 'stop' (default) fails on the first duplicate. 'continue' skips duplicates and keeps uploading remaining files. 'replace' overwrites duplicated stored files."}, 'retention_days': {'anyOf': [{'type': 'integer', 'maximum': 90, 'minimum': 1}, {'type': 'null'}], 'title': 'Retention Days', 'default': 7, 'description': 'How many days to keep the file after upload completes. Default 7. Billing uses size and this retention.'}}}
Esquema de salida
{'type': 'object', 'title': 'UploadFileResponse', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for uploading the local file or folder.'}, 'max_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Bytes', 'default': None, 'description': 'Maximum allowed file size in bytes.'}, 'upload_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Upload Id', 'default': None, 'description': 'Stable identifier for the reserved upload.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the upload code can no longer be resolved (60 minutes after reserve).'}, 'upload_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Upload Code', 'default': None, 'description': 'Short code to pass to the @vee3/upload CLI.'}, 'existing_files': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Existing Files', 'default': None, 'description': 'Policy for files that already exist: stop, continue, or replace.'}, 'retention_days': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retention Days', 'default': None, 'description': 'Days the file will be retained after upload completes.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or uploading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}}, 'additionalProperties': True}
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 parameter on place detail, review, and photo calls. Cost = 1 token.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_languagesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsLanguagesResponseLanguages': {'type': 'object', 'title': 'GoogleMapsLanguagesResponseLanguages', 'properties': {}, 'additionalProperties': True}}, 'title': 'GoogleMapsLanguagesResponse', 'properties': {'languages': {'anyOf': [{'$ref': '#/$defs/GoogleMapsLanguagesResponseLanguages'}, {'type': 'null'}], 'default': None, 'description': 'Map of language names to language codes for Google Maps place endpoints (for example English: en).'}}, 'additionalProperties': True}
google-maps.nearby_search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_google_maps_nearbyArguments', 'required': ['location'], 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursor_next on a previous response.'}, 'radius': {'anyOf': [{'type': 'integer', 'maximum': 50000, 'minimum': 1}, {'type': 'null'}], 'title': 'Radius', 'default': None, 'description': 'Search radius in meters (default 1000).'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.'}, 'keyword': {'anyOf': [{'type': 'string', 'maxLength': 256}, {'type': 'null'}], 'title': 'Keyword', 'default': None, 'description': 'Keyword to match nearby places (for example restaurant).'}, 'sort_by': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Sort By', 'default': None, 'description': 'Result ordering: "Relevance" (default) or "Distance".'}, 'language': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Language', 'default': None, 'description': 'Language code for results (for example en).'}, 'location': {'type': 'string', 'title': 'Location', 'maxLength': 64, 'description': 'Latitude and longitude of the search point (for example 40,-110).'}, 'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'When true, return only places open for business at query time.'}, 'max_price': {'anyOf': [{'type': 'integer', 'maximum': 4, 'minimum': 0}, {'type': 'null'}], 'title': 'Max Price', 'default': None, 'description': 'Maximum price level (0–4, inclusive).'}, 'min_price': {'anyOf': [{'type': 'integer', 'maximum': 4, 'minimum': 0}, {'type': 'null'}], 'title': 'Min Price', 'default': None, 'description': 'Minimum price level (0–4, inclusive).'}, 'place_type': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Place Type', 'default': None, 'description': 'Restrict results to a single Google Maps place type (for example restaurant).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsNearbySearchResponsePlacesItem': {'type': 'object', 'title': 'GoogleMapsNearbySearchResponsePlacesItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Place display name.'}, 'hours': {'anyOf': [{'$ref': '#/$defs/GoogleMapsNearbySearchResponsePlacesItemHours'}, {'type': 'null'}], 'default': None, 'description': 'Opening hours when available.'}, 'types': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Types', 'default': None, 'description': 'Place type labels when available.'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Average user rating when available.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Human-readable open/closed status when available.'}, 'location': {'anyOf': [{'$ref': '#/$defs/GoogleMapsNearbySearchResponsePlacesItemLocation'}, {'type': 'null'}], 'default': None, 'description': 'Place coordinates when available.'}, 'place_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Place Id', 'default': None, 'description': 'Google Maps place identifier.'}, 'full_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Full Address', 'default': None, 'description': 'Full formatted address when available.'}, 'business_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Business Status', 'default': None, 'description': 'Operational status when available.'}}, 'additionalProperties': True}, 'GoogleMapsNearbySearchResponsePlacesItemHours': {'type': 'object', 'title': 'GoogleMapsNearbySearchResponsePlacesItemHours', 'properties': {'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'Whether the place is open now when only open_now is available.'}}, 'additionalProperties': True}, 'GoogleMapsNearbySearchResponsePlacesItemLocation': {'type': 'object', 'title': 'GoogleMapsNearbySearchResponsePlacesItemLocation', 'properties': {'latitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Latitude', 'default': None, 'description': 'Place latitude.'}, 'longitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Longitude', 'default': None, 'description': 'Place longitude.'}}, 'additionalProperties': True}}, 'title': 'GoogleMapsNearbySearchResponse', 'properties': {'places': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleMapsNearbySearchResponsePlacesItem'}}, {'type': 'null'}], 'title': 'Places', 'default': None, 'description': 'Nearby places matching the search criteria. Additional upstream fields may appear.'}, 'cursor_next': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Next', 'default': None, 'description': 'Cursor for the next page when more results are available.'}, 'cursor_previous': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Previous', 'default': None, 'description': 'Cursor for the previous page when available.'}}, 'additionalProperties': True}
google-maps.place_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_place_detailsArguments', 'required': ['place_id'], 'properties': {'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.'}, 'language': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Language', 'default': None, 'description': 'Language code for results (for example en).'}, 'place_id': {'type': 'string', 'title': 'Place Id', 'maxLength': 256, 'description': 'Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsPlaceDetailsResponseHours': {'type': 'object', 'title': 'GoogleMapsPlaceDetailsResponseHours', 'properties': {'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'Whether the place is open now when only open_now is available.'}}, 'additionalProperties': True}, 'GoogleMapsPlaceDetailsResponseLocation': {'type': 'object', 'title': 'GoogleMapsPlaceDetailsResponseLocation', 'properties': {'latitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Latitude', 'default': None, 'description': 'Place latitude.'}, 'longitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Longitude', 'default': None, 'description': 'Place longitude.'}}, 'additionalProperties': True}}, 'title': 'GoogleMapsPlaceDetailsResponse', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Place display name.'}, 'hours': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlaceDetailsResponseHours'}, {'type': 'null'}], 'default': None, 'description': 'Opening hours when available.'}, 'types': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Types', 'default': None, 'description': 'Place type labels when available.'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Average user rating when available.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Human-readable open/closed status when available.'}, 'website': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Website', 'default': None, 'description': 'Place website when available.'}, 'location': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlaceDetailsResponseLocation'}, {'type': 'null'}], 'default': None, 'description': 'Place coordinates when available.'}, 'full_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Full Address', 'default': None, 'description': 'Full formatted address when available.'}, 'phone_number': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phone Number', 'default': None, 'description': 'Place phone number when available.'}, 'review_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Review Count', 'default': None, 'description': 'Total number of reviews when available.'}}, 'additionalProperties': True}
google-maps.place_photos
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_place_photosArguments', 'required': ['place_id'], 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursor_next on a previous response.'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.'}, 'language': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Language', 'default': None, 'description': 'Language code for results (for example en).'}, 'place_id': {'type': 'string', 'title': 'Place Id', 'maxLength': 256, 'description': 'Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsPlacePhotosResponsePlace': {'type': 'object', 'title': 'GoogleMapsPlacePhotosResponsePlace', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Place display name.'}, 'hours': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlacePhotosResponsePlaceHours'}, {'type': 'null'}], 'default': None, 'description': 'Opening hours when available.'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Average user rating when available.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Human-readable open/closed status when available.'}, 'location': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlacePhotosResponsePlaceLocation'}, {'type': 'null'}], 'default': None, 'description': 'Place coordinates when available.'}, 'full_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Full Address', 'default': None, 'description': 'Full formatted address when available.'}, 'review_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Review Count', 'default': None, 'description': 'Total number of reviews when available.'}}, 'additionalProperties': True}, 'GoogleMapsPlacePhotosResponsePhotosItem': {'type': 'object', 'title': 'GoogleMapsPlacePhotosResponsePhotosItem', 'properties': {'photo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Photo Url', 'default': None, 'description': 'Photo URL.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Photo description when available.'}}, 'additionalProperties': True}, 'GoogleMapsPlacePhotosResponsePlaceHours': {'type': 'object', 'title': 'GoogleMapsPlacePhotosResponsePlaceHours', 'properties': {'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'Whether the place is open now when only open_now is available.'}}, 'additionalProperties': True}, 'GoogleMapsPlacePhotosResponsePlaceLocation': {'type': 'object', 'title': 'GoogleMapsPlacePhotosResponsePlaceLocation', 'properties': {'latitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Latitude', 'default': None, 'description': 'Place latitude.'}, 'longitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Longitude', 'default': None, 'description': 'Place longitude.'}}, 'additionalProperties': True}}, 'title': 'GoogleMapsPlacePhotosResponse', 'properties': {'place': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlacePhotosResponsePlace'}, {'type': 'null'}], 'default': None, 'description': 'Place metadata for the photo listing.'}, 'photos': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleMapsPlacePhotosResponsePhotosItem'}}, {'type': 'null'}], 'title': 'Photos', 'default': None, 'description': 'Place photos.'}, 'cursor_next': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Next', 'default': None, 'description': 'Cursor for the next page when more results are available.'}}, 'additionalProperties': True}
google-maps.place_reviews
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_place_reviewsArguments', 'required': ['place_id'], 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursor_next on a previous response.'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.'}, 'sort_by': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Sort By', 'default': None, 'description': 'Review sort order: "Relevant" (default), "Lowest", "Highest", or "Newest".'}, 'language': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Language', 'default': None, 'description': 'Language code for results (for example en).'}, 'place_id': {'type': 'string', 'title': 'Place Id', 'maxLength': 256, 'description': 'Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsPlaceReviewsResponsePlace': {'type': 'object', 'title': 'GoogleMapsPlaceReviewsResponsePlace', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Place display name.'}, 'hours': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlaceReviewsResponsePlaceHours'}, {'type': 'null'}], 'default': None, 'description': 'Opening hours when available.'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Average user rating when available.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Human-readable open/closed status when available.'}, 'location': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlaceReviewsResponsePlaceLocation'}, {'type': 'null'}], 'default': None, 'description': 'Place coordinates when available.'}, 'full_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Full Address', 'default': None, 'description': 'Full formatted address when available.'}, 'review_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Review Count', 'default': None, 'description': 'Total number of reviews when available.'}}, 'additionalProperties': True}, 'GoogleMapsPlaceReviewsResponsePlaceHours': {'type': 'object', 'title': 'GoogleMapsPlaceReviewsResponsePlaceHours', 'properties': {'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'Whether the place is open now when only open_now is available.'}}, 'additionalProperties': True}, 'GoogleMapsPlaceReviewsResponseReviewsItem': {'type': 'object', 'title': 'GoogleMapsPlaceReviewsResponseReviewsItem', 'properties': {'rating': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Star rating for the review.'}, 'review_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Review Id', 'default': None, 'description': 'Review identifier.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'Reviewer display name when available.'}, 'review_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Review Text', 'default': None, 'description': 'Review body text.'}}, 'additionalProperties': True}, 'GoogleMapsPlaceReviewsResponsePlaceLocation': {'type': 'object', 'title': 'GoogleMapsPlaceReviewsResponsePlaceLocation', 'properties': {'latitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Latitude', 'default': None, 'description': 'Place latitude.'}, 'longitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Longitude', 'default': None, 'description': 'Place longitude.'}}, 'additionalProperties': True}}, 'title': 'GoogleMapsPlaceReviewsResponse', 'properties': {'place': {'anyOf': [{'$ref': '#/$defs/GoogleMapsPlaceReviewsResponsePlace'}, {'type': 'null'}], 'default': None, 'description': 'Place metadata for the reviewed location.'}, 'reviews': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleMapsPlaceReviewsResponseReviewsItem'}}, {'type': 'null'}], 'title': 'Reviews', 'default': None, 'description': 'Place reviews.'}, 'cursor_next': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Next', 'default': None, 'description': 'Cursor for the next page when more results are available.'}}, 'additionalProperties': True}
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_search. Cost = 1 token.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_place_typesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', 'title': 'GoogleMapsPlaceTypesResponse', 'properties': {'place_types': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Place Types', 'default': None, 'description': 'Supported Google Maps place type string values.'}}, 'additionalProperties': True}
google-maps.review_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_maps_review_detailsArguments', 'required': ['review_id'], 'properties': {'review_id': {'type': 'string', 'title': 'Review Id', 'maxLength': 512, 'description': 'Google Maps review identifier.'}}}
Esquema de salida
{'type': 'object', 'title': 'GoogleMapsReviewDetailsResponse', 'properties': {'rating': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Star rating for the review.'}, 'review_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Review Id', 'default': None, 'description': 'Review identifier.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'Reviewer display name when available.'}, 'review_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Review Text', 'default': None, 'description': 'Review body text.'}}, 'additionalProperties': True}
google-maps.search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_google_mapsArguments', 'required': ['query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search query for places (for example restaurants in Paris).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursor_next on a previous response.'}, 'radius': {'anyOf': [{'type': 'integer', 'maximum': 50000, 'minimum': 1}, {'type': 'null'}], 'title': 'Radius', 'default': None, 'description': 'Search radius in meters (default 1000).'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.'}, 'language': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Language', 'default': None, 'description': 'Language code for results (for example en).'}, 'location': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Location', 'default': None, 'description': 'Optional latitude and longitude bias point (for example 40,-110). A location embedded in the query may override this.'}, 'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'When true, return only places open for business at query time.'}, 'max_price': {'anyOf': [{'type': 'integer', 'maximum': 4, 'minimum': 0}, {'type': 'null'}], 'title': 'Max Price', 'default': None, 'description': 'Maximum price level (0–4, inclusive).'}, 'min_price': {'anyOf': [{'type': 'integer', 'maximum': 4, 'minimum': 0}, {'type': 'null'}], 'title': 'Min Price', 'default': None, 'description': 'Minimum price level (0–4, inclusive).'}, 'place_type': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Place Type', 'default': None, 'description': 'Restrict results to a single Google Maps place type (for example restaurant).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleMapsSearchResponsePlacesItem': {'type': 'object', 'title': 'GoogleMapsSearchResponsePlacesItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Place display name.'}, 'hours': {'anyOf': [{'$ref': '#/$defs/GoogleMapsSearchResponsePlacesItemHours'}, {'type': 'null'}], 'default': None, 'description': 'Opening hours when available.'}, 'types': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Types', 'default': None, 'description': 'Place type labels when available.'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Rating', 'default': None, 'description': 'Average user rating when available.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Human-readable open/closed status when available.'}, 'location': {'anyOf': [{'$ref': '#/$defs/GoogleMapsSearchResponsePlacesItemLocation'}, {'type': 'null'}], 'default': None, 'description': 'Place coordinates when available.'}, 'place_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Place Id', 'default': None, 'description': 'Google Maps place identifier.'}, 'full_address': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Full Address', 'default': None, 'description': 'Full formatted address when available.'}, 'business_status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Business Status', 'default': None, 'description': 'Operational status when available.'}}, 'additionalProperties': True}, 'GoogleMapsSearchResponsePlacesItemHours': {'type': 'object', 'title': 'GoogleMapsSearchResponsePlacesItemHours', 'properties': {'open_now': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Open Now', 'default': None, 'description': 'Whether the place is open now when only open_now is available.'}}, 'additionalProperties': True}, 'GoogleMapsSearchResponsePlacesItemLocation': {'type': 'object', 'title': 'GoogleMapsSearchResponsePlacesItemLocation', 'properties': {'latitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Latitude', 'default': None, 'description': 'Place latitude.'}, 'longitude': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Longitude', 'default': None, 'description': 'Place longitude.'}}, 'additionalProperties': True}}, 'title': 'GoogleMapsSearchResponse', 'properties': {'places': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleMapsSearchResponsePlacesItem'}}, {'type': 'null'}], 'title': 'Places', 'default': None, 'description': 'Matching places from the text search. Additional upstream fields may appear.'}, 'cursor_next': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Next', 'default': None, 'description': 'Cursor for the next page when more results are available.'}, 'cursor_previous': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor Previous', 'default': None, 'description': 'Cursor for the previous page when available.'}}, 'additionalProperties': True}
google-search.autocomplete
Get Google Search autocomplete suggestions for a partial query. Returns the normalized query and an array of suggested search phrases. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_google_search_autocompleteArguments', 'required': ['query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Partial search keywords or phrase.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleSearchAutocompleteResponseSuggestionsItem': {'type': 'object', 'title': 'GoogleSearchAutocompleteResponseSuggestionsItem', 'properties': {'phrase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Phrase', 'default': None, 'description': 'Single autocomplete suggestion phrase.'}}, 'additionalProperties': True}}, 'title': 'GoogleSearchAutocompleteResponse', 'properties': {'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Normalized query echoed from the request.'}, 'suggestions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleSearchAutocompleteResponseSuggestionsItem'}}, {'type': 'null'}], 'title': 'Suggestions', 'default': None, 'description': 'Suggested search phrases for the query.'}}, 'additionalProperties': True}
google-search-console.add_site
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.
Esquema de entrada
{'type': 'object', 'title': 'add_google_search_console_siteArguments', 'required': ['site_url'], 'properties': {'site_url': {'type': 'string', 'title': 'Site Url', 'description': 'Domain or property to add. The user or agent passes a hostname (example.com), a domain property (sc-domain:example.com), or a URL (https://example.com/).'}}}
Esquema de salida
{'type': 'object', 'title': 'AddGoogleSearchConsoleSiteResponse', 'properties': {'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'added, already_added, pending_verification (wait and retry), or needs_verification (create the DNS record in this response, then retry).'}, 'message': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Message', 'default': None, 'description': 'What happened and what the user or agent should do next.'}, 'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Normalized Search Console domain property URL.'}, 'dns_token': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Dns Token', 'default': None, 'description': 'DNS record value to create when status is needs_verification.'}, 'is_managed': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Managed', 'default': None, 'description': 'True when the domain is a Vee3-managed domain for this account.'}, 'domain_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Domain Name', 'default': None, 'description': 'Normalized domain name for the property.'}, 'dns_host_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Dns Host Name', 'default': None, 'description': 'DNS host to create when status is needs_verification. @ for TXT, or the Google CNAME host for domain properties that cannot use an apex TXT record.'}, 'dns_record_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Dns Record Type', 'default': None, 'description': 'DNS record type to create when status is needs_verification. TXT or CNAME.'}}, 'additionalProperties': True}
google-search-console.delete_sitemap
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_google_search_console_sitemapArguments', 'required': ['feed_path'], 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'feed_path': {'type': 'string', 'title': 'Feed Path', 'description': 'Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.'}}}
Esquema de salida
{'type': 'object', 'title': 'DeleteGoogleSearchConsoleSitemapResponse', 'properties': {'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'True when Search Console accepted the sitemap deletion.'}, 'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Search Console property URL used for the request.'}, 'feed_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Feed Path', 'default': None, 'description': 'Sitemap URL that was removed from Search Console.'}}, 'additionalProperties': True}
google-search-console.get_site
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_search_console_siteArguments', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}}}
Esquema de salida
{'type': 'object', 'title': 'GetGoogleSearchConsoleSiteResponse', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Property URL.'}, 'permission_level': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Permission Level', 'default': None, 'description': 'Access level for this property.'}}, 'additionalProperties': True}
google-search-console.get_sitemap
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_search_console_sitemapArguments', 'required': ['feed_path'], 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'feed_path': {'type': 'string', 'title': 'Feed Path', 'description': 'Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetGoogleSearchConsoleSitemapResponseSitemap': {'type': 'object', 'title': 'GetGoogleSearchConsoleSitemapResponseSitemap', 'properties': {'path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Path', 'default': None, 'description': 'Full sitemap URL path for the property.'}, 'errors': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Errors', 'default': None, 'description': 'Error count reported for the sitemap.'}, 'contents': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetGoogleSearchConsoleSitemapResponseSitemapContentsItem'}}, {'type': 'null'}], 'title': 'Contents', 'default': None, 'description': 'Per-content-type submitted and indexed counts.'}, 'warnings': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Warnings', 'default': None, 'description': 'Warning count reported for the sitemap.'}, 'is_pending': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Pending', 'default': None, 'description': 'Whether Search Console is still processing the sitemap.'}, 'sitemap_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sitemap Type', 'default': None, 'description': 'Sitemap type reported by Search Console.'}, 'last_submitted': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Submitted', 'default': None, 'description': 'Timestamp when the sitemap was last submitted.'}, 'last_downloaded': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Downloaded', 'default': None, 'description': 'Timestamp when Google last downloaded the sitemap.'}, 'is_sitemaps_index': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Sitemaps Index', 'default': None, 'description': 'Whether this entry is a sitemap index.'}}, 'additionalProperties': True}, 'GetGoogleSearchConsoleSitemapResponseSitemapContentsItem': {'type': 'object', 'title': 'GetGoogleSearchConsoleSitemapResponseSitemapContentsItem', 'properties': {'indexed': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Indexed', 'default': None, 'description': 'Number of indexed URLs of this content type, when available.'}, 'submitted': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Submitted', 'default': None, 'description': 'Number of submitted URLs of this content type, when available.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'Sitemap content type reported by Search Console.'}}, 'additionalProperties': True}}, 'title': 'GetGoogleSearchConsoleSitemapResponse', 'properties': {'sitemap': {'anyOf': [{'$ref': '#/$defs/GetGoogleSearchConsoleSitemapResponseSitemap'}, {'type': 'null'}], 'default': None, 'description': 'Sitemap details for the requested feed_path.'}, 'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Search Console property URL used for the request.'}}, 'additionalProperties': True}
google-search-console.inspect_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 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.
Esquema de entrada
{'type': 'object', 'title': 'inspect_google_search_console_urlArguments', 'required': ['inspection_url'], 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'language_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Language Code', 'default': None, 'description': 'Optional BCP-47 language code for localized inspection results.'}, 'inspection_url': {'type': 'string', 'title': 'Inspection Url', 'description': 'Fully qualified URL to inspect within the selected property.'}}}
Esquema de salida
{'type': 'object', '$defs': {'InspectGoogleSearchConsoleUrlResponseIndexStatusResult': {'type': 'object', 'title': 'InspectGoogleSearchConsoleUrlResponseIndexStatusResult', 'properties': {'verdict': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verdict', 'default': None, 'description': 'Overall indexing verdict for the inspected URL.'}, 'crawled_as': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Crawled As', 'default': None, 'description': 'User agent type used for the most recent crawl.'}, 'coverage_state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Coverage State', 'default': None, 'description': 'Coverage state describing how the URL is indexed.'}, 'indexing_state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Indexing State', 'default': None, 'description': 'Indexing state reported by Google.'}, 'user_canonical': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Canonical', 'default': None, 'description': 'Canonical URL declared on the page, when available.'}, 'last_crawl_time': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Crawl Time', 'default': None, 'description': 'Timestamp of the most recent crawl, when available.'}, 'google_canonical': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Google Canonical', 'default': None, 'description': 'Canonical URL selected by Google, when available.'}, 'page_fetch_state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Fetch State', 'default': None, 'description': 'Result of the most recent page fetch attempt.'}, 'robots_txt_state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Robots Txt State', 'default': None, 'description': 'Whether robots.txt allows indexing of the URL.'}}, 'additionalProperties': True}}, 'title': 'InspectGoogleSearchConsoleUrlResponse', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Verified property URL used for the inspection.'}, 'inspection_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Inspection Url', 'default': None, 'description': 'URL that was inspected.'}, 'index_status_result': {'anyOf': [{'$ref': '#/$defs/InspectGoogleSearchConsoleUrlResponseIndexStatusResult'}, {'type': 'null'}], 'default': None, 'description': 'Indexing status details for the inspected URL.'}}, 'additionalProperties': True}
google-search-console.list_sitemaps
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.
Esquema de entrada
{'type': 'object', 'title': 'list_google_search_console_sitemapsArguments', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'sitemap_index': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sitemap Index', 'default': None, 'description': 'Optional sitemap index URL. When set, only child sitemaps under that index are returned.'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListGoogleSearchConsoleSitemapsResponseSitemapsItem': {'type': 'object', 'title': 'ListGoogleSearchConsoleSitemapsResponseSitemapsItem', 'properties': {'path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Path', 'default': None, 'description': 'Full sitemap URL path for the property.'}, 'errors': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Errors', 'default': None, 'description': 'Error count reported for the sitemap.'}, 'contents': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem'}}, {'type': 'null'}], 'title': 'Contents', 'default': None, 'description': 'Per-content-type submitted and indexed counts.'}, 'warnings': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Warnings', 'default': None, 'description': 'Warning count reported for the sitemap.'}, 'is_pending': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Pending', 'default': None, 'description': 'Whether Search Console is still processing the sitemap.'}, 'sitemap_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sitemap Type', 'default': None, 'description': 'Sitemap type reported by Search Console.'}, 'last_submitted': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Submitted', 'default': None, 'description': 'Timestamp when the sitemap was last submitted.'}, 'last_downloaded': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Downloaded', 'default': None, 'description': 'Timestamp when Google last downloaded the sitemap.'}, 'is_sitemaps_index': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Sitemaps Index', 'default': None, 'description': 'Whether this entry is a sitemap index.'}}, 'additionalProperties': True}, 'ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem': {'type': 'object', 'title': 'ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem', 'properties': {'indexed': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Indexed', 'default': None, 'description': 'Number of indexed URLs of this content type, when available.'}, 'submitted': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Submitted', 'default': None, 'description': 'Number of submitted URLs of this content type, when available.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'Sitemap content type reported by Search Console.'}}, 'additionalProperties': True}}, 'title': 'ListGoogleSearchConsoleSitemapsResponse', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Search Console property URL used for the request.'}, 'sitemaps': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListGoogleSearchConsoleSitemapsResponseSitemapsItem'}}, {'type': 'null'}], 'title': 'Sitemaps', 'default': None, 'description': 'Sitemaps submitted for the property.'}}, 'additionalProperties': True}
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 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.
Esquema de entrada
{'type': 'object', 'title': 'list_google_search_console_sitesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'ListGoogleSearchConsoleSitesResponseSitesItem': {'type': 'object', 'title': 'ListGoogleSearchConsoleSitesResponseSitesItem', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Verified property URL. Either a URL-prefix property (for example https://example.com/) or a domain property (sc-domain:example.com).'}, 'is_default': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Default', 'default': None, 'description': 'Whether this property is used when site_url is omitted on Search Console calls.'}, 'permission_level': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Permission Level', 'default': None, 'description': 'Access level for this property.'}}, 'additionalProperties': True}}, 'title': 'ListGoogleSearchConsoleSitesResponse', 'properties': {'sites': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListGoogleSearchConsoleSitesResponseSitesItem'}}, {'type': 'null'}], 'title': 'Sites', 'default': None, 'description': "Search Console properties for this account's Vee3-managed domains and sites added with google-search-console.add_site."}}, 'additionalProperties': True}
google-search-console.query_search_analytics
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.
Esquema de entrada
{'type': 'object', 'title': 'query_google_search_console_search_analyticsArguments', 'required': ['start_date', 'end_date'], 'properties': {'end_date': {'type': 'string', 'title': 'End Date', 'description': 'Inclusive range end date in YYYY-MM-DD format.'}, 'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'row_limit': {'anyOf': [{'type': 'integer', 'maximum': 25000, 'minimum': 1}, {'type': 'null'}], 'title': 'Row Limit', 'default': None, 'description': 'Maximum number of rows to return. Defaults to 1000.'}, 'start_row': {'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}], 'title': 'Start Row', 'default': None, 'description': 'Zero-based row offset for pagination. Defaults to 0.'}, 'data_state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Data State', 'default': None, 'description': 'Whether to return only finalized data, all available daily data, or hourly data. Use hourly_all when grouping by hour. Defaults to final.'}, 'dimensions': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Dimensions', 'default': None, 'description': 'Optional dimension names to group results. Supported values: date, query, page, country, device, searchAppearance, hour. Grouping by hour uses the hourly feed.'}, 'start_date': {'type': 'string', 'title': 'Start Date', 'description': 'Inclusive range start date in YYYY-MM-DD format.'}, 'search_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Search Type', 'default': None, 'description': 'Search type filter. Defaults to web.'}, 'dimension_filter_groups': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, {'type': 'null'}], 'title': 'Dimension Filter Groups', 'default': None, 'description': 'Optional filter groups matching the Google Search Console Search Analytics API shape. Each group contains filters that restrict which rows are returned.'}}}
Esquema de salida
{'type': 'object', '$defs': {'QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata': {'type': 'object', 'title': 'QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata', 'properties': {'first_incomplete_date': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Incomplete Date', 'default': None, 'description': 'First date still being collected when grouping by date, in YYYY-MM-DD format.'}, 'first_incomplete_hour': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'First Incomplete Hour', 'default': None, 'description': 'First hour still being collected when grouping by hour, in America/Los_Angeles time.'}}, 'additionalProperties': True}, 'QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem': {'type': 'object', 'title': 'QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem', 'properties': {'ctr': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Ctr', 'default': None, 'description': 'Click-through rate for this row.'}, 'keys': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Keys', 'default': None, 'description': 'Dimension values for this row, in the same order as the requested dimensions.'}, 'clicks': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Clicks', 'default': None, 'description': 'Click count for this row.'}, 'position': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Position', 'default': None, 'description': 'Average position for this row.'}, 'impressions': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Impressions', 'default': None, 'description': 'Impression count for this row.'}}, 'additionalProperties': True}}, 'title': 'QueryGoogleSearchConsoleSearchAnalyticsResponse', 'properties': {'rows': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem'}}, {'type': 'null'}], 'title': 'Rows', 'default': None, 'description': 'Search analytics result rows.'}, 'metadata': {'anyOf': [{'$ref': '#/$defs/QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata'}, {'type': 'null'}], 'default': None, 'description': 'Optional context about incomplete recent data. Present when Google is still collecting rows in the requested range.'}, 'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Verified property URL that was queried.'}, 'response_aggregation_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Response Aggregation Type', 'default': None, 'description': 'How rows were aggregated (for example auto or byProperty).'}}, 'additionalProperties': True}
google-search-console.submit_sitemap
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.
Esquema de entrada
{'type': 'object', 'title': 'submit_google_search_console_sitemapArguments', 'required': ['feed_path'], 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.'}, 'feed_path': {'type': 'string', 'title': 'Feed Path', 'description': 'Full sitemap URL for the property, for example https://example.com/sitemap.xml.'}}}
Esquema de salida
{'type': 'object', 'title': 'SubmitGoogleSearchConsoleSitemapResponse', 'properties': {'site_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Site Url', 'default': None, 'description': 'Search Console property URL used for the request.'}, 'feed_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Feed Path', 'default': None, 'description': 'Sitemap URL that was submitted.'}, 'submitted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Submitted', 'default': None, 'description': 'True when Search Console accepted the sitemap submission.'}}, 'additionalProperties': True}
google-search.keyword_traffic_insights
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.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_keyword_traffic_insightsArguments', 'required': ['keyword', 'language'], 'properties': {'mode': {'type': 'string', 'title': 'Mode', 'default': 'all', 'description': 'Keyword suggestion filter: exact returns only suggestions that exactly match the seed keyword; all returns all suggestions (default).'}, 'intent': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Intent', 'default': None, 'description': 'Filter by search intent: informational, navigational, commercial, or transactional.'}, 'keyword': {'type': 'string', 'title': 'Keyword', 'maxLength': 512, 'description': 'Seed keyword to get traffic insights and suggestions for.'}, 'language': {'type': 'string', 'title': 'Language', 'maxLength': 16, 'description': 'Language code for the search market (for example en).'}, 'location': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Location', 'default': None, 'description': 'Optional country or region code for localized traffic (for example US). Omit for global keyword insights.'}, 'min_search_volume': {'type': 'integer', 'title': 'Min Search Volume', 'default': 0, 'minimum': 0, 'description': 'Minimum monthly search volume; only keywords at or above this threshold are returned.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem': {'type': 'object', 'title': 'SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Suggested keyword text.'}, 'trend': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Trend', 'default': None, 'description': 'Search volume trend percentage.'}, 'volume': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Volume', 'default': None, 'description': 'Estimated monthly search volume.'}, 'low_bid': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Low Bid', 'default': None, 'description': 'Low top-of-page bid estimate.'}, 'high_bid': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'High Bid', 'default': None, 'description': 'High top-of-page bid estimate.'}, 'competition_index': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Competition Index', 'default': None, 'description': 'Competition index score.'}, 'competition_level': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Competition Level', 'default': None, 'description': 'Competition level (for example LOW, MEDIUM, HIGH, UNSPECIFIED).'}}, 'additionalProperties': True}}, 'title': 'SeoKeywordTrafficInsightsResponse', 'properties': {'keyword_suggestions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem'}}, {'type': 'null'}], 'title': 'Keyword Suggestions', 'default': None, 'description': 'Keyword suggestions with traffic and competition metrics.'}}, 'additionalProperties': True}
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 language_code (for example en, de). Maps to upstream lang on the provider API. No request parameters. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_google_search_languagesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleSearchLanguagesResponseLanguagesItem': {'type': 'object', 'title': 'GoogleSearchLanguagesResponseLanguagesItem', 'properties': {'language_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Language Code', 'default': None, 'description': 'Language code for the language parameter (for example en).'}, 'language_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Language Name', 'default': None, 'description': 'Language display name.'}}, 'additionalProperties': True}}, 'title': 'GoogleSearchLanguagesResponse', 'properties': {'languages': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleSearchLanguagesResponseLanguagesItem'}}, {'type': 'null'}], 'title': 'Languages', 'default': None, 'description': 'Supported languages for the language request parameter.'}}, 'additionalProperties': True}
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_name and country_code (for example US, GB). No request parameters. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_google_search_locationsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleSearchLocationsResponseLocationsItem': {'type': 'object', 'title': 'GoogleSearchLocationsResponseLocationsItem', 'properties': {'country_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Country Code', 'default': None, 'description': 'Country code for the location parameter (for example US).'}, 'country_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Country Name', 'default': None, 'description': 'Country display name.'}}, 'additionalProperties': True}}, 'title': 'GoogleSearchLocationsResponse', 'properties': {'locations': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleSearchLocationsResponseLocationsItem'}}, {'type': 'null'}], 'title': 'Locations', 'default': None, 'description': 'Supported countries for the location request parameter.'}}, 'additionalProperties': True}
google-search.url_traffic_insights
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.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_url_traffic_insightsArguments', 'required': ['url', 'language'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'maxLength': 2048, 'description': 'Public http or https URL to get traffic insights and suggestions for.'}, 'intent': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Intent', 'default': None, 'description': 'Filter by search intent: informational, navigational, commercial, or transactional.'}, 'language': {'type': 'string', 'title': 'Language', 'maxLength': 16, 'description': 'Language code for the search market (for example en).'}, 'location': {'anyOf': [{'type': 'string', 'maxLength': 16}, {'type': 'null'}], 'title': 'Location', 'default': None, 'description': 'Optional country or region code for localized traffic (for example US). Omit for global URL keyword insights.'}, 'min_search_volume': {'type': 'integer', 'title': 'Min Search Volume', 'default': 0, 'minimum': 0, 'description': 'Minimum monthly search volume; only keywords at or above this threshold are returned.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SeoUrlTrafficInsightsResponseKeywordSuggestionsItem': {'type': 'object', 'title': 'SeoUrlTrafficInsightsResponseKeywordSuggestionsItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Suggested keyword text.'}, 'trend': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Trend', 'default': None, 'description': 'Search volume trend percentage.'}, 'volume': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Volume', 'default': None, 'description': 'Estimated monthly search volume.'}, 'low_bid': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Low Bid', 'default': None, 'description': 'Low top-of-page bid estimate.'}, 'high_bid': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'High Bid', 'default': None, 'description': 'High top-of-page bid estimate.'}, 'competition_index': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Competition Index', 'default': None, 'description': 'Competition index score.'}, 'competition_level': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Competition Level', 'default': None, 'description': 'Competition level (for example LOW, MEDIUM, HIGH, UNSPECIFIED).'}}, 'additionalProperties': True}}, 'title': 'SeoUrlTrafficInsightsResponse', 'properties': {'keyword_suggestions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SeoUrlTrafficInsightsResponseKeywordSuggestionsItem'}}, {'type': 'null'}], 'title': 'Keyword Suggestions', 'default': None, 'description': 'Keyword suggestions with traffic and competition metrics.'}}, 'additionalProperties': True}
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 categories) and msg. Use this before interest-over-time or interest-by-region calls when filtering by category. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_categoriesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleTrendsCategoriesResponseCatItem': {'type': 'object', 'title': 'GoogleTrendsCategoriesResponseCatItem', 'properties': {}, 'additionalProperties': True}}, 'title': 'GoogleTrendsCategoriesResponse', 'properties': {'cat': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleTrendsCategoriesResponseCatItem'}}, {'type': 'null'}], 'title': 'Cat', 'default': None, 'description': 'Category and subcategory names accepted by the category field.'}, 'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Status or informational message from the upstream API (often empty).'}}, 'additionalProperties': True}
google-trends.interest_by_region
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_interest_by_regionArguments', 'required': ['keywords', 'start'], 'properties': {'end': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'End', 'default': None, 'description': 'Range end in datetime-with-timezone form. Defaults to now.'}, 'gprop': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Gprop', 'default': None, 'description': 'Google property filter (for example images, news, youtube, froogle). Defaults to all.'}, 'start': {'type': 'string', 'title': 'Start', 'maxLength': 64, 'description': 'Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Region within country. Requires country when set.'}, 'country': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Country', 'default': None, 'description': 'Country name for geo filtering. Defaults to global.'}, 'category': {'anyOf': [{'type': 'string', 'maxLength': 256}, {'type': 'null'}], 'title': 'Category', 'default': None, 'description': 'Trends category or subcategory. Defaults to all.'}, 'keywords': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Keywords', 'maxItems': 5, 'minItems': 1, 'description': 'Up to five keywords to compare.'}, 'resolution': {'enum': ['COUNTRY', 'REGION'], 'type': 'string', 'title': 'Resolution', 'default': 'COUNTRY', 'description': 'Geographic resolution: COUNTRY (default) or REGION.'}}}
Esquema de salida
{'type': 'object', 'title': 'GoogleTrendsInterestByRegionResponse', 'properties': {}, 'additionalProperties': True}
google-trends.interest_over_time
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_interest_over_timeArguments', 'required': ['keywords', 'start'], 'properties': {'end': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'End', 'default': None, 'description': 'Range end in datetime-with-timezone form. Defaults to now.'}, 'gprop': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Gprop', 'default': None, 'description': 'Google property filter (for example images, news, youtube, froogle). Defaults to all.'}, 'start': {'type': 'string', 'title': 'Start', 'maxLength': 64, 'description': 'Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Region within country. Requires country when set.'}, 'country': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Country', 'default': None, 'description': 'Country name for geo filtering. Defaults to global.'}, 'category': {'anyOf': [{'type': 'string', 'maxLength': 256}, {'type': 'null'}], 'title': 'Category', 'default': None, 'description': 'Trends category or subcategory. Defaults to all.'}, 'keywords': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Keywords', 'maxItems': 5, 'minItems': 1, 'description': 'Up to five keywords to compare.'}}}
Esquema de salida
{'type': 'object', 'title': 'GoogleTrendsInterestOverTimeResponse', 'properties': {}, 'additionalProperties': True}
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 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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_regionsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleTrendsRegionsResponseGeo': {'type': 'object', 'title': 'GoogleTrendsRegionsResponseGeo', 'properties': {'countries': {'anyOf': [{'$ref': '#/$defs/GoogleTrendsRegionsResponseGeoCountries'}, {'type': 'null'}], 'default': None, 'description': 'Map of country name to country metadata and subregions.'}}, 'additionalProperties': True}, 'GoogleTrendsRegionsResponseGeoCountries': {'type': 'object', 'title': 'GoogleTrendsRegionsResponseGeoCountries', 'properties': {}, 'additionalProperties': True}}, 'title': 'GoogleTrendsRegionsResponse', 'properties': {'geo': {'anyOf': [{'$ref': '#/$defs/GoogleTrendsRegionsResponseGeo'}, {'type': 'null'}], 'default': None, 'description': 'Geographic options keyed by country name.'}, 'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Status or informational message (often empty).'}}, 'additionalProperties': True}
google-trends.related_queries
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_related_queriesArguments', 'required': ['keywords', 'start'], 'properties': {'end': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'End', 'default': None, 'description': 'Range end in datetime-with-timezone form. Defaults to now.'}, 'gprop': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Gprop', 'default': None, 'description': 'Google property filter (for example images, news, youtube, froogle). Defaults to all.'}, 'start': {'type': 'string', 'title': 'Start', 'maxLength': 64, 'description': 'Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Region within country. Requires country when set.'}, 'country': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Country', 'default': None, 'description': 'Country name for geo filtering. Defaults to global.'}, 'category': {'anyOf': [{'type': 'string', 'maxLength': 256}, {'type': 'null'}], 'title': 'Category', 'default': None, 'description': 'Trends category or subcategory. Defaults to all.'}, 'keywords': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Keywords', 'maxItems': 5, 'minItems': 1, 'description': 'Up to five keywords to compare.'}}}
Esquema de salida
{'type': 'object', 'title': 'GoogleTrendsRelatedQueriesResponse', 'properties': {}, 'additionalProperties': True}
google-trends.suggestions
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.
Esquema de entrada
{'type': 'object', 'title': 'get_google_trends_suggestionsArguments', 'required': ['keyword'], 'properties': {'keyword': {'type': 'string', 'title': 'Keyword', 'maxLength': 512, 'description': 'Keyword or phrase to get suggestions for.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GoogleTrendsSuggestionsResponseResultItem': {'type': 'object', 'title': 'GoogleTrendsSuggestionsResponseResultItem', 'properties': {'mid': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mid', 'default': None, 'description': 'Google Trends topic or entity identifier.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Suggestion kind (for example Topic, Software, Book).'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Display title for the suggestion.'}}, 'additionalProperties': True}}, 'title': 'GoogleTrendsSuggestionsResponse', 'properties': {'result': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GoogleTrendsSuggestionsResponseResultItem'}}, {'type': 'null'}], 'title': 'Result', 'default': None, 'description': 'Suggested topics and entities for the keyword.'}}, 'additionalProperties': True}
image-generation.edit
Edit an existing image or compose several images into one scene with Muse Image. The user or agent passes stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit; several images are composed into one result. The result is saved to account file storage. The response includes a signed URL for API users and download_code for agents to run `vee3-get-file`. Cost = 50 tokens per generated image.
Esquema de entrada
{'type': 'object', 'title': 'edit_imageArguments', 'required': ['prompt', 'images'], 'properties': {'n': {'type': 'integer', 'title': 'N', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Number of images to generate (1 to 10). Each returned image costs 50 tokens.'}, 'size': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Size', 'default': None, 'description': 'Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.'}, 'images': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Images', 'maxItems': 8, 'minItems': 1, 'description': 'Source images as stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit. Several images are composed into one scene. Upload files with files.upload_file first.'}, 'prompt': {'type': 'string', 'title': 'Prompt', 'maxLength': 4000, 'description': 'Text description of the image to generate or of the edit to apply.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.'}, 'output_format': {'enum': ['webp', 'png', 'jpeg'], 'type': 'string', 'title': 'Output Format', 'default': 'webp', 'description': 'Encoding of the returned image. webp is smaller; png is lossless.'}}}
Esquema de salida
{'type': 'object', '$defs': {'EditImageResponseImagesItem': {'type': 'object', 'title': 'EditImageResponseImagesItem', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the image was stored.'}, 'image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Image Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved download.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Image file size in bytes.'}}, 'additionalProperties': True}}, 'title': 'EditImageResponse', 'properties': {'size': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Size', 'default': None, 'description': 'Echo of the requested size when one was passed.'}, 'images': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/EditImageResponseImagesItem'}}, {'type': 'null'}], 'title': 'Images', 'default': None, 'description': 'Generated images stored in account file storage.'}, 'prompt': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Prompt', 'default': None, 'description': 'Echo of the requested prompt.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Always "completed" for a successful generation.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'ISO 8601 timestamp.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Tokens charged for this request (50 times image_count).'}, 'image_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Image Count', 'default': None, 'description': 'Number of images returned and billed.'}, 'generation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Generation Id', 'default': None, 'description': 'Unique identifier, prefix igen_.'}, 'output_format': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Output Format', 'default': None, 'description': 'Encoding of the stored images (webp, png, or jpeg).'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}}, 'additionalProperties': True}
image-generation.generate
Generate an image from a text prompt with Muse Image. The image is saved to account file storage. The response includes a signed URL for API users and download_code for agents to run `vee3-get-file`. When n is greater than 1, each returned image is stored separately. Cost = 50 tokens per generated image.
Esquema de entrada
{'type': 'object', 'title': 'generate_imageArguments', 'required': ['prompt'], 'properties': {'n': {'type': 'integer', 'title': 'N', 'default': 1, 'maximum': 10, 'minimum': 1, 'description': 'Number of images to generate (1 to 10). Each returned image costs 50 tokens.'}, 'size': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Size', 'default': None, 'description': 'Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.'}, 'prompt': {'type': 'string', 'title': 'Prompt', 'maxLength': 4000, 'description': 'Text description of the image to generate or of the edit to apply.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.'}, 'output_format': {'enum': ['webp', 'png', 'jpeg'], 'type': 'string', 'title': 'Output Format', 'default': 'webp', 'description': 'Encoding of the returned image. webp is smaller; png is lossless.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GenerateImageResponseImagesItem': {'type': 'object', 'title': 'GenerateImageResponseImagesItem', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the image was stored.'}, 'image_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Image Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved download.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Image file size in bytes.'}}, 'additionalProperties': True}}, 'title': 'GenerateImageResponse', 'properties': {'size': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Size', 'default': None, 'description': 'Echo of the requested size when one was passed.'}, 'images': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GenerateImageResponseImagesItem'}}, {'type': 'null'}], 'title': 'Images', 'default': None, 'description': 'Generated images stored in account file storage.'}, 'prompt': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Prompt', 'default': None, 'description': 'Echo of the requested prompt.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Always "completed" for a successful generation.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'ISO 8601 timestamp.'}, 'token_cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Token Cost', 'default': None, 'description': 'Tokens charged for this request (50 times image_count).'}, 'image_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Image Count', 'default': None, 'description': 'Number of images returned and billed.'}, 'generation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Generation Id', 'default': None, 'description': 'Unique identifier, prefix igen_.'}, 'output_format': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Output Format', 'default': None, 'description': 'Encoding of the stored images (webp, png, or jpeg).'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}}, 'additionalProperties': True}
meta-tools.describe
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.
Esquema de entrada
{'type': 'object', 'title': 'describe_toolArguments', 'required': ['tool_name'], 'properties': {'tool_name': {'type': 'string', 'title': 'Tool Name', 'maxLength': 128, 'description': 'MCP tool name (for example `x-twitter.create_post`) or capability id (for example `create-x-post`).'}}}
Esquema de salida
{'type': 'object', '$defs': {'DescribeToolResponseTool': {'type': 'object', 'title': 'DescribeToolResponseTool', 'properties': {'summary': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Summary', 'default': None, 'description': 'Short capability summary.'}, 'examples': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolExamplesItem'}}, {'type': 'null'}], 'title': 'Examples', 'default': None, 'description': 'Request examples for the capability.'}, 'group_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Group Id', 'default': None, 'description': 'Capability group id.'}, 'error_codes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolErrorCodesItem'}}, {'type': 'null'}], 'title': 'Error Codes', 'default': None, 'description': 'Error codes that may appear in error responses.'}, 'mcp_tool_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mcp Tool Name', 'default': None, 'description': 'MCP tool name when the capability is exposed over MCP.'}, 'request_fields': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolRequestFieldsItem'}}, {'type': 'null'}], 'title': 'Request Fields', 'default': None, 'description': 'Request parameter schema for the capability.'}, 'response_fields': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolResponseFieldsItem'}}, {'type': 'null'}], 'title': 'Response Fields', 'default': None, 'description': 'Response field schema for the capability.'}, 'usage_unit_label': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Usage Unit Label', 'default': None, 'description': 'Label for usage reporting (for example screenshots).'}, 'agent_description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Agent Description', 'default': None, 'description': 'Longer description intended for agents.'}, 'response_examples': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolResponseExamplesItem'}}, {'type': 'null'}], 'title': 'Response Examples', 'default': None, 'description': 'Response examples for the capability.'}, 'success_body_codes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolSuccessBodyCodesItem'}}, {'type': 'null'}], 'title': 'Success Body Codes', 'default': None, 'description': 'Non-error body codes that may appear on HTTP 200 responses.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolExamplesItem': {'type': 'object', 'title': 'DescribeToolResponseToolExamplesItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Example identifier.'}, 'surfaces': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolExamplesItemSurfacesItem'}}, {'type': 'null'}], 'title': 'Surfaces', 'default': None, 'description': 'Surfaces where the example applies.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'What the example demonstrates.'}, 'request_body': {'anyOf': [{'$ref': '#/$defs/DescribeToolResponseToolExamplesItemRequestBody'}, {'type': 'null'}], 'default': None, 'description': 'Sample request payload for the capability.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolErrorCodesItem': {'type': 'object', 'title': 'DescribeToolResponseToolErrorCodesItem', 'properties': {'error_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Error Code', 'default': None, 'description': 'Machine-readable error code.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolRequestFieldsItem': {'type': 'object', 'title': 'DescribeToolResponseToolRequestFieldsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Request parameter name.'}, 'default': {'anyOf': [{'type': 'string'}, {'type': 'integer'}, {'type': 'boolean'}, {'type': 'null'}], 'title': 'Default', 'default': None, 'description': 'Default value when omitted (string, integer, or boolean), or null when none.'}, 'required': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Required', 'default': None, 'description': 'Whether the parameter is required.'}, 'surfaces': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolRequestFieldsItemSurfacesItem'}}, {'type': 'null'}], 'title': 'Surfaces', 'default': None, 'description': 'Surfaces where the parameter applies.'}, 'type_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type Name', 'default': None, 'description': 'Parameter type (string, integer, boolean, or enum).'}, 'constraints': {'anyOf': [{'$ref': '#/$defs/DescribeToolResponseToolRequestFieldsItemConstraints'}, {'type': 'null'}], 'default': None, 'description': 'Optional numeric or length limits.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Parameter description.'}, 'enum_values': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolRequestFieldsItemEnumValuesItem'}}, {'type': 'null'}], 'title': 'Enum Values', 'default': None, 'description': 'Allowed enum values when type_name is enum.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolResponseFieldsItem': {'type': 'object', 'title': 'DescribeToolResponseToolResponseFieldsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Response field name.'}, 'children': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/DescribeToolResponseToolResponseFieldsItemChildrenItem'}}, {'type': 'null'}], 'title': 'Children', 'default': None, 'description': 'Nested response field specs when type_name is array or object. Items use the same shape and may nest further.'}, 'type_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type Name', 'default': None, 'description': 'Field type (string, integer, boolean, enum, array, or object).'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Field description.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolResponseExamplesItem': {'type': 'object', 'title': 'DescribeToolResponseToolResponseExamplesItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Example identifier.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'What the example demonstrates.'}, 'status_code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Status Code', 'default': None, 'description': 'HTTP status code for the example response.'}, 'response_body': {'anyOf': [{'$ref': '#/$defs/DescribeToolResponseToolResponseExamplesItemResponseBody'}, {'type': 'null'}], 'default': None, 'description': 'Sample response payload for the capability.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolSuccessBodyCodesItem': {'type': 'object', 'title': 'DescribeToolResponseToolSuccessBodyCodesItem', 'properties': {'body_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Body Code', 'default': None, 'description': 'Machine-readable success-body code.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolExamplesItemRequestBody': {'type': 'object', 'title': 'DescribeToolResponseToolExamplesItemRequestBody', 'properties': {'parameter': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Parameter', 'default': None, 'description': 'Capability-specific request parameter documented in the example.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolExamplesItemSurfacesItem': {'type': 'object', 'title': 'DescribeToolResponseToolExamplesItemSurfacesItem', 'properties': {'surface': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Surface', 'default': None, 'description': 'rest or mcp.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolRequestFieldsItemConstraints': {'type': 'object', 'title': 'DescribeToolResponseToolRequestFieldsItemConstraints', 'properties': {'maximum': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Maximum', 'default': None, 'description': 'Maximum allowed numeric value when set.'}, 'minimum': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Minimum', 'default': None, 'description': 'Minimum allowed numeric value when set.'}, 'max_length': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Max Length', 'default': None, 'description': 'Maximum allowed string length when set.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolRequestFieldsItemSurfacesItem': {'type': 'object', 'title': 'DescribeToolResponseToolRequestFieldsItemSurfacesItem', 'properties': {'surface': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Surface', 'default': None, 'description': 'rest or mcp.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolResponseFieldsItemChildrenItem': {'type': 'object', 'title': 'DescribeToolResponseToolResponseFieldsItemChildrenItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Response field name.'}, 'type_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type Name', 'default': None, 'description': 'Field type (string, integer, boolean, enum, array, or object).'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Field description.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolRequestFieldsItemEnumValuesItem': {'type': 'object', 'title': 'DescribeToolResponseToolRequestFieldsItemEnumValuesItem', 'properties': {'value': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Value', 'default': None, 'description': 'Allowed enum value.'}}, 'additionalProperties': True}, 'DescribeToolResponseToolResponseExamplesItemResponseBody': {'type': 'object', 'title': 'DescribeToolResponseToolResponseExamplesItemResponseBody', 'properties': {'field': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Field', 'default': None, 'description': 'Capability-specific response field documented in the example.'}}, 'additionalProperties': True}}, 'title': 'DescribeToolResponse', 'properties': {'tool': {'anyOf': [{'$ref': '#/$defs/DescribeToolResponseTool'}, {'type': 'null'}], 'default': None, 'description': 'Full capability detail including fields, examples, and bindings.'}, 'capability_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Capability Id', 'default': None, 'description': 'Described capability id.'}}, 'additionalProperties': True}
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 meta-tools.describe for full request/response schemas and token costs Cost = 0 tokens.
Esquema de entrada
{'type': 'object', 'title': 'list_all_toolsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'ListAllToolsResponseToolsItem': {'type': 'object', 'title': 'ListAllToolsResponseToolsItem', 'properties': {'summary': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Summary', 'default': None, 'description': 'Short capability summary.'}, 'group_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Group Id', 'default': None, 'description': 'Capability group id.'}, 'mcp_tool_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Mcp Tool Name', 'default': None, 'description': 'MCP tool name when the capability is exposed over MCP.'}}, 'additionalProperties': True}}, 'title': 'ListAllToolsResponse', 'properties': {'tools': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListAllToolsResponseToolsItem'}}, {'type': 'null'}], 'title': 'Tools', 'default': None, 'description': 'Live tool summaries for every capability exposed to agents.'}}, 'additionalProperties': True}
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.
Esquema de entrada
{'type': 'object', 'title': 'list_groupsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'ListGroupsResponseGroupsItem': {'type': 'object', 'title': 'ListGroupsResponseGroupsItem', 'properties': {'summary': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Summary', 'default': None, 'description': 'Short group summary.'}, 'group_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Group Id', 'default': None, 'description': 'Group id (for example website-screenshots).'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Name', 'default': None, 'description': 'Human-readable group name.'}, 'live_tool_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Live Tool Count', 'default': None, 'description': 'Number of live capabilities in the group.'}}, 'additionalProperties': True}}, 'title': 'ListGroupsResponse', 'properties': {'groups': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListGroupsResponseGroupsItem'}}, {'type': 'null'}], 'title': 'Groups', 'default': None, 'description': 'Capability groups with live tool counts.'}, 'message': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Message', 'default': None, 'description': 'How the user can enable and disable capability groups from Customize MCP in the dashboard.'}}, 'additionalProperties': True}
meta-tools.list_group_tools
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.
Esquema de entrada
{'type': 'object', 'title': 'list_group_toolsArguments', 'required': ['group_id'], 'properties': {'group_id': {'type': 'string', 'title': 'Group Id', 'maxLength': 128, 'description': 'Group id to list tools for (for example website-screenshots).'}}}
Esquema de salida
{'type': 'object', '$defs': {'ListGroupToolsResponseToolsItem': {'type': 'object', 'title': 'ListGroupToolsResponseToolsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'MCP tool name when the capability is exposed over MCP.'}, 'summary': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Summary', 'default': None, 'description': 'Short capability summary.'}}, 'additionalProperties': True}}, 'title': 'ListGroupToolsResponse', 'properties': {'tools': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/ListGroupToolsResponseToolsItem'}}, {'type': 'null'}], 'title': 'Tools', 'default': None, 'description': 'Live tool summaries in the requested group.'}, 'group_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Group Id', 'default': None, 'description': 'Requested group id.'}}, 'additionalProperties': True}
meta-tools.report_bug
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.
Esquema de entrada
{'type': 'object', 'title': 'report_bugArguments', 'required': ['summary', 'description'], 'properties': {'summary': {'type': 'string', 'title': 'Summary', 'maxLength': 200, 'description': 'Short title describing the issue.'}, 'description': {'type': 'string', 'title': 'Description', 'maxLength': 8000, 'description': 'Detailed explanation of what went wrong, what was expected, and steps to reproduce if known.'}, 'error_details': {'anyOf': [{'type': 'string', 'maxLength': 8000}, {'type': 'null'}], 'title': 'Error Details', 'default': None, 'description': 'Raw error message, stack trace, or API response that shows the failure.'}, 'related_capability_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Related Capability Id', 'default': None, 'description': 'MCP tool name or capability id involved in the issue, if applicable.'}}}
Esquema de salida
{'type': 'object', 'title': 'ReportBugResponse', 'properties': {'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Submission status. Always "received" on success.'}, 'report_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Report Id', 'default': None, 'description': 'Unique identifier for the submitted bug report.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'ISO 8601 timestamp when the report was recorded.'}}, 'additionalProperties': True}
meta-tools.request_feature
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.
Esquema de entrada
{'type': 'object', 'title': 'request_featureArguments', 'required': ['summary', 'description'], 'properties': {'summary': {'type': 'string', 'title': 'Summary', 'maxLength': 200, 'description': 'Short title describing the requested capability or feature.'}, 'use_case': {'anyOf': [{'type': 'string', 'maxLength': 8000}, {'type': 'null'}], 'title': 'Use Case', 'default': None, 'description': 'Example workflow or scenario where this feature would be used.'}, 'description': {'type': 'string', 'title': 'Description', 'maxLength': 8000, 'description': 'Detailed explanation of what is needed, why it cannot be done with existing tools, and how it would help.'}, 'related_capability_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Related Capability Id', 'default': None, 'description': 'Capability id this request extends or relates to, if applicable.'}}}
Esquema de salida
{'type': 'object', 'title': 'RequestFeatureResponse', 'properties': {'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Submission status. Always "received" on success.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'ISO 8601 timestamp when the request was recorded.'}, 'request_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Request Id', 'default': None, 'description': 'Unique identifier for the submitted feature request.'}}, 'additionalProperties': True}
meta-tools.search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_toolsArguments', 'required': ['query'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 20, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum results to return (1–20).'}, 'query': {'type': 'string', 'title': 'Query', 'maxLength': 256, 'description': 'Keywords or short task description (for example `tiktok video comments` or `domain availability`).'}, 'group_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Group Id', 'default': None, 'description': 'Optional group id to narrow results (for example `x-twitter`).'}}}
Esquema de salida
{'type': 'object', '$defs': {'SearchToolsResponseResultsItem': {'type': 'object', 'title': 'SearchToolsResponseResultsItem', 'properties': {'cost': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Cost', 'default': None, 'description': 'Successful request token cost for the capability.'}, 'summary': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Summary', 'default': None, 'description': 'Short capability summary.'}, 'tool_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tool Name', 'default': None, 'description': 'MCP tool name for the matched capability.'}}, 'additionalProperties': True}}, 'title': 'SearchToolsResponse', 'properties': {'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Normalized search query that was executed.'}, 'results': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchToolsResponseResultsItem'}}, {'type': 'null'}], 'title': 'Results', 'default': None, 'description': 'Ranked capability matches visible to the caller.'}}, 'additionalProperties': True}
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_period_end). Use this before expensive calls or when you receive a 402 insufficient_tokens response Cost = 0 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_token_balanceArguments', 'properties': {}}
Esquema de salida
{'type': 'object', 'title': 'GetTokenBalanceResponse', 'properties': {'tokens_used': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Tokens Used', 'default': None, 'description': 'Tokens consumed in the current billing period.'}, 'billing_plan': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Billing Plan', 'default': None, 'description': 'Current billing plan id (free, starter, pro, scale).'}, 'tokens_remaining': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Tokens Remaining', 'default': None, 'description': 'Tokens left before quota is exhausted.'}, 'billing_period_end': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Billing Period End', 'default': None, 'description': 'ISO 8601 end of the current billing period.'}, 'billing_period_start': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Billing Period Start', 'default': None, 'description': 'ISO 8601 start of the current billing period.'}, 'monthly_token_allowance': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Monthly Token Allowance', 'default': None, 'description': 'Total tokens included in the current billing period.'}, 'billing_period_resets_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Billing Period Resets At', 'default': None, 'description': 'ISO 8601 timestamp when the token allowance resets (same as period end).'}}, 'additionalProperties': True}
pages.create
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.
Esquema de entrada
{'type': 'object', 'title': 'createArguments', 'required': ['slug'], 'properties': {'name': {'anyOf': [{'type': 'string', 'maxLength': 80}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Optional display name for the page. Does not change the public URL. At most 80 characters.'}, 'slug': {'type': 'string', 'title': 'Slug', 'maxLength': 48, 'description': 'Page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesCreateResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page (https://{slug}.vee3.site until a custom domain is attached).'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}}, 'additionalProperties': True}
pages.delete
Delete a hosted static website and its CDN resources. Removes the page from this Vee3 account after deleting upstream resources. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'deleteArguments', 'required': ['page_id'], 'properties': {'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id to delete.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesDeleteResponse', 'properties': {'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the page was deleted.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Deleted page id.'}}, 'additionalProperties': True}
pages.deploy
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.
Esquema de entrada
{'type': 'object', 'title': 'deployArguments', 'required': ['page_id', 'files'], 'properties': {'files': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}, 'title': 'Files', 'maxItems': 500, 'minItems': 1, 'description': 'Files to deploy. Each item is an object with file_name (uploaded account-relative path) and optional path (destination path on the page; defaults to the file basename). Maximum 500 files.'}, 'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id returned by pages.create.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesDeployResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Live CDN URL for the page. Uses the custom domain when one is attached.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Page id.'}, 'deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Deployed At', 'default': None, 'description': 'When this deploy completed.'}, 'deployed_file_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Deployed File Count', 'default': None, 'description': 'Number of files deployed in this request.'}}, 'additionalProperties': True}
pages.edit
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.
Esquema de entrada
{'type': 'object', 'title': 'editArguments', 'required': ['page_id'], 'properties': {'name': {'anyOf': [{'type': 'string', 'maxLength': 80}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page. Does not change the public URL. Pass an empty value to clear the name. At most 80 characters.'}, 'slug': {'anyOf': [{'type': 'string', 'maxLength': 48}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'New page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.'}, 'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id to update.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesEditResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page. Uses the custom domain when one is attached.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'When the page record was last updated.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}, 'last_deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Deployed At', 'default': None, 'description': 'When files were last deployed to the page.'}}, 'additionalProperties': True}
pages.get
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.
Esquema de entrada
{'type': 'object', 'title': 'getArguments', 'required': ['page_id'], 'properties': {'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id to look up.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesGetResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page. Uses the custom domain when one is attached.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status: active, disabled, pending, or failed. disabled means the page is offline because the account stayed over its token allowance. It comes back after a plan upgrade or the monthly allowance reset.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'When the page record was last updated.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}, 'last_deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Deployed At', 'default': None, 'description': 'When files were last deployed to the page.'}}, 'additionalProperties': True}
pages.list
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.
Esquema de entrada
{'type': 'object', 'title': 'list_pagesArguments', 'properties': {'page': {'type': 'integer', 'title': 'Page', 'default': 1, 'minimum': 1, 'description': 'Page number for paginated results.'}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 50, 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of pages to return.'}}}
Esquema de salida
{'type': 'object', '$defs': {'PagesListResponsePaging': {'type': 'object', 'title': 'PagesListResponsePaging', 'properties': {'page_size': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Page Size', 'default': None, 'description': 'Number of pages returned per page.'}, 'total_items': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total Items', 'default': None, 'description': 'Total pages matching the query.'}, 'current_page': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Current Page', 'default': None, 'description': 'Current page number.'}}, 'additionalProperties': True}, 'PagesListResponsePagesItem': {'type': 'object', 'title': 'PagesListResponsePagesItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page. Uses the custom domain when one is attached.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status: active, disabled, pending, or failed. disabled means the page is offline because the account stayed over its token allowance. It comes back after a plan upgrade or the monthly allowance reset.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}, 'last_deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Deployed At', 'default': None, 'description': 'When files were last deployed to the page.'}}, 'additionalProperties': True}}, 'title': 'PagesListResponse', 'properties': {'pages': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/PagesListResponsePagesItem'}}, {'type': 'null'}], 'title': 'Pages', 'default': None, 'description': 'Pages for this Vee3 account.'}, 'paging': {'anyOf': [{'$ref': '#/$defs/PagesListResponsePaging'}, {'type': 'null'}], 'default': None, 'description': 'Pagination metadata for the result set.'}}, 'additionalProperties': True}
pages.remove_custom_domain
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.
Esquema de entrada
{'type': 'object', 'title': 'remove_custom_domainArguments', 'required': ['page_id'], 'properties': {'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id to detach the custom domain from.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesRemoveCustomDomainResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page. Uses the custom domain when one is attached.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'When the page record was last updated.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}, 'last_deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Deployed At', 'default': None, 'description': 'When files were last deployed to the page.'}}, 'additionalProperties': True}
pages.set_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 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.
Esquema de entrada
{'type': 'object', 'title': 'set_custom_domainArguments', 'required': ['page_id', 'custom_domain'], 'properties': {'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id to attach the custom domain to.'}, 'custom_domain': {'type': 'string', 'title': 'Custom Domain', 'maxLength': 253, 'description': 'Hostname to attach, such as www.example.com or example.com. Must be on a domain this Vee3 account already manages. At most 253 characters.'}}}
Esquema de salida
{'type': 'object', 'title': 'PagesSetCustomDomainResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Public HTTPS URL for the page. Uses the custom domain when one is attached.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name for the page, if set.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Page slug.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Current page status.'}, 'message': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Message', 'default': None, 'description': 'Note that DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes.'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'hostname': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Hostname', 'default': None, 'description': 'Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'When the page was created.'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updated At', 'default': None, 'description': 'When the page record was last updated.'}, 'custom_domain': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Custom Domain', 'default': None, 'description': 'Custom hostname attached to the page, if any.'}, 'last_deployed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Last Deployed At', 'default': None, 'description': 'When files were last deployed to the page.'}}, 'additionalProperties': True}
pages.statistics
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.
Esquema de entrada
{'type': 'object', 'title': 'get_statisticsArguments', 'required': ['page_id'], 'properties': {'date_to': {'anyOf': [{'type': 'string', 'maxLength': 10}, {'type': 'null'}], 'title': 'Date To', 'default': None, 'description': 'Inclusive UTC end date (YYYY-MM-DD). Defaults to today UTC.'}, 'page_id': {'type': 'string', 'title': 'Page Id', 'description': 'Page id returned by pages.create.'}, 'date_from': {'anyOf': [{'type': 'string', 'maxLength': 10}, {'type': 'null'}], 'title': 'Date From', 'default': None, 'description': 'Inclusive UTC start date (YYYY-MM-DD). Defaults to 6 days before date_to.'}}}
Esquema de salida
{'type': 'object', '$defs': {'PagesStatisticsResponseTrafficByCountryItem': {'type': 'object', 'title': 'PagesStatisticsResponseTrafficByCountryItem', 'properties': {'country_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Country Code', 'default': None, 'description': 'ISO 3166-1 alpha-2 country code.'}, 'bandwidth_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bandwidth Bytes', 'default': None, 'description': 'Bytes the CDN served to this country in the range.'}}, 'additionalProperties': True}}, 'title': 'PagesStatisticsResponse', 'properties': {'date_to': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Date To', 'default': None, 'description': 'Inclusive UTC end date actually used (YYYY-MM-DD).'}, 'page_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Page Id', 'default': None, 'description': 'Unique identifier for the page.'}, 'date_from': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Date From', 'default': None, 'description': 'Inclusive UTC start date actually used (YYYY-MM-DD).'}, 'request_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Request Count', 'default': None, 'description': 'CDN requests served in the range, including HTML, CSS, images, and other files. Not unique visitors.'}, 'cache_hit_rate': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Cache Hit Rate', 'default': None, 'description': 'Fraction of requests served from cache, from 0 to 1.'}, 'bandwidth_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bandwidth Bytes', 'default': None, 'description': 'Total bytes the CDN served in the range.'}, 'traffic_by_country': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/PagesStatisticsResponseTrafficByCountryItem'}}, {'type': 'null'}], 'title': 'Traffic By Country', 'default': None, 'description': 'Bandwidth by country code, largest first. Omits countries with no traffic.'}}, 'additionalProperties': True}
rotten-tomatoes.celebrity_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_celebrity_detailsArguments', 'required': ['celebrity_slug'], 'properties': {'celebrity_slug': {'type': 'string', 'title': 'Celebrity Slug', 'maxLength': 512, 'description': 'Celebrity slug (for example morgan-freeman).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesCelebrityDetailsResponseTvItem': {'type': 'object', 'title': 'RottenTomatoesCelebrityDetailsResponseTvItem', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Title slug.'}, 'year': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Year', 'default': None, 'description': 'Release or air year.'}, 'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Tomatometer score when available.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Title name.'}}, 'additionalProperties': True}, 'RottenTomatoesCelebrityDetailsResponseMoviesItem': {'type': 'object', 'title': 'RottenTomatoesCelebrityDetailsResponseMoviesItem', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Title slug.'}, 'year': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Year', 'default': None, 'description': 'Release or air year.'}, 'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Tomatometer score when available.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Title name.'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesCelebrityDetailsResponse', 'properties': {'tv': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesCelebrityDetailsResponseTvItem'}}, {'type': 'null'}], 'title': 'Tv', 'default': None, 'description': 'TV credits with title, slug, year, and score.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Celebrity name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Celebrity slug.'}, 'movies': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesCelebrityDetailsResponseMoviesItem'}}, {'type': 'null'}], 'title': 'Movies', 'default': None, 'description': 'Movie credits with title, slug, year, and score.'}}, 'additionalProperties': True}
rotten-tomatoes.movie_cast_and_crew
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_movie_cast_and_crewArguments', 'required': ['movie_slug'], 'properties': {'movie_slug': {'type': 'string', 'title': 'Movie Slug', 'maxLength': 512, 'description': 'Movie slug (for example shawshank-redemption).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesMovieCastAndCrewResponseCastItem': {'type': 'object', 'title': 'RottenTomatoesMovieCastAndCrewResponseCastItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Rotten Tomatoes profile or title URL.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Person name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Celebrity slug when available.'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesMovieCastAndCrewResponse', 'properties': {'cast': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesMovieCastAndCrewResponseCastItem'}}, {'type': 'null'}], 'title': 'Cast', 'default': None, 'description': 'Cast and crew credits for the movie.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Movie slug.'}}, 'additionalProperties': True}
rotten-tomatoes.movie_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_movie_detailsArguments', 'required': ['movie_slug'], 'properties': {'movie_slug': {'type': 'string', 'title': 'Movie Slug', 'maxLength': 512, 'description': 'Movie slug (for example shawshank-redemption).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesMovieDetailsResponseCastItem': {'type': 'object', 'title': 'RottenTomatoesMovieDetailsResponseCastItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Rotten Tomatoes profile or title URL.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Person name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Celebrity slug when available.'}}, 'additionalProperties': True}, 'RottenTomatoesMovieDetailsResponseTomatometer': {'type': 'object', 'title': 'RottenTomatoesMovieDetailsResponseTomatometer', 'properties': {'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Numeric score.'}, 'scoreRaw': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scoreraw', 'default': None, 'description': 'Formatted score string (for example 89%).'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Score sentiment (for example POSITIVE).'}}, 'additionalProperties': True}, 'RottenTomatoesMovieDetailsResponsePopcornmeter': {'type': 'object', 'title': 'RottenTomatoesMovieDetailsResponsePopcornmeter', 'properties': {'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Numeric score.'}, 'scoreRaw': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scoreraw', 'default': None, 'description': 'Formatted score string (for example 89%).'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Score sentiment (for example POSITIVE).'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesMovieDetailsResponse', 'properties': {'cast': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesMovieDetailsResponseCastItem'}}, {'type': 'null'}], 'title': 'Cast', 'default': None, 'description': 'Featured cast with name, slug, and imageUrl.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Movie slug.'}, 'year': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Year', 'default': None, 'description': 'Release year.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Movie title.'}, 'tomatometer': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesMovieDetailsResponseTomatometer'}, {'type': 'null'}], 'default': None, 'description': 'Critic Tomatometer score and metadata.'}, 'popcornmeter': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesMovieDetailsResponsePopcornmeter'}, {'type': 'null'}], 'default': None, 'description': 'Audience Popcornmeter score and metadata.'}}, 'additionalProperties': True}
rotten-tomatoes.movie_reviews
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_movie_reviewsArguments', 'required': ['movie_slug'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 50, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of review pages to return (1–50, default 20).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response pageInfo.endCursor field.'}, 'movie_slug': {'type': 'string', 'title': 'Movie Slug', 'maxLength': 512, 'description': 'Movie slug (for example shawshank-redemption).'}, 'review_type': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Review Type', 'default': None, 'description': 'Review filter. Use critic for critic reviews; omit for the default set.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesMovieReviewsResponsePageInfo': {'type': 'object', 'title': 'RottenTomatoesMovieReviewsResponsePageInfo', 'properties': {'endCursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Endcursor', 'default': None, 'description': 'Cursor for the next page of reviews.'}, 'hasNextPage': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasnextpage', 'default': None, 'description': 'Whether more review pages are available.'}}, 'additionalProperties': True}, 'RottenTomatoesMovieReviewsResponseReviewsItem': {'type': 'object', 'title': 'RottenTomatoesMovieReviewsResponseReviewsItem', 'properties': {'quote': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Quote', 'default': None, 'description': 'Review excerpt or quote.'}, 'reviewId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Reviewid', 'default': None, 'description': 'Review identifier.'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Review sentiment (for example POSITIVE).'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesMovieReviewsResponse', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Movie slug.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Review set type (for example critic).'}, 'reviews': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesMovieReviewsResponseReviewsItem'}}, {'type': 'null'}], 'title': 'Reviews', 'default': None, 'description': 'Review entries with quote, sentiment, critic, and publication.'}, 'pageInfo': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesMovieReviewsResponsePageInfo'}, {'type': 'null'}], 'default': None, 'description': 'Pagination metadata for review listings.'}}, 'additionalProperties': True}
rotten-tomatoes.search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_rotten_tomatoesArguments', 'required': ['query'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 50, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of search results to return (1–50, default 20).'}, 'query': {'type': 'string', 'title': 'Query', 'maxLength': 256, 'description': 'Search query for movies, TV series, or celebrities.'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesSearchResponseMoviesItem': {'type': 'object', 'title': 'RottenTomatoesSearchResponseMoviesItem', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Slug for detail lookups (for example inception or breaking-bad).'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Result type (movie, tv, or celebrity).'}, 'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Tomatometer or list score when available.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Display title.'}, 'scoreSentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scoresentiment', 'default': None, 'description': 'Score sentiment (for example POSITIVE).'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesSearchResponse', 'properties': {'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Echo of the search query.'}, 'movies': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesSearchResponseMoviesItem'}}, {'type': 'null'}], 'title': 'Movies', 'default': None, 'description': 'Search hits (movies, TV series, or celebrities). Each entry includes type, slug, title, url, posterUrl, score, and cast when available.'}}, 'additionalProperties': True}
rotten-tomatoes.tv_show_cast_and_crew
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_tv_show_cast_and_crewArguments', 'required': ['tv_show_slug'], 'properties': {'tv_show_slug': {'type': 'string', 'title': 'Tv Show Slug', 'maxLength': 512, 'description': 'TV series slug (for example breaking-bad).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesTvShowCastAndCrewResponseCastItem': {'type': 'object', 'title': 'RottenTomatoesTvShowCastAndCrewResponseCastItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Rotten Tomatoes profile or title URL.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Person name.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'Celebrity slug when available.'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesTvShowCastAndCrewResponse', 'properties': {'cast': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesTvShowCastAndCrewResponseCastItem'}}, {'type': 'null'}], 'title': 'Cast', 'default': None, 'description': 'Cast and crew credits for the series.'}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'TV series slug.'}}, 'additionalProperties': True}
rotten-tomatoes.tv_show_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_tv_show_detailsArguments', 'required': ['tv_show_slug'], 'properties': {'tv_show_slug': {'type': 'string', 'title': 'Tv Show Slug', 'maxLength': 512, 'description': 'TV series slug (for example breaking-bad).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesTvShowDetailsResponseTomatometer': {'type': 'object', 'title': 'RottenTomatoesTvShowDetailsResponseTomatometer', 'properties': {'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Numeric score.'}, 'scoreRaw': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scoreraw', 'default': None, 'description': 'Formatted score string (for example 89%).'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Score sentiment (for example POSITIVE).'}}, 'additionalProperties': True}, 'RottenTomatoesTvShowDetailsResponsePopcornmeter': {'type': 'object', 'title': 'RottenTomatoesTvShowDetailsResponsePopcornmeter', 'properties': {'score': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Score', 'default': None, 'description': 'Numeric score.'}, 'scoreRaw': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Scoreraw', 'default': None, 'description': 'Formatted score string (for example 89%).'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Score sentiment (for example POSITIVE).'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesTvShowDetailsResponse', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'TV series slug.'}, 'year': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Year', 'default': None, 'description': 'Years on air (for example 2008 - 2013).'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Series title.'}, 'tomatometer': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesTvShowDetailsResponseTomatometer'}, {'type': 'null'}], 'default': None, 'description': 'Average Tomatometer score and metadata.'}, 'popcornmeter': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesTvShowDetailsResponsePopcornmeter'}, {'type': 'null'}], 'default': None, 'description': 'Average Popcornmeter score and metadata.'}}, 'additionalProperties': True}
rotten-tomatoes.tv_show_episode
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_tv_show_episodeArguments', 'required': ['tv_show_slug', 'season_number', 'episode_number'], 'properties': {'tv_show_slug': {'type': 'string', 'title': 'Tv Show Slug', 'maxLength': 512, 'description': 'TV series slug (for example breaking-bad).'}, 'season_number': {'type': 'string', 'title': 'Season Number', 'maxLength': 2, 'description': 'Season number as one or two digits (for example 1 or 01).'}, 'episode_number': {'type': 'string', 'title': 'Episode Number', 'maxLength': 2, 'description': 'Episode number as one or two digits (for example 1 or 01).'}}}
Esquema de salida
{'type': 'object', 'title': 'RottenTomatoesTvShowEpisodesResponse', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'TV series slug.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Episode title.'}, 'season': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Season', 'default': None, 'description': 'Season number.'}, 'episode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Episode', 'default': None, 'description': 'Episode number.'}}, 'additionalProperties': True}
rotten-tomatoes.tv_show_season
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_tv_show_seasonArguments', 'required': ['tv_show_slug', 'season_number'], 'properties': {'tv_show_slug': {'type': 'string', 'title': 'Tv Show Slug', 'maxLength': 512, 'description': 'TV series slug (for example breaking-bad).'}, 'season_number': {'type': 'string', 'title': 'Season Number', 'maxLength': 2, 'description': 'Season number as one or two digits (for example 1 or 01).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesTvShowSeasonsResponseEpisodesItem': {'type': 'object', 'title': 'RottenTomatoesTvShowSeasonsResponseEpisodesItem', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Episode title.'}, 'episode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Episode', 'default': None, 'description': 'Episode number.'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesTvShowSeasonsResponse', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'TV series slug.'}, 'season': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Season', 'default': None, 'description': 'Season identifier.'}, 'episodes': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesTvShowSeasonsResponseEpisodesItem'}}, {'type': 'null'}], 'title': 'Episodes', 'default': None, 'description': 'Episodes in the season when listed.'}}, 'additionalProperties': True}
rotten-tomatoes.tv_show_season_reviews
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.
Esquema de entrada
{'type': 'object', 'title': 'get_rotten_tomatoes_tv_show_season_reviewsArguments', 'required': ['tv_show_slug', 'season_number'], 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 50, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of review pages to return (1–50, default 20).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response pageInfo.endCursor field.'}, 'review_type': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Review Type', 'default': None, 'description': 'Review filter. Use critic for critic reviews; omit for the default set.'}, 'tv_show_slug': {'type': 'string', 'title': 'Tv Show Slug', 'maxLength': 512, 'description': 'TV series slug (for example breaking-bad).'}, 'season_number': {'type': 'string', 'title': 'Season Number', 'maxLength': 2, 'description': 'Season number as one or two digits (for example 1 or 01).'}}}
Esquema de salida
{'type': 'object', '$defs': {'RottenTomatoesTvShowSeasonReviewsResponsePageInfo': {'type': 'object', 'title': 'RottenTomatoesTvShowSeasonReviewsResponsePageInfo', 'properties': {'endCursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Endcursor', 'default': None, 'description': 'Cursor for the next page of reviews.'}, 'hasNextPage': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasnextpage', 'default': None, 'description': 'Whether more review pages are available.'}}, 'additionalProperties': True}, 'RottenTomatoesTvShowSeasonReviewsResponseReviewsItem': {'type': 'object', 'title': 'RottenTomatoesTvShowSeasonReviewsResponseReviewsItem', 'properties': {'quote': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Quote', 'default': None, 'description': 'Review excerpt or quote.'}, 'reviewId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Reviewid', 'default': None, 'description': 'Review identifier.'}, 'sentiment': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sentiment', 'default': None, 'description': 'Review sentiment (for example POSITIVE).'}}, 'additionalProperties': True}}, 'title': 'RottenTomatoesTvShowSeasonReviewsResponse', 'properties': {'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Slug', 'default': None, 'description': 'TV series slug.'}, 'season': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Season', 'default': None, 'description': 'Season number.'}, 'reviews': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/RottenTomatoesTvShowSeasonReviewsResponseReviewsItem'}}, {'type': 'null'}], 'title': 'Reviews', 'default': None, 'description': 'Review entries with quote, sentiment, critic, and publication.'}, 'pageInfo': {'anyOf': [{'$ref': '#/$defs/RottenTomatoesTvShowSeasonReviewsResponsePageInfo'}, {'type': 'null'}], 'default': None, 'description': 'Pagination metadata for review listings.'}}, 'additionalProperties': True}
seo.backlinks
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.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_backlinksArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'maxLength': 2048, 'description': 'Public website URL to check for backlinks.'}, 'include_subdomains': {'type': 'boolean', 'title': 'Include Subdomains', 'default': True, 'description': 'When true (default), include backlinks to the domain and its subdomains. When false, analyze only the exact URL.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SeoBacklinkCheckerResponseOverview': {'type': 'object', 'title': 'SeoBacklinkCheckerResponseOverview', 'properties': {'backlinks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Backlinks', 'default': None, 'description': 'Total backlinks found.'}, 'urlRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Urlrating', 'default': None, 'description': 'URL rating for the target.'}, 'domainRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Domainrating', 'default': None, 'description': 'Domain authority score for the target.'}, 'referringDomains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Referringdomains', 'default': None, 'description': 'Number of referring domains.'}}, 'additionalProperties': True}, 'SeoBacklinkCheckerResponseBacklinksItem': {'type': 'object', 'title': 'SeoBacklinkCheckerResponseBacklinksItem', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Title of the linking page.'}, 'urlTo': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Urlto', 'default': None, 'description': 'Target URL receiving the backlink.'}, 'anchor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Anchor', 'default': None, 'description': 'Anchor text of the backlink.'}, 'urlFrom': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Urlfrom', 'default': None, 'description': 'URL of the page containing the backlink.'}, 'domainRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Domainrating', 'default': None, 'description': 'Domain rating of the linking page.'}}, 'additionalProperties': True}}, 'title': 'SeoBacklinkCheckerResponse', 'properties': {'overview': {'anyOf': [{'$ref': '#/$defs/SeoBacklinkCheckerResponseOverview'}, {'type': 'null'}], 'default': None, 'description': 'Aggregate backlink statistics for the target.'}, 'backlinks': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SeoBacklinkCheckerResponseBacklinksItem'}}, {'type': 'null'}], 'title': 'Backlinks', 'default': None, 'description': 'Individual backlink records with anchor text and source URLs.'}}, 'additionalProperties': True}
seo.basic_metrics
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.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_basic_metricsArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'maxLength': 2048, 'description': 'Public website URL to analyze (for example https://example.com).'}}}
Esquema de salida
{'type': 'object', 'title': 'SeoBasicMetricsResponse', 'properties': {'ahRank': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Ahrank', 'default': None, 'description': 'Global website rank (lower is stronger).'}, 'domainRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Domainrating', 'default': None, 'description': 'Domain authority score from 0 to 100.'}}, 'additionalProperties': True}
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.
Esquema de entrada
{'type': 'object', 'title': 'list_seo_country_codesArguments', 'properties': {}}
Esquema de salida
{'type': 'object', 'title': 'SeoCountryCodesResponse', 'properties': {'country_codes': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Country Codes', 'default': None, 'description': 'Supported ISO country codes for keyword metrics.'}}, 'additionalProperties': True}
seo.keyword_metrics
Get SEO metrics for a search keyword in a specific country market. Returns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential. Cost = 10 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_keyword_metricsArguments', 'required': ['keyword'], 'properties': {'country': {'type': 'string', 'title': 'Country', 'default': 'us', 'maxLength': 2, 'description': '2-letter ISO country code for the target market (default us). Use seo.country_codes for supported values.'}, 'keyword': {'type': 'string', 'title': 'Keyword', 'maxLength': 512, 'description': 'Search keyword or phrase to analyze.'}}}
Esquema de salida
{'type': 'object', 'title': 'SeoKeywordMetricsResponse', 'properties': {'cpc': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Cpc', 'default': None, 'description': 'Estimated cost per click in paid search.'}, 'clicks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Clicks', 'default': None, 'description': 'Estimated monthly clicks from organic search.'}, 'keyword': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Keyword', 'default': None, 'description': 'Analyzed keyword.'}, 'difficulty': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Difficulty', 'default': None, 'description': 'Keyword difficulty score (higher is harder to rank).'}, 'searchVolume': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Searchvolume', 'default': None, 'description': 'Estimated monthly search volume in the selected country.'}, 'trafficPotential': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Trafficpotential', 'default': None, 'description': 'Estimated traffic potential if ranking well.'}, 'globalSearchVolume': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Globalsearchvolume', 'default': None, 'description': 'Estimated global monthly search volume.'}}, 'additionalProperties': True}
seo.url_metrics
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.
Esquema de entrada
{'type': 'object', 'title': 'get_seo_url_metricsArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'maxLength': 2048, 'description': 'Public page URL to analyze.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SeoUrlMetricsResponsePage': {'type': 'object', 'title': 'SeoUrlMetricsResponsePage', 'properties': {'traffic': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Traffic', 'default': None, 'description': 'Estimated organic traffic for the page.'}, 'backlinks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Backlinks', 'default': None, 'description': 'Backlinks pointing to the page.'}, 'urlRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Urlrating', 'default': None, 'description': 'URL rating score for the page.'}, 'refDomains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Refdomains', 'default': None, 'description': 'Referring domains for the page.'}}, 'additionalProperties': True}, 'SeoUrlMetricsResponseDomain': {'type': 'object', 'title': 'SeoUrlMetricsResponseDomain', 'properties': {'traffic': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Traffic', 'default': None, 'description': 'Estimated organic traffic for the domain.'}, 'backlinks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Backlinks', 'default': None, 'description': 'Total backlinks for the domain.'}, 'refDomains': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Refdomains', 'default': None, 'description': 'Referring domains for the domain.'}, 'domainRating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Domainrating', 'default': None, 'description': 'Domain authority score from 0 to 100.'}}, 'additionalProperties': True}}, 'title': 'SeoUrlMetricsResponse', 'properties': {'page': {'anyOf': [{'$ref': '#/$defs/SeoUrlMetricsResponsePage'}, {'type': 'null'}], 'default': None, 'description': 'Metrics for the requested page URL.'}, 'domain': {'anyOf': [{'$ref': '#/$defs/SeoUrlMetricsResponseDomain'}, {'type': 'null'}], 'default': None, 'description': 'Metrics for the parent domain.'}}, 'additionalProperties': True}
tiktok.comment_replies
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.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_comment_repliesArguments', 'required': ['video_id', 'comment_id'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 40, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of replies to return (max 40).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'video_id': {'type': 'string', 'title': 'Video Id', 'maxLength': 32, 'description': 'TikTok video id.'}, 'comment_id': {'type': 'string', 'title': 'Comment Id', 'maxLength': 32, 'description': 'TikTok comment id.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokCommentRepliesResponseData': {'type': 'object', 'title': 'GetTiktokCommentRepliesResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokCommentRepliesResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokCommentRepliesResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.download_music
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.
Esquema de entrada
{'type': 'object', 'title': 'download_tiktok_musicArguments', 'properties': {'music_id': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Music Id', 'default': None, 'description': 'TikTok music id.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.'}, 'music_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Music Url', 'default': None, 'description': 'TikTok music page URL.'}}}
Esquema de salida
{'type': 'object', 'title': 'DownloadTiktokMusicResponse', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'file_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the file was stored.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved agent download session.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type of the music file.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Music file size in bytes.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}, 'tiktok_download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tiktok Download Id', 'default': None, 'description': 'Unique TikTok download operation identifier, prefix td_.'}}, 'additionalProperties': True}
tiktok.download_music_from_video
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.
Esquema de entrada
{'type': 'object', 'title': 'download_tiktok_music_from_videoArguments', 'properties': {'video_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'TikTok video id.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.'}, 'video_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Video Url', 'default': None, 'description': 'TikTok video URL.'}}}
Esquema de salida
{'type': 'object', 'title': 'DownloadTiktokMusicFromVideoResponse', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'file_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the file was stored.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved agent download session.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type of the music file.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Music file size in bytes.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}, 'tiktok_download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tiktok Download Id', 'default': None, 'description': 'Unique TikTok download operation identifier, prefix td_.'}}, 'additionalProperties': True}
tiktok.download_video
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.
Esquema de entrada
{'type': 'object', 'title': 'download_tiktok_videoArguments', 'properties': {'quality': {'enum': ['standard', 'hd'], 'type': 'string', 'title': 'Quality', 'default': 'standard', 'description': "Video quality to download. 'standard' is default quality; 'hd' is high definition. Only one selected quality is downloaded."}, 'video_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'TikTok video id.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the video. If omitted, the file is stored under downloads/ with a generated name.'}, 'video_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Video Url', 'default': None, 'description': 'TikTok video URL.'}}}
Esquema de salida
{'type': 'object', 'title': 'DownloadTiktokVideoResponse', 'properties': {'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'quality': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Quality', 'default': None, 'description': 'Echo of the requested video quality (standard or hd).'}, 'file_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the file was stored.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved agent download session.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type of the downloaded file.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Downloaded file size in bytes.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}, 'tiktok_download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tiktok Download Id', 'default': None, 'description': 'Unique TikTok download operation identifier, prefix td_.'}}, 'additionalProperties': True}
tiktok.for_you_feed
Fetch for-you feed videos for a region. Requires region. Cost = 4 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_for_you_feedArguments', 'required': ['region'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 20, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of videos to return (max 20).'}, 'region': {'type': 'string', 'title': 'Region', 'maxLength': 8, 'description': 'Region code (for example us, jp, kr).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokForYouFeedResponseDataItem': {'type': 'object', 'title': 'GetTiktokForYouFeedResponseDataItem', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Video title or caption.'}, 'video_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'TikTok video id.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokForYouFeedResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetTiktokForYouFeedResponseDataItem'}}, {'type': 'null'}], 'title': 'Data', 'default': None, 'description': 'For-you feed videos from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.music_details
Look up metadata for a TikTok music track. Provide either music_id or music_url, not both. Cost = 2 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_music_detailsArguments', 'properties': {'music_id': {'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}], 'title': 'Music Id', 'default': None, 'description': 'TikTok music id.'}, 'music_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Music Url', 'default': None, 'description': 'TikTok music page URL.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokMusicDetailsResponseData': {'type': 'object', 'title': 'GetTiktokMusicDetailsResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokMusicDetailsResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokMusicDetailsResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.music_videos
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.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_music_videosArguments', 'required': ['music_id'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'music_id': {'type': 'string', 'title': 'Music Id', 'maxLength': 64, 'description': 'TikTok music id.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokMusicVideosResponseData': {'type': 'object', 'title': 'GetTiktokMusicVideosResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokMusicVideosResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokMusicVideosResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.search_photos
Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'search_tiktok_photosArguments', 'required': ['query'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Region code (for example us, jp, kr).'}}}
Esquema de salida
{'type': 'object', '$defs': {'SearchTiktokPhotosResponseData': {'type': 'object', 'title': 'SearchTiktokPhotosResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'SearchTiktokPhotosResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/SearchTiktokPhotosResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.search_users
Search TikTok users by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'search_tiktok_usersArguments', 'required': ['query'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'follower_count': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Follower Count', 'default': '0', 'description': 'Follower count filter: 0-4.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SearchTiktokUsersResponseData': {'type': 'object', 'title': 'SearchTiktokUsersResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'SearchTiktokUsersResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/SearchTiktokUsersResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.search_videos
Search TikTok videos by keyword. Requires query. Pass cursor from a previous response to fetch the next page. Cost = 5 tokens.
Esquema de entrada
{'type': 'object', 'title': 'search_tiktok_videosArguments', 'required': ['query'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'region': {'anyOf': [{'type': 'string', 'maxLength': 8}, {'type': 'null'}], 'title': 'Region', 'default': None, 'description': 'Region code (for example us, jp, kr).'}, 'sort_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Sort By', 'default': 'relevance', 'description': 'Sort order: relevance, like_count, or date_posted.'}, 'publish_time': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Publish Time', 'default': None, 'description': 'Publish time filter: 0, 1, 7, 30, 90, or 180.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SearchTiktokVideosResponseData': {'type': 'object', 'title': 'SearchTiktokVideosResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'SearchTiktokVideosResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/SearchTiktokVideosResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.user_followers
List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_user_followersArguments', 'required': ['user_id'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 200, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 200).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'user_id': {'type': 'string', 'title': 'User Id', 'maxLength': 128, 'description': 'TikTok numeric user id.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokUserFollowersResponseData': {'type': 'object', 'title': 'GetTiktokUserFollowersResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokUserFollowersResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokUserFollowersResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.user_following
List accounts a TikTok user follows. Requires user_id. Pass cursor from a previous response to fetch the next page. Cost = 2 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_user_followingArguments', 'required': ['user_id'], 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 200, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 200).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'user_id': {'type': 'string', 'title': 'User Id', 'maxLength': 128, 'description': 'TikTok numeric user id.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokUserFollowingResponseData': {'type': 'object', 'title': 'GetTiktokUserFollowingResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokUserFollowingResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokUserFollowingResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.user_info
Look up a TikTok user profile. Provide either user_id or unique_id, not both. Cost = 2 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_user_infoArguments', 'properties': {'user_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'TikTok numeric user id.'}, 'unique_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Unique Id', 'default': None, 'description': 'TikTok unique id (username).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokUserInfoResponseData': {'type': 'object', 'title': 'GetTiktokUserInfoResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokUserInfoResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokUserInfoResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.user_reposts
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.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_user_repostsArguments', 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'user_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'TikTok numeric user id.'}, 'unique_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Unique Id', 'default': None, 'description': 'TikTok unique id (username).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokUserRepostsResponseData': {'type': 'object', 'title': 'GetTiktokUserRepostsResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokUserRepostsResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokUserRepostsResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.user_videos
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.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_user_videosArguments', 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 30, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of items to return (max 30).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'latest': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Latest', 'default': True, 'description': 'When true, return latest videos. When false, return top videos.'}, 'user_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'TikTok numeric user id.'}, 'unique_id': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Unique Id', 'default': None, 'description': 'TikTok unique id (username).'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokUserVideosResponseData': {'type': 'object', 'title': 'GetTiktokUserVideosResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokUserVideosResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokUserVideosResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.video_comments
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.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_video_commentsArguments', 'properties': {'count': {'anyOf': [{'type': 'integer', 'maximum': 50, 'minimum': 1}, {'type': 'null'}], 'title': 'Count', 'default': None, 'description': 'Number of comments to return (max 50).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response.'}, 'video_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'TikTok video id.'}, 'video_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Video Url', 'default': None, 'description': 'TikTok video URL.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokVideoCommentsResponseData': {'type': 'object', 'title': 'GetTiktokVideoCommentsResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokVideoCommentsResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokVideoCommentsResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
tiktok.video_details
Look up metadata for a TikTok video. Provide either video_id or video_url, not both. Cost = 1 token.
Esquema de entrada
{'type': 'object', 'title': 'get_tiktok_video_detailsArguments', 'properties': {'video_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'TikTok video id.'}, 'video_url': {'anyOf': [{'type': 'string', 'maxLength': 2048}, {'type': 'null'}], 'title': 'Video Url', 'default': None, 'description': 'TikTok video URL.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetTiktokVideoDetailsResponseData': {'type': 'object', 'title': 'GetTiktokVideoDetailsResponseData', 'properties': {'total': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Total', 'default': None, 'description': 'Total result count when provided by the upstream provider.'}, 'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor when returned by the provider.'}, 'hasMore': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasmore', 'default': None, 'description': 'Whether additional pages are available.'}}, 'additionalProperties': True}}, 'title': 'GetTiktokVideoDetailsResponse', 'properties': {'msg': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Msg', 'default': None, 'description': 'Upstream status message.'}, 'code': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Code', 'default': None, 'description': 'Upstream status code (0 = success).'}, 'data': {'anyOf': [{'$ref': '#/$defs/GetTiktokVideoDetailsResponseData'}, {'type': 'null'}], 'default': None, 'description': 'Capability-specific payload from the upstream provider.'}, 'processed_time': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'title': 'Processed Time', 'default': None, 'description': 'Upstream processing time in seconds.'}}, 'additionalProperties': True}
website-screenshots.capture
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.
Esquema de entrada
{'type': 'object', 'title': 'capture_website_screenshotArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url', 'maxLength': 2048, 'description': 'Public http or https URL to capture. Private, localhost, and internal network addresses are blocked.'}, 'format': {'enum': ['png', 'jpeg'], 'type': 'string', 'title': 'Format', 'default': 'png', 'description': "Output image format. 'png' preserves lossless quality (default). 'jpeg' produces smaller files."}, 'quality': {'type': 'integer', 'title': 'Quality', 'default': 80, 'maximum': 100, 'minimum': 0, 'description': "JPEG compression quality from 0 (smallest) to 100 (best). Only applies when format is 'jpeg'; ignored for PNG."}, 'dark_mode': {'type': 'boolean', 'title': 'Dark Mode', 'default': False, 'description': 'When true, emulate prefers-color-scheme: dark so sites with dark-mode CSS render in dark mode. Has no effect on sites without dark-mode styling.'}, 'file_name': {'anyOf': [{'type': 'string', 'maxLength': 255}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Optional account-relative storage path for the screenshot. If omitted, the file is stored under downloads/ with a generated name.'}, 'full_page': {'type': 'boolean', 'title': 'Full Page', 'default': False, 'description': 'Capture the full scrollable page. When false, only the viewport area is captured.'}, 'wait_until': {'enum': ['load', 'domcontentloaded', 'networkidle'], 'type': 'string', 'title': 'Wait Until', 'default': 'domcontentloaded', 'description': "When to take the screenshot: 'load' (load event), 'domcontentloaded' (DOM ready, faster; use with post_load_wait to let the page settle), or 'networkidle' (no network activity for 500ms; can time out on pages with ongoing requests)."}, 'post_load_wait': {'type': 'integer', 'title': 'Post Load Wait', 'default': 0, 'maximum': 20, 'minimum': 0, 'description': 'Extra seconds to wait after wait_until before capturing. Only valid when wait_until is domcontentloaded. Use this instead of networkidle when pages keep network activity.'}, 'viewport_width': {'type': 'integer', 'title': 'Viewport Width', 'default': 1280, 'maximum': 3840, 'minimum': 320, 'description': 'Browser viewport width in pixels.'}, 'timeout_seconds': {'type': 'integer', 'title': 'Timeout Seconds', 'default': 30, 'maximum': 60, 'minimum': 5, 'description': 'Maximum seconds to wait for the page to load before failing.'}, 'viewport_height': {'type': 'integer', 'title': 'Viewport Height', 'default': 720, 'maximum': 2160, 'minimum': 240, 'description': 'Browser viewport height in pixels.'}, 'block_cookie_banners': {'type': 'boolean', 'title': 'Block Cookie Banners', 'default': False, 'description': 'When true, attempt to dismiss common cookie consent banners and overlays before capture. Best-effort - custom or first-party banners may remain.'}}}
Esquema de salida
{'type': 'object', 'title': 'WebsiteScreenshotResponse', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Echo of requested URL.'}, 'format': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Format', 'default': None, 'description': 'Echo of the requested output format (png or jpeg).'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Always "completed" for synchronous capture.'}, 'command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Command', 'default': None, 'description': 'Suggested terminal command for downloading to a local path.'}, 'quality': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Quality', 'default': None, 'description': 'Echo of JPEG quality used when format is jpeg.'}, 'dark_mode': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Dark Mode', 'default': None, 'description': 'Echo of whether dark color scheme emulation was used.'}, 'file_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'File Name', 'default': None, 'description': 'Account-relative path where the screenshot was stored.'}, 'full_page': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Full Page', 'default': None, 'description': 'Whether full page was captured.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'ISO 8601 timestamp.'}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None, 'description': 'ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).'}, 'download_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Id', 'default': None, 'description': 'Stable identifier for the reserved download.'}, 'download_code': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Download Code', 'default': None, 'description': 'Short code to pass to the @vee3/cli `vee3-get-file` command.'}, 'screenshot_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screenshot Id', 'default': None, 'description': 'Unique identifier, prefix ss_.'}, 'retained_until': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Retained Until', 'default': None, 'description': 'ISO 8601 timestamp when account storage retention expires.'}, 'screenshot_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screenshot Url', 'default': None, 'description': 'Signed download URL from account file storage.'}, 'viewport_width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Viewport Width', 'default': None, 'description': 'Actual viewport width used.'}, 'file_size_bytes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'File Size Bytes', 'default': None, 'description': 'Image file size in bytes.'}, 'install_command': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Install Command', 'default': None, 'description': 'One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.'}, 'troubleshooting': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Troubleshooting', 'default': None, 'description': "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps."}, 'viewport_height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Viewport Height', 'default': None, 'description': 'Actual viewport height used.'}, 'block_cookie_banners': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Block Cookie Banners', 'default': None, 'description': 'Echo of whether cookie banner dismissal was attempted.'}}, 'additionalProperties': True}
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 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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_connected_accountsArguments', 'properties': {}}
Esquema de salida
{'type': 'object', '$defs': {'GetXConnectedAccountsResponseAccountsItem': {'type': 'object', 'title': 'GetXConnectedAccountsResponseAccountsItem', 'properties': {'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id to pass as user_id on write calls.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle without the leading @ to pass as user_name on write calls.'}, 'avatar_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Avatar Url', 'default': None, 'description': 'Profile avatar image URL.'}, 'is_default': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Is Default', 'default': None, 'description': 'Whether this account is used when user_id and user_name are omitted on write calls.'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Name', 'default': None, 'description': 'Display name shown on the profile.'}}, 'additionalProperties': True}}, 'title': 'GetXConnectedAccountsResponse', 'properties': {'accounts': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXConnectedAccountsResponseAccountsItem'}}, {'type': 'null'}], 'title': 'Accounts', 'default': None, 'description': 'Active connected X accounts for the authenticated Vee3 account.'}}, 'additionalProperties': True}
x-twitter.create_bookmark
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.
Esquema de entrada
{'type': 'object', 'title': 'create_x_bookmarkArguments', 'required': ['post_id'], 'properties': {'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the post to bookmark.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', 'title': 'CreateXBookmarkResponse', 'properties': {'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}, 'bookmarked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Bookmarked', 'default': None, 'description': 'Whether the post is bookmarked after this request.'}}, 'additionalProperties': True}
x-twitter.create_post
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.
Esquema de entrada
{'type': 'object', 'title': 'create_x_postArguments', 'properties': {'poll': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Poll', 'default': None, 'description': 'Poll object with options (2-4 strings) and duration_minutes (5-10080).'}, 'text': {'anyOf': [{'type': 'string', 'maxLength': 25000}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Post text content. At least one of text, poll, media, or card_uri is required.'}, 'media': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Media', 'default': None, 'maxItems': 4, 'minItems': 1, 'description': 'File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file and @vee3/upload first, then list_uploaded_files to get the stored file_name values.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'card_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Card Uri', 'default': None, 'description': 'Card URI for the post. Mutually exclusive with poll and media.'}, 'nullcast': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Nullcast', 'default': None, 'description': 'Whether the post is promoted-only and hidden from the public timeline.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'community_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Community Id', 'default': None, 'description': 'Community id when posting to an X community.'}, 'made_with_ai': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Made With Ai', 'default': None, 'description': 'Whether the post contains AI-generated media.'}, 'reply_settings': {'anyOf': [{'enum': ['following', 'mentionedUsers', 'subscribers', 'verified'], 'type': 'string'}, {'type': 'null'}], 'title': 'Reply Settings', 'default': None, 'description': 'Who can reply to the post.'}, 'paid_partnership': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Paid Partnership', 'default': None, 'description': 'Whether the post is a paid partnership.'}, 'share_with_followers': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Share With Followers', 'default': None, 'description': 'Whether to share a community post with followers too.'}, 'direct_message_deep_link': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Direct Message Deep Link', 'default': None, 'description': 'Deep link that moves the conversation into Direct Messages.'}, 'for_super_followers_only': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'For Super Followers Only', 'default': None, 'description': 'Whether the post is exclusive to super followers.'}}}
Esquema de salida
{'type': 'object', 'title': 'CreateXPostResponse', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Post text returned by the X API.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account that published the post.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric id of the created or edited post.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account that published the post.'}}, 'additionalProperties': True}
x-twitter.delete_bookmark
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_x_bookmarkArguments', 'required': ['post_id'], 'properties': {'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the bookmarked post to remove.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', 'title': 'DeleteXBookmarkResponse', 'properties': {'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}, 'bookmarked': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Bookmarked', 'default': None, 'description': 'Whether the post is bookmarked after this request.'}}, 'additionalProperties': True}
x-twitter.delete_post
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.
Esquema de entrada
{'type': 'object', 'title': 'delete_x_postArguments', 'required': ['post_id'], 'properties': {'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the post to delete.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', 'title': 'DeleteXPostResponse', 'properties': {'deleted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Deleted', 'default': None, 'description': 'Whether the post was deleted.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}}, 'additionalProperties': True}
x-twitter.edit_post
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.
Esquema de entrada
{'type': 'object', 'title': 'edit_x_postArguments', 'required': ['post_id'], 'properties': {'text': {'anyOf': [{'type': 'string', 'maxLength': 25000}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Updated post text.'}, 'media': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Media', 'default': None, 'maxItems': 4, 'minItems': 1, 'description': 'File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file first.'}, 'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the post to edit.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'made_with_ai': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Made With Ai', 'default': None, 'description': 'Whether the post contains AI-generated media.'}, 'paid_partnership': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Paid Partnership', 'default': None, 'description': 'Whether the post is a paid partnership.'}}}
Esquema de salida
{'type': 'object', 'title': 'EditXPostResponse', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Post text returned by the X API.'}, 'post_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Post Id', 'default': None, 'description': 'Numeric id of the edited post returned by the X API.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}}, 'additionalProperties': True}
x-twitter.get_bookmarks
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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_bookmarksArguments', 'properties': {'limit': {'anyOf': [{'type': 'integer', 'maximum': 100, 'minimum': 1}, {'type': 'null'}], 'title': 'Limit', 'default': None, 'description': 'Maximum number of bookmarks to return (default 20, max 100).'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response next_cursor field.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetXBookmarksResponseDataItem': {'type': 'object', 'title': 'GetXBookmarksResponseDataItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Numeric post id.'}, 'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Post text.'}, 'author_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Author Id', 'default': None, 'description': 'Numeric author user id.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Post creation timestamp.'}}, 'additionalProperties': True}, 'GetXBookmarksResponseIncludes': {'type': 'object', 'title': 'GetXBookmarksResponseIncludes', 'properties': {'users': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXBookmarksResponseIncludesUsersItem'}}, {'type': 'null'}], 'title': 'Users', 'default': None, 'description': 'Expanded user objects.'}}, 'additionalProperties': True}, 'GetXBookmarksResponseIncludesUsersItem': {'type': 'object', 'title': 'GetXBookmarksResponseIncludesUsersItem', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Numeric user id.'}, 'username': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Username', 'default': None, 'description': 'X handle.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the user is verified.'}}, 'additionalProperties': True}}, 'title': 'GetXBookmarksResponse', 'properties': {'data': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXBookmarksResponseDataItem'}}, {'type': 'null'}], 'title': 'Data', 'default': None, 'description': 'Bookmarked posts returned by the X API.'}, 'includes': {'anyOf': [{'$ref': '#/$defs/GetXBookmarksResponseIncludes'}, {'type': 'null'}], 'default': None, 'description': 'Expanded users, media, polls, places, and referenced posts.'}, 'next_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Next Cursor', 'default': None, 'description': 'Cursor for the next page of bookmarks, when available.'}, 'result_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Result Count', 'default': None, 'description': 'Number of bookmarks in this page.'}}, 'additionalProperties': True}
x-twitter.reply_to_post
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.
Esquema de entrada
{'type': 'object', 'title': 'reply_to_x_postArguments', 'required': ['reply_to_post_id'], 'properties': {'poll': {'anyOf': [{'type': 'object', 'additionalProperties': True}, {'type': 'null'}], 'title': 'Poll', 'default': None, 'description': 'Poll object with options (2-4 strings) and duration_minutes (5-10080).'}, 'text': {'anyOf': [{'type': 'string', 'maxLength': 25000}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Reply text content. At least one of text, poll, media, or card_uri is required.'}, 'media': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Media', 'default': None, 'maxItems': 4, 'minItems': 1, 'description': 'File names from files.list_uploaded_files to attach (up to 4).'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'card_uri': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Card Uri', 'default': None, 'description': 'Card URI for the post. Mutually exclusive with poll and media.'}, 'nullcast': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Nullcast', 'default': None, 'description': 'Whether the post is promoted-only and hidden from the public timeline.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'community_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Community Id', 'default': None, 'description': 'Community id when posting to an X community.'}, 'made_with_ai': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Made With Ai', 'default': None, 'description': 'Whether the post contains AI-generated media.'}, 'reply_settings': {'anyOf': [{'enum': ['following', 'mentionedUsers', 'subscribers', 'verified'], 'type': 'string'}, {'type': 'null'}], 'title': 'Reply Settings', 'default': None, 'description': 'Who can reply to the post.'}, 'paid_partnership': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Paid Partnership', 'default': None, 'description': 'Whether the post is a paid partnership.'}, 'reply_to_post_id': {'type': 'string', 'title': 'Reply To Post Id', 'description': 'Numeric id of the post to reply to.'}, 'share_with_followers': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Share With Followers', 'default': None, 'description': 'Whether to share a community post with followers too.'}, 'exclude_reply_user_ids': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Exclude Reply User Ids', 'default': None, 'description': 'User ids to exclude from the reply mention list.'}, 'direct_message_deep_link': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Direct Message Deep Link', 'default': None, 'description': 'Deep link that moves the conversation into Direct Messages.'}, 'for_super_followers_only': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'For Super Followers Only', 'default': None, 'description': 'Whether the post is exclusive to super followers.'}, 'auto_populate_reply_metadata': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Auto Populate Reply Metadata', 'default': None, 'description': 'Whether to automatically populate reply metadata.'}}}
Esquema de salida
{'type': 'object', 'title': 'ReplyToXPostResponse', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Reply text returned by the X API.'}, 'post_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Post Id', 'default': None, 'description': 'Numeric id of the reply post.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}}, 'additionalProperties': True}
x-twitter.repost_post
Repost a post for a connected X account. Call x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account. Returns the reposted post_id and retweeted status. Cost = 75 tokens.
Esquema de entrada
{'type': 'object', 'title': 'repost_x_postArguments', 'required': ['post_id'], 'properties': {'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the post to repost.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', 'title': 'RepostXPostResponse', 'properties': {'post_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Post Id', 'default': None, 'description': 'Numeric id of the reposted post.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'retweeted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Retweeted', 'default': None, 'description': 'Whether the post was reposted.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}}, 'additionalProperties': True}
x-twitter.search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_xArguments', 'required': ['query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords or phrase.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response next_cursor field.'}, 'search_type': {'enum': ['Top', 'Latest', 'Media', 'People', 'Lists'], 'type': 'string', 'title': 'Search Type', 'default': 'Top', 'description': 'Result ranking mode.'}}}
Esquema de salida
{'type': 'object', '$defs': {'SearchXResponseTimelineItem': {'type': 'object', 'title': 'SearchXResponseTimelineItem', 'properties': {'lang': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Lang', 'default': None, 'description': 'Detected language code.'}, 'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Tweet body text.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Timeline entry type (for example tweet).'}, 'media': {'anyOf': [{'$ref': '#/$defs/SearchXResponseTimelineItemMedia'}, {'type': 'null'}], 'default': None, 'description': 'Attached media grouped by type (for example video and photo arrays) when present.'}, 'views': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'View count when provided by the upstream provider.'}, 'author': {'anyOf': [{'$ref': '#/$defs/SearchXResponseTimelineItemAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Author profile summary embedded in the timeline entry.'}, 'quotes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Quotes', 'default': None, 'description': 'Quote count.'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Source', 'default': None, 'description': 'Client or app source string from X.'}, 'replies': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Replies', 'default': None, 'description': 'Reply count.'}, 'entities': {'anyOf': [{'$ref': '#/$defs/SearchXResponseTimelineItemEntities'}, {'type': 'null'}], 'default': None, 'description': 'Parsed entities from the tweet text.'}, 'retweets': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retweets', 'default': None, 'description': 'Repost count.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id.'}, 'bookmarks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bookmarks', 'default': None, 'description': 'Bookmark count.'}, 'favorites': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Favorites', 'default': None, 'description': 'Like count.'}, 'user_info': {'anyOf': [{'$ref': '#/$defs/SearchXResponseTimelineItemUserInfo'}, {'type': 'null'}], 'default': None, 'description': 'Embedded author profile for the tweet.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Tweet creation timestamp from X.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'quoted_tweet': {'anyOf': [{'$ref': '#/$defs/SearchXResponseTimelineItemQuotedTweet'}, {'type': 'null'}], 'default': None, 'description': 'Quoted tweet summary when the post quotes another tweet.'}, 'conversation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Conversation Id', 'default': None, 'description': 'Conversation thread id for the tweet.'}, 'display_text_range': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Display Text Range', 'default': None, 'description': 'Start and end character indices for the display text range.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemMedia': {'type': 'object', 'title': 'SearchXResponseTimelineItemMedia', 'properties': {'photo': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemMediaPhotoItem'}}, {'type': 'null'}], 'title': 'Photo', 'default': None, 'description': 'Photo media items when present.'}, 'video': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemMediaVideoItem'}}, {'type': 'null'}], 'title': 'Video', 'default': None, 'description': 'Video media items when present.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemAuthor': {'type': 'object', 'title': 'SearchXResponseTimelineItemAuthor', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemEntities': {'type': 'object', 'title': 'SearchXResponseTimelineItemEntities', 'properties': {'urls': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemEntitiesUrlsItem'}}, {'type': 'null'}], 'title': 'Urls', 'default': None, 'description': 'URLs parsed from the tweet text.'}, 'hashtags': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemEntitiesHashtagsItem'}}, {'type': 'null'}], 'title': 'Hashtags', 'default': None, 'description': 'Hashtags parsed from the tweet text.'}, 'user_mentions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemEntitiesUserMentionsItem'}}, {'type': 'null'}], 'title': 'User Mentions', 'default': None, 'description': 'User mentions parsed from the tweet text.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemUserInfo': {'type': 'object', 'title': 'SearchXResponseTimelineItemUserInfo', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'avatar': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Profile avatar image URL.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the author account is verified.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'friends_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Friends Count', 'default': None, 'description': 'Following count when provided by the upstream provider.'}, 'followers_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Followers Count', 'default': None, 'description': 'Follower count when provided by the upstream provider.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemQuotedTweet': {'type': 'object', 'title': 'SearchXResponseTimelineItemQuotedTweet', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Quoted tweet body text.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id for the quoted post.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Quoted tweet author handle.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemMediaPhotoItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemMediaPhotoItem', 'properties': {'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the photo asset.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemMediaVideoItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemMediaVideoItem', 'properties': {'variants': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItemMediaVideoItemVariantsItem'}}, {'type': 'null'}], 'title': 'Variants', 'default': None, 'description': 'Available video quality variants when present.'}, 'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the video thumbnail or asset.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemEntitiesUrlsItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemEntitiesUrlsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Short or display URL.'}, 'display_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Url', 'default': None, 'description': 'Display-friendly URL.'}, 'expanded_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expanded Url', 'default': None, 'description': 'Expanded destination URL.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemEntitiesHashtagsItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemEntitiesHashtagsItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Hashtag text without the leading #.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemEntitiesUserMentionsItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemEntitiesUserMentionsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Mentioned user display name.'}, 'id_str': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id Str', 'default': None, 'description': 'Mentioned user id.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Mentioned user handle without the leading @.'}}, 'additionalProperties': True}, 'SearchXResponseTimelineItemMediaVideoItemVariantsItem': {'type': 'object', 'title': 'SearchXResponseTimelineItemMediaVideoItemVariantsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'HTTPS URL for the media variant.'}, 'bitrate': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bitrate', 'default': None, 'description': 'Video bitrate when provided.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type for the media variant.'}}, 'additionalProperties': True}}, 'title': 'SearchXResponse', 'properties': {'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Search status from the upstream provider (ok on success).'}, 'timeline': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/SearchXResponseTimelineItem'}}, {'type': 'null'}], 'title': 'Timeline', 'default': None, 'description': 'Matching posts from the search. Additional provider-specific fields may appear on each entry.'}, 'next_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Next Cursor', 'default': None, 'description': 'Cursor for the next results page, when available.'}, 'prev_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Prev Cursor', 'default': None, 'description': 'Cursor for the previous results page, when available.'}}, 'additionalProperties': True}
x-twitter.tweet_info
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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_tweet_infoArguments', 'required': ['id'], 'properties': {'id': {'type': 'string', 'title': 'Id', 'maxLength': 32, 'description': 'Numeric tweet id.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetXTweetInfoResponseMedia': {'type': 'object', 'title': 'GetXTweetInfoResponseMedia', 'properties': {'photo': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetInfoResponseMediaPhotoItem'}}, {'type': 'null'}], 'title': 'Photo', 'default': None, 'description': 'Photo media items when present.'}, 'video': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetInfoResponseMediaVideoItem'}}, {'type': 'null'}], 'title': 'Video', 'default': None, 'description': 'Video media items when present.'}}, 'additionalProperties': True}, 'GetXTweetInfoResponseAuthor': {'type': 'object', 'title': 'GetXTweetInfoResponseAuthor', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'image': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Image', 'default': None, 'description': 'Profile avatar image URL.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'blue_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Blue Verified', 'default': None, 'description': 'Whether the author has X blue verification.'}}, 'additionalProperties': True}, 'GetXTweetInfoResponseMediaPhotoItem': {'type': 'object', 'title': 'GetXTweetInfoResponseMediaPhotoItem', 'properties': {'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the photo asset.'}}, 'additionalProperties': True}, 'GetXTweetInfoResponseMediaVideoItem': {'type': 'object', 'title': 'GetXTweetInfoResponseMediaVideoItem', 'properties': {'variants': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetInfoResponseMediaVideoItemVariantsItem'}}, {'type': 'null'}], 'title': 'Variants', 'default': None, 'description': 'Available video quality variants when present.'}, 'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the video thumbnail or asset.'}}, 'additionalProperties': True}, 'GetXTweetInfoResponseMediaVideoItemVariantsItem': {'type': 'object', 'title': 'GetXTweetInfoResponseMediaVideoItemVariantsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'HTTPS URL for the media variant.'}, 'bitrate': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bitrate', 'default': None, 'description': 'Video bitrate when provided.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type for the media variant.'}}, 'additionalProperties': True}}, 'title': 'GetXTweetInfoResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Numeric tweet id.'}, 'lang': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Lang', 'default': None, 'description': 'Detected language code.'}, 'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Tweet body text.'}, 'likes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Likes', 'default': None, 'description': 'Like count.'}, 'media': {'anyOf': [{'$ref': '#/$defs/GetXTweetInfoResponseMedia'}, {'type': 'null'}], 'default': None, 'description': 'Attached media grouped by type (for example photo or video arrays). Additional provider-specific media fields may appear.'}, 'author': {'anyOf': [{'$ref': '#/$defs/GetXTweetInfoResponseAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Author profile summary for the tweet.'}, 'quotes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Quotes', 'default': None, 'description': 'Quote count.'}, 'replies': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Replies', 'default': None, 'description': 'Reply count.'}, 'retweets': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retweets', 'default': None, 'description': 'Repost count.'}, 'bookmarks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bookmarks', 'default': None, 'description': 'Bookmark count.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Tweet creation timestamp from X.'}, 'conversation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Conversation Id', 'default': None, 'description': 'Conversation thread id for the tweet.'}}, 'additionalProperties': True}
x-twitter.tweet_replies
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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_tweet_repliesArguments', 'required': ['id'], 'properties': {'id': {'type': 'string', 'title': 'Id', 'maxLength': 32, 'description': 'Numeric tweet id.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response next_cursor field.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetXTweetRepliesResponseTimelineItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItem', 'properties': {'lang': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Lang', 'default': None, 'description': 'Detected language code.'}, 'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Tweet body text.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Timeline entry type (for example tweet).'}, 'media': {'anyOf': [{'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemMedia'}, {'type': 'null'}], 'default': None, 'description': 'Attached media grouped by type (for example video and photo arrays) when present.'}, 'views': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'View count when provided by the upstream provider.'}, 'author': {'anyOf': [{'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Author profile summary embedded in the timeline entry.'}, 'quotes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Quotes', 'default': None, 'description': 'Quote count.'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Source', 'default': None, 'description': 'Client or app source string from X.'}, 'replies': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Replies', 'default': None, 'description': 'Reply count.'}, 'entities': {'anyOf': [{'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemEntities'}, {'type': 'null'}], 'default': None, 'description': 'Parsed entities from the tweet text.'}, 'retweets': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retweets', 'default': None, 'description': 'Repost count.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id.'}, 'bookmarks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bookmarks', 'default': None, 'description': 'Bookmark count.'}, 'favorites': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Favorites', 'default': None, 'description': 'Like count.'}, 'user_info': {'anyOf': [{'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemUserInfo'}, {'type': 'null'}], 'default': None, 'description': 'Embedded author profile for the tweet.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Tweet creation timestamp from X.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'quoted_tweet': {'anyOf': [{'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemQuotedTweet'}, {'type': 'null'}], 'default': None, 'description': 'Quoted tweet summary when the post quotes another tweet.'}, 'conversation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Conversation Id', 'default': None, 'description': 'Conversation thread id for the tweet.'}, 'display_text_range': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Display Text Range', 'default': None, 'description': 'Start and end character indices for the display text range.'}, 'in_reply_to_screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'In Reply To Screen Name', 'default': None, 'description': 'Handle of the user being replied to.'}, 'in_reply_to_user_id_str': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'In Reply To User Id Str', 'default': None, 'description': 'User id of the account being replied to.'}, 'in_reply_to_status_id_str': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'In Reply To Status Id Str', 'default': None, 'description': 'Tweet id of the post being replied to.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemMedia': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemMedia', 'properties': {'photo': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemMediaPhotoItem'}}, {'type': 'null'}], 'title': 'Photo', 'default': None, 'description': 'Photo media items when present.'}, 'video': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemMediaVideoItem'}}, {'type': 'null'}], 'title': 'Video', 'default': None, 'description': 'Video media items when present.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemAuthor': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemAuthor', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemEntities': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemEntities', 'properties': {'urls': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem'}}, {'type': 'null'}], 'title': 'Urls', 'default': None, 'description': 'URLs parsed from the tweet text.'}, 'hashtags': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem'}}, {'type': 'null'}], 'title': 'Hashtags', 'default': None, 'description': 'Hashtags parsed from the tweet text.'}, 'user_mentions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem'}}, {'type': 'null'}], 'title': 'User Mentions', 'default': None, 'description': 'User mentions parsed from the tweet text.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemUserInfo': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemUserInfo', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'avatar': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Profile avatar image URL.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the author account is verified.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'friends_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Friends Count', 'default': None, 'description': 'Following count when provided by the upstream provider.'}, 'followers_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Followers Count', 'default': None, 'description': 'Follower count when provided by the upstream provider.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemQuotedTweet': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemQuotedTweet', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Quoted tweet body text.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id for the quoted post.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Quoted tweet author handle.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemMediaPhotoItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemMediaPhotoItem', 'properties': {'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the photo asset.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemMediaVideoItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemMediaVideoItem', 'properties': {'variants': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem'}}, {'type': 'null'}], 'title': 'Variants', 'default': None, 'description': 'Available video quality variants when present.'}, 'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the video thumbnail or asset.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Short or display URL.'}, 'display_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Url', 'default': None, 'description': 'Display-friendly URL.'}, 'expanded_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expanded Url', 'default': None, 'description': 'Expanded destination URL.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Hashtag text without the leading #.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Mentioned user display name.'}, 'id_str': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id Str', 'default': None, 'description': 'Mentioned user id.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Mentioned user handle without the leading @.'}}, 'additionalProperties': True}, 'GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem': {'type': 'object', 'title': 'GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'HTTPS URL for the media variant.'}, 'bitrate': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bitrate', 'default': None, 'description': 'Video bitrate when provided.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type for the media variant.'}}, 'additionalProperties': True}}, 'title': 'GetXTweetRepliesResponse', 'properties': {'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Reply fetch status from the upstream provider (ok on success).'}, 'timeline': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXTweetRepliesResponseTimelineItem'}}, {'type': 'null'}], 'title': 'Timeline', 'default': None, 'description': 'Reply tweets, newest first. Additional provider-specific fields may appear on each entry.'}, 'next_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Next Cursor', 'default': None, 'description': 'Cursor for the next replies page, when available.'}, 'prev_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Prev Cursor', 'default': None, 'description': 'Cursor for the previous replies page, when available.'}}, 'additionalProperties': True}
x-twitter.unrepost_post
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.
Esquema de entrada
{'type': 'object', 'title': 'unrepost_x_postArguments', 'required': ['post_id'], 'properties': {'post_id': {'type': 'string', 'title': 'Post Id', 'description': 'Numeric id of the original post to unrepost.'}, 'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.'}}}
Esquema de salida
{'type': 'object', 'title': 'UnrepostXPostResponse', 'properties': {'user_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Id', 'default': None, 'description': 'Numeric X user id of the connected account.'}, 'retweeted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Retweeted', 'default': None, 'description': 'Whether the post is still reposted after this request.'}, 'user_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle of the connected account.'}}, 'additionalProperties': True}
x-twitter.user_info
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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_user_infoArguments', 'properties': {'rest_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id (rest_id). When provided, user_name is ignored.'}, 'user_name': {'anyOf': [{'type': 'string', 'maxLength': 50}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetXUserInfoResponseAffiliates': {'type': 'object', 'title': 'GetXUserInfoResponseAffiliates', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Affiliate profile or badge URL when provided.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Affiliate description text when provided.'}}, 'additionalProperties': True}, 'GetXUserInfoResponseBusinessAccount': {'type': 'object', 'title': 'GetXUserInfoResponseBusinessAccount', 'properties': {'category': {'anyOf': [{'$ref': '#/$defs/GetXUserInfoResponseBusinessAccountCategory'}, {'type': 'null'}], 'default': None, 'description': 'Business category metadata when provided.'}, 'affiliates_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Affiliates Count', 'default': None, 'description': 'Number of affiliate accounts when provided.'}}, 'additionalProperties': True}, 'GetXUserInfoResponseBusinessAccountCategory': {'type': 'object', 'title': 'GetXUserInfoResponseBusinessAccountCategory', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Business category id.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Business category name.'}}, 'additionalProperties': True}}, 'title': 'GetXUserInfoResponse', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id', 'default': None, 'description': 'Numeric X user id (may duplicate rest_id).'}, 'desc': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Desc', 'default': None, 'description': 'Profile bio / description.'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name shown on the profile.'}, 'avatar': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Profile avatar image URL.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Profile lookup status from the upstream provider.'}, 'friends': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Friends', 'default': None, 'description': 'Number of accounts the user follows.'}, 'profile': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Profile', 'default': None, 'description': 'X screen name (handle).'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Location', 'default': None, 'description': 'Profile location string.'}, 'protected': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Protected', 'default': None, 'description': 'Whether the account is protected (private).'}, 'sub_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Sub Count', 'default': None, 'description': 'Follower count.'}, 'affiliates': {'anyOf': [{'$ref': '#/$defs/GetXUserInfoResponseAffiliates'}, {'type': 'null'}], 'default': None, 'description': 'Affiliate account metadata when present (object or empty array from the provider). Additional provider-specific fields may appear.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Account creation timestamp from X.'}, 'media_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Media Count', 'default': None, 'description': 'Total media item count.'}, 'header_image': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Header Image', 'default': None, 'description': 'Profile banner image URL.'}, 'blue_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Blue Verified', 'default': None, 'description': 'Whether the account has X blue verification.'}, 'statuses_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Statuses Count', 'default': None, 'description': 'Total post count.'}, 'business_account': {'anyOf': [{'$ref': '#/$defs/GetXUserInfoResponseBusinessAccount'}, {'type': 'null'}], 'default': None, 'description': 'Business account metadata when present (object with counts or empty array from the provider when not applicable).'}, 'verification_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Verification Type', 'default': None, 'description': 'Verification type label from X when present.'}, 'pinned_tweet_ids_str': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Pinned Tweet Ids Str', 'default': None, 'description': 'Pinned tweet ids for the profile when present.'}}, 'additionalProperties': True}
x-twitter.user_timeline
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.
Esquema de entrada
{'type': 'object', 'title': 'get_x_user_timelineArguments', 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response next_cursor field.'}, 'rest_id': {'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id (rest_id). When provided, user_name is ignored.'}, 'user_name': {'anyOf': [{'type': 'string', 'maxLength': 50}, {'type': 'null'}], 'title': 'User Name', 'default': None, 'description': 'X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.'}}}
Esquema de salida
{'type': 'object', '$defs': {'GetXUserTimelineResponseUser': {'type': 'object', 'title': 'GetXUserTimelineResponseUser', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Display name shown on the profile.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Account status from the upstream provider.'}, 'profile': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Profile', 'default': None, 'description': 'X screen name (handle).'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'sub_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Sub Count', 'default': None, 'description': 'Follower count.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponsePinned': {'type': 'object', 'title': 'GetXUserTimelineResponsePinned', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Pinned tweet body text.'}, 'author': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponsePinnedAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Author profile summary for the pinned tweet.'}, 'retweets': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retweets', 'default': None, 'description': 'Repost count.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id for the pinned post.'}, 'favorites': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Favorites', 'default': None, 'description': 'Like count.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponsePinnedAuthor': {'type': 'object', 'title': 'GetXUserTimelineResponsePinnedAuthor', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItem', 'properties': {'lang': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Lang', 'default': None, 'description': 'Detected language code.'}, 'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Tweet body text.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Timeline entry type (for example tweet).'}, 'media': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemMedia'}, {'type': 'null'}], 'default': None, 'description': 'Attached media grouped by type (for example video and photo arrays) when present.'}, 'views': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'View count when provided by the upstream provider.'}, 'author': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Author profile summary embedded in the timeline entry.'}, 'quotes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Quotes', 'default': None, 'description': 'Quote count.'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Source', 'default': None, 'description': 'Client or app source string from X.'}, 'replies': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Replies', 'default': None, 'description': 'Reply count.'}, 'entities': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemEntities'}, {'type': 'null'}], 'default': None, 'description': 'Parsed entities from the tweet text.'}, 'retweets': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Retweets', 'default': None, 'description': 'Repost count.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id.'}, 'bookmarks': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bookmarks', 'default': None, 'description': 'Bookmark count.'}, 'favorites': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Favorites', 'default': None, 'description': 'Like count.'}, 'user_info': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemUserInfo'}, {'type': 'null'}], 'default': None, 'description': 'Embedded author profile for the tweet.'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Created At', 'default': None, 'description': 'Tweet creation timestamp from X.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'quoted_tweet': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemQuotedTweet'}, {'type': 'null'}], 'default': None, 'description': 'Quoted tweet summary when the post quotes another tweet.'}, 'conversation_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Conversation Id', 'default': None, 'description': 'Conversation thread id for the tweet.'}, 'display_text_range': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Display Text Range', 'default': None, 'description': 'Start and end character indices for the display text range.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemMedia': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemMedia', 'properties': {'photo': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemMediaPhotoItem'}}, {'type': 'null'}], 'title': 'Photo', 'default': None, 'description': 'Photo media items when present.'}, 'video': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemMediaVideoItem'}}, {'type': 'null'}], 'title': 'Video', 'default': None, 'description': 'Video media items when present.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemAuthor': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemAuthor', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemEntities': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemEntities', 'properties': {'urls': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemEntitiesUrlsItem'}}, {'type': 'null'}], 'title': 'Urls', 'default': None, 'description': 'URLs parsed from the tweet text.'}, 'hashtags': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem'}}, {'type': 'null'}], 'title': 'Hashtags', 'default': None, 'description': 'Hashtags parsed from the tweet text.'}, 'user_mentions': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem'}}, {'type': 'null'}], 'title': 'User Mentions', 'default': None, 'description': 'User mentions parsed from the tweet text.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemUserInfo': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemUserInfo', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Author display name.'}, 'avatar': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Profile avatar image URL.'}, 'rest_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Rest Id', 'default': None, 'description': 'Numeric X user id.'}, 'verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Verified', 'default': None, 'description': 'Whether the author account is verified.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Author handle without the leading @.'}, 'friends_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Friends Count', 'default': None, 'description': 'Following count when provided by the upstream provider.'}, 'followers_count': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Followers Count', 'default': None, 'description': 'Follower count when provided by the upstream provider.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemQuotedTweet': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemQuotedTweet', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Quoted tweet body text.'}, 'tweet_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Tweet Id', 'default': None, 'description': 'Numeric tweet id for the quoted post.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Quoted tweet author handle.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemMediaPhotoItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemMediaPhotoItem', 'properties': {'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the photo asset.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemMediaVideoItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemMediaVideoItem', 'properties': {'variants': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem'}}, {'type': 'null'}], 'title': 'Variants', 'default': None, 'description': 'Available video quality variants when present.'}, 'media_url_https': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Media Url Https', 'default': None, 'description': 'HTTPS URL for the video thumbnail or asset.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemEntitiesUrlsItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemEntitiesUrlsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Short or display URL.'}, 'display_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Display Url', 'default': None, 'description': 'Display-friendly URL.'}, 'expanded_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expanded Url', 'default': None, 'description': 'Expanded destination URL.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Hashtag text without the leading #.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem', 'properties': {'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Name', 'default': None, 'description': 'Mentioned user display name.'}, 'id_str': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Id Str', 'default': None, 'description': 'Mentioned user id.'}, 'indices': {'anyOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'null'}], 'title': 'Indices', 'default': None, 'description': 'Start and end character indices in the tweet text.'}, 'screen_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Screen Name', 'default': None, 'description': 'Mentioned user handle without the leading @.'}}, 'additionalProperties': True}, 'GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem': {'type': 'object', 'title': 'GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'HTTPS URL for the media variant.'}, 'bitrate': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Bitrate', 'default': None, 'description': 'Video bitrate when provided.'}, 'content_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'MIME type for the media variant.'}}, 'additionalProperties': True}}, 'title': 'GetXUserTimelineResponse', 'properties': {'user': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponseUser'}, {'type': 'null'}], 'default': None, 'description': 'Profile summary for the requested user.'}, 'pinned': {'anyOf': [{'$ref': '#/$defs/GetXUserTimelineResponsePinned'}, {'type': 'null'}], 'default': None, 'description': 'Pinned tweet object when the user has one pinned post.'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Timeline fetch status from the upstream provider (ok on success).'}, 'timeline': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/GetXUserTimelineResponseTimelineItem'}}, {'type': 'null'}], 'title': 'Timeline', 'default': None, 'description': 'Recent posts from the user. Additional provider-specific fields may appear on each entry.'}, 'next_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Next Cursor', 'default': None, 'description': 'Cursor for the next timeline page, when available.'}, 'prev_cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Prev Cursor', 'default': None, 'description': 'Cursor for the previous timeline page, when available.'}}, 'additionalProperties': True}
youtube.channel_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_channel_detailsArguments', 'required': ['channel_id'], 'properties': {'channel_id': {'type': 'string', 'title': 'Channel Id', 'maxLength': 2048, 'description': 'YouTube channel id or URL (for example UCJ5v_MCY6GNUBTO8-D3XoAg or https://www.youtube.com/@WWE).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeChannelDetailsResponseStats': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseStats', 'properties': {'views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'Lifetime view count.'}, 'videos': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Videos', 'default': None, 'description': 'Published video count.'}, 'videosText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Videostext', 'default': None, 'description': 'Formatted video count when available.'}, 'subscribers': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Subscribers', 'default': None, 'description': 'Subscriber count.'}, 'subscribersText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Subscriberstext', 'default': None, 'description': 'Formatted subscriber count.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseBanner': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseBanner', 'properties': {'tv': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseBannerTvItem'}}, {'type': 'null'}], 'title': 'Tv', 'default': None, 'description': 'TV banner images.'}, 'mobile': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseBannerMobileItem'}}, {'type': 'null'}], 'title': 'Mobile', 'default': None, 'description': 'Mobile banner images.'}, 'desktop': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseBannerDesktopItem'}}, {'type': 'null'}], 'title': 'Desktop', 'default': None, 'description': 'Desktop banner images.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseLinksItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseLinksItem', 'properties': {'icon': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseLinksItemIconItem'}}, {'type': 'null'}], 'title': 'Icon', 'default': None, 'description': 'Favicon images at different sizes.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Link label shown on the channel About page.'}, 'targetUrl': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Targeturl', 'default': None, 'description': 'Destination URL.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseAvatarItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseAvatarItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseBadgesItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseBadgesItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Badge label.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Badge type code.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseBannerTvItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseBannerTvItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseBannerMobileItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseBannerMobileItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseBannerDesktopItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseBannerDesktopItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}, 'YoutubeChannelDetailsResponseLinksItemIconItem': {'type': 'object', 'title': 'YoutubeChannelDetailsResponseLinksItemIconItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}}, 'title': 'YoutubeChannelDetailsResponse', 'properties': {'links': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseLinksItem'}}, {'type': 'null'}], 'title': 'Links', 'default': None, 'description': 'External links listed on the channel About page.'}, 'stats': {'anyOf': [{'$ref': '#/$defs/YoutubeChannelDetailsResponseStats'}, {'type': 'null'}], 'default': None, 'description': 'Public channel statistics.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Channel display name.'}, 'avatar': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseAvatarItem'}}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Channel avatar images at different sizes.'}, 'badges': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelDetailsResponseBadgesItem'}}, {'type': 'null'}], 'title': 'Badges', 'default': None, 'description': 'Channel badges (for example Official Artist Channel).'}, 'banner': {'anyOf': [{'$ref': '#/$defs/YoutubeChannelDetailsResponseBanner'}, {'type': 'null'}], 'default': None, 'description': 'Channel banner images for desktop, mobile, and TV layouts.'}, 'country': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Country', 'default': None, 'description': 'Country associated with the channel when available.'}, 'keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Keywords', 'default': None, 'description': 'Channel keywords from the About page.'}, 'username': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Username', 'default': None, 'description': 'Public @ handle when available.'}, 'artistBio': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Artistbio', 'default': None, 'description': 'Artist bio text when the channel is a music artist.'}, 'channelId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Channelid', 'default': None, 'description': 'Canonical YouTube channel id.'}, 'isVerified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Isverified', 'default': None, 'description': 'Whether the channel is verified.'}, 'joinedDate': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Joineddate', 'default': None, 'description': 'Channel creation date (ISO 8601).'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Channel About description.'}, 'isFamilySafe': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Isfamilysafe', 'default': None, 'description': 'Whether the channel is marked family safe.'}, 'joinedDateText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Joineddatetext', 'default': None, 'description': 'Human-readable join date.'}, 'canonicalBaseUrl': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Canonicalbaseurl', 'default': None, 'description': 'Canonical channel path on YouTube when available.'}, 'hasBusinessEmail': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Hasbusinessemail', 'default': None, 'description': 'Whether a business email is available for contact.'}, 'isVerifiedArtist': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Isverifiedartist', 'default': None, 'description': 'Whether the channel is a verified artist channel.'}}, 'additionalProperties': True}
youtube.channel_search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_youtube_channelArguments', 'required': ['channel_id', 'query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords or phrase within the channel.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursorNext.'}, 'channel_id': {'type': 'string', 'title': 'Channel Id', 'maxLength': 24, 'description': 'YouTube channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg, not a URL).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeChannelSearchResponseContentsItem': {'type': 'object', 'title': 'YoutubeChannelSearchResponseContentsItem', 'properties': {'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Result entry type (for example video).'}, 'video': {'anyOf': [{'$ref': '#/$defs/YoutubeChannelSearchResponseContentsItemVideo'}, {'type': 'null'}], 'default': None, 'description': 'Video payload when type is video.'}}, 'additionalProperties': True}, 'YoutubeChannelSearchResponseContentsItemVideo': {'type': 'object', 'title': 'YoutubeChannelSearchResponseContentsItemVideo', 'properties': {'stats': {'anyOf': [{'$ref': '#/$defs/YoutubeChannelSearchResponseContentsItemVideoStats'}, {'type': 'null'}], 'default': None, 'description': 'View counts for the video.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Video title.'}, 'badges': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Badges', 'default': None, 'description': 'Video badges (for example CC, 4K).'}, 'videoId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Videoid', 'default': None, 'description': 'Video id.'}, 'isLiveNow': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Islivenow', 'default': None, 'description': 'Whether the video is live.'}, 'thumbnails': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem'}}, {'type': 'null'}], 'title': 'Thumbnails', 'default': None, 'description': 'Static thumbnail images at different sizes.'}, 'lengthSeconds': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lengthseconds', 'default': None, 'description': 'Video duration in seconds.'}, 'publishedTimeText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Publishedtimetext', 'default': None, 'description': 'Human-readable publish age.'}, 'descriptionSnippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Descriptionsnippet', 'default': None, 'description': 'Short description excerpt for the video.'}}, 'additionalProperties': True}, 'YoutubeChannelSearchResponseContentsItemVideoStats': {'type': 'object', 'title': 'YoutubeChannelSearchResponseContentsItemVideoStats', 'properties': {'views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'View count.'}}, 'additionalProperties': True}, 'YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem': {'type': 'object', 'title': 'YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}}, 'title': 'YoutubeChannelSearchResponse', 'properties': {'contents': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelSearchResponseContentsItem'}}, {'type': 'null'}], 'title': 'Contents', 'default': None, 'description': 'Matching video entries for the current page. Each entry includes a type field and nested video object.'}, 'cursorNext': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursornext', 'default': None, 'description': 'Cursor for the next page, when available.'}}, 'additionalProperties': True}
youtube.channel_videos
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.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_channel_videosArguments', 'required': ['channel_id'], 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response cursor field.'}, 'channel_id': {'type': 'string', 'title': 'Channel Id', 'maxLength': 2048, 'description': 'YouTube channel id or URL (for example UCg6gPGh8HU2U01vaFCAsvmQ or https://www.youtube.com/@ChrisTitusTech).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeChannelVideosResponseVideosItem': {'type': 'object', 'title': 'YoutubeChannelVideosResponseVideosItem', 'properties': {'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Video type (for example NORMAL).'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Video title.'}, 'author': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Author', 'default': None, 'description': 'Channel display name.'}, 'category': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Category', 'default': None, 'description': 'Primary category label when available.'}, 'keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Keywords', 'default': None, 'description': 'Video keyword tags.'}, 'video_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'Video id.'}, 'channel_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Channel Id', 'default': None, 'description': 'Uploader channel id.'}, 'thumbnails': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelVideosResponseVideosItemThumbnailsItem'}}, {'type': 'null'}], 'title': 'Thumbnails', 'default': None, 'description': 'Video thumbnail images at different sizes.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Video description when available.'}, 'video_length': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Video Length', 'default': None, 'description': 'Video duration (for example 17:19).'}, 'published_time': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Published Time', 'default': None, 'description': 'Human-readable publish time.'}, 'is_live_content': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Is Live Content', 'default': None, 'description': 'Whether the video is live content when available.'}, 'number_of_views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Number Of Views', 'default': None, 'description': 'View count.'}}, 'additionalProperties': True}, 'YoutubeChannelVideosResponseVideosItemThumbnailsItem': {'type': 'object', 'title': 'YoutubeChannelVideosResponseVideosItemThumbnailsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}}, 'title': 'YoutubeChannelVideosResponse', 'properties': {'cursor': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Cursor for the next page, when available.'}, 'videos': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeChannelVideosResponseVideosItem'}}, {'type': 'null'}], 'title': 'Videos', 'default': None, 'description': 'Channel videos for the current page.'}}, 'additionalProperties': True}
youtube.playlist_details
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.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_playlist_detailsArguments', 'required': ['playlist_id'], 'properties': {'playlist_id': {'type': 'string', 'title': 'Playlist Id', 'maxLength': 512, 'description': 'YouTube playlist id (for example PLcirGkCPmbmFeQ1sm4wFciF03D_EroIfr).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubePlaylistDetailsResponseStats': {'type': 'object', 'title': 'YoutubePlaylistDetailsResponseStats', 'properties': {'views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'Total playlist view count.'}, 'videos': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Videos', 'default': None, 'description': 'Number of videos in the playlist.'}}, 'additionalProperties': True}, 'YoutubePlaylistDetailsResponseAuthor': {'type': 'object', 'title': 'YoutubePlaylistDetailsResponseAuthor', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Playlist creator display name.'}, 'avatar': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubePlaylistDetailsResponseAuthorAvatarItem'}}, {'type': 'null'}], 'title': 'Avatar', 'default': None, 'description': 'Creator avatar images at different sizes.'}, 'channelId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Channelid', 'default': None, 'description': 'Creator channel id.'}, 'canonicalBaseUrl': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Canonicalbaseurl', 'default': None, 'description': 'Canonical channel path on YouTube when available.'}}, 'additionalProperties': True}, 'YoutubePlaylistDetailsResponseBadgesItem': {'type': 'object', 'title': 'YoutubePlaylistDetailsResponseBadgesItem', 'properties': {'badge': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Badge', 'default': None, 'description': 'Badge label.'}}, 'additionalProperties': True}, 'YoutubePlaylistDetailsResponseThumbnailsItem': {'type': 'object', 'title': 'YoutubePlaylistDetailsResponseThumbnailsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}, 'YoutubePlaylistDetailsResponseAuthorAvatarItem': {'type': 'object', 'title': 'YoutubePlaylistDetailsResponseAuthorAvatarItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}}, 'title': 'YoutubePlaylistDetailsResponse', 'properties': {'stats': {'anyOf': [{'$ref': '#/$defs/YoutubePlaylistDetailsResponseStats'}, {'type': 'null'}], 'default': None, 'description': 'Public playlist statistics.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Playlist title.'}, 'author': {'anyOf': [{'$ref': '#/$defs/YoutubePlaylistDetailsResponseAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Playlist creator summary.'}, 'badges': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubePlaylistDetailsResponseBadgesItem'}}, {'type': 'null'}], 'title': 'Badges', 'default': None, 'description': 'Playlist badges when available.'}, 'playlistId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Playlistid', 'default': None, 'description': 'Canonical YouTube playlist id.'}, 'thumbnails': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubePlaylistDetailsResponseThumbnailsItem'}}, {'type': 'null'}], 'title': 'Thumbnails', 'default': None, 'description': 'Playlist thumbnail images at different sizes.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Playlist description.'}, 'updatedTime': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updatedtime', 'default': None, 'description': 'Last update date (ISO 8601).'}, 'updatedTimeText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Updatedtimetext', 'default': None, 'description': 'Human-readable last update time.'}}, 'additionalProperties': True}
youtube.search
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.
Esquema de entrada
{'type': 'object', 'title': 'search_youtubeArguments', 'required': ['query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Search keywords or phrase.'}, 'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from cursorNext.'}, 'sort_by': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Sort By', 'default': None, 'description': 'Sort order. One of: Relevance, Upload date, View count, Rating.'}, 'duration': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Duration', 'default': None, 'description': 'Duration filter. One of: Under 4 minutes, 4 - 20 minutes, Over 20 minutes.'}, 'features': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}, 'maxItems': 6}, {'type': 'null'}], 'title': 'Features', 'default': None, 'description': 'Feature filters. Multiple allowed. Each value must be one of: Live, 4K, HD, Subtitles/CC, Creative Commons, 360°, VR180, 3D, HDR, Location, Purchased.'}, 'language': {'type': 'string', 'title': 'Language', 'default': 'en', 'maxLength': 10, 'description': 'Language code for localized results (for example en).'}, 'location': {'type': 'string', 'title': 'Location', 'default': 'US', 'maxLength': 10, 'description': 'Country code for localized results (for example US).'}, 'upload_date': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Upload Date', 'default': None, 'description': 'Upload date filter. One of: Last hour, Today, This week, This month, This year.'}, 'content_type': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Content Type', 'default': None, 'description': 'Content type filter. One of: Video, Channel, Playlist, Movie.'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeSearchResponseContentsItem': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItem', 'properties': {'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Result entry type (for example video).'}, 'video': {'anyOf': [{'$ref': '#/$defs/YoutubeSearchResponseContentsItemVideo'}, {'type': 'null'}], 'default': None, 'description': 'Video payload when type is video.'}}, 'additionalProperties': True}, 'YoutubeSearchResponseContentsItemVideo': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItemVideo', 'properties': {'stats': {'anyOf': [{'$ref': '#/$defs/YoutubeSearchResponseContentsItemVideoStats'}, {'type': 'null'}], 'default': None, 'description': 'View counts for the video.'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Video title.'}, 'author': {'anyOf': [{'$ref': '#/$defs/YoutubeSearchResponseContentsItemVideoAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Video author summary (avatar omitted).'}, 'videoId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Videoid', 'default': None, 'description': 'Video id.'}, 'isLiveNow': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Islivenow', 'default': None, 'description': 'Whether the video is live.'}, 'thumbnails': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeSearchResponseContentsItemVideoThumbnailsItem'}}, {'type': 'null'}], 'title': 'Thumbnails', 'default': None, 'description': 'Thumbnail images for the video.'}, 'lengthSeconds': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Lengthseconds', 'default': None, 'description': 'Video duration in seconds.'}, 'publishedTimeText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Publishedtimetext', 'default': None, 'description': 'Human-readable publish age.'}}, 'additionalProperties': True}, 'YoutubeSearchResponseContentsItemVideoStats': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItemVideoStats', 'properties': {'views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Views', 'default': None, 'description': 'View count.'}}, 'additionalProperties': True}, 'YoutubeSearchResponseContentsItemVideoAuthor': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItemVideoAuthor', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Channel or creator display name.'}, 'badges': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeSearchResponseContentsItemVideoAuthorBadgesItem'}}, {'type': 'null'}], 'title': 'Badges', 'default': None, 'description': 'Author badges (for example Official Artist Channel).'}}, 'additionalProperties': True}, 'YoutubeSearchResponseContentsItemVideoThumbnailsItem': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItemVideoThumbnailsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Thumbnail image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Thumbnail width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Thumbnail height in pixels.'}}, 'additionalProperties': True}, 'YoutubeSearchResponseContentsItemVideoAuthorBadgesItem': {'type': 'object', 'title': 'YoutubeSearchResponseContentsItemVideoAuthorBadgesItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Badge label.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Badge type code.'}}, 'additionalProperties': True}}, 'title': 'YoutubeSearchResponse', 'properties': {'contents': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeSearchResponseContentsItem'}}, {'type': 'null'}], 'title': 'Contents', 'default': None, 'description': 'Search result entries for the current page. Video entries include a type field and nested video object.'}, 'cursorNext': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursornext', 'default': None, 'description': 'Cursor for the next results page, when available.'}, 'didYouMean': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Didyoumean', 'default': None, 'description': 'Suggested corrected query when the search may be misspelled.'}, 'estimatedResults': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Estimatedresults', 'default': None, 'description': 'Approximate total number of matching results.'}, 'unappliedFilters': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Unappliedfilters', 'default': None, 'description': 'Requested filter labels that could not be applied. Present only when at least one filter was skipped.'}}, 'additionalProperties': True}
youtube.search_autocomplete
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.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_search_autocompleteArguments', 'required': ['query'], 'properties': {'query': {'type': 'string', 'title': 'Query', 'maxLength': 512, 'description': 'Partial search keywords or phrase.'}, 'language': {'type': 'string', 'title': 'Language', 'default': 'en', 'maxLength': 10, 'description': 'Language code for localized suggestions (for example en).'}, 'location': {'type': 'string', 'title': 'Location', 'default': 'US', 'maxLength': 10, 'description': 'Country code for localized suggestions (for example US).'}}}
Esquema de salida
{'type': 'object', 'title': 'YoutubeSearchAutocompleteResponse', 'properties': {'query': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Query', 'default': None, 'description': 'Normalized query echoed from the provider.'}, 'results': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Results', 'default': None, 'description': 'Suggested search phrases for the query.'}}, 'additionalProperties': True}
youtube.video_comments
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.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_video_commentsArguments', 'required': ['video_id'], 'properties': {'cursor': {'anyOf': [{'type': 'string', 'maxLength': 4096}, {'type': 'null'}], 'title': 'Cursor', 'default': None, 'description': 'Pagination cursor from a previous response cursorNext field.'}, 'sort_by': {'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}], 'title': 'Sort By', 'default': None, 'description': 'Comment sort order. One of: Top comments, Newest first.'}, 'video_id': {'type': 'string', 'title': 'Video Id', 'maxLength': 11, 'description': 'YouTube video id (11 characters, not a URL).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeVideoCommentsResponseCommentsItem': {'type': 'object', 'title': 'YoutubeVideoCommentsResponseCommentsItem', 'properties': {'stats': {'anyOf': [{'$ref': '#/$defs/YoutubeVideoCommentsResponseCommentsItemStats'}, {'type': 'null'}], 'default': None, 'description': 'Engagement counts for the comment.'}, 'author': {'anyOf': [{'$ref': '#/$defs/YoutubeVideoCommentsResponseCommentsItemAuthor'}, {'type': 'null'}], 'default': None, 'description': 'Comment author profile summary.'}, 'pinned': {'anyOf': [{'$ref': '#/$defs/YoutubeVideoCommentsResponseCommentsItemPinned'}, {'type': 'null'}], 'default': None, 'description': 'Pinned comment status.'}, 'content': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Content', 'default': None, 'description': 'Comment text.'}, 'commentId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Commentid', 'default': None, 'description': 'Comment id.'}, 'creatorHeart': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Creatorheart', 'default': None, 'description': 'Whether the video creator hearted this comment.'}, 'cursorReplies': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursorreplies', 'default': None, 'description': 'Pagination cursor for fetching replies to this comment.'}, 'publishedTimeText': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Publishedtimetext', 'default': None, 'description': 'Human-readable comment age.'}}, 'additionalProperties': True}, 'YoutubeVideoCommentsResponseCommentsItemStats': {'type': 'object', 'title': 'YoutubeVideoCommentsResponseCommentsItemStats', 'properties': {'votes': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Votes', 'default': None, 'description': 'Like/vote count.'}, 'replies': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Replies', 'default': None, 'description': 'Reply count.'}}, 'additionalProperties': True}, 'YoutubeVideoCommentsResponseCommentsItemAuthor': {'type': 'object', 'title': 'YoutubeVideoCommentsResponseCommentsItemAuthor', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Comment author display name.'}, 'badges': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem'}}, {'type': 'null'}], 'title': 'Badges', 'default': None, 'description': 'Author badges (for example Verified).'}, 'channelId': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Channelid', 'default': None, 'description': 'Comment author channel id.'}, 'isChannelOwner': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Ischannelowner', 'default': None, 'description': 'Whether the author owns the video channel.'}}, 'additionalProperties': True}, 'YoutubeVideoCommentsResponseCommentsItemPinned': {'type': 'object', 'title': 'YoutubeVideoCommentsResponseCommentsItemPinned', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Pinned label text when present.'}, 'status': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Status', 'default': None, 'description': 'Whether the comment is pinned.'}}, 'additionalProperties': True}, 'YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem': {'type': 'object', 'title': 'YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem', 'properties': {'text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Text', 'default': None, 'description': 'Badge label.'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Badge type code.'}}, 'additionalProperties': True}}, 'title': 'YoutubeVideoCommentsResponse', 'properties': {'comments': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeVideoCommentsResponseCommentsItem'}}, {'type': 'null'}], 'title': 'Comments', 'default': None, 'description': 'Top-level comments for the current page and sort order. Additional provider-specific fields may appear on each entry.'}, 'cursorNext': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Cursornext', 'default': None, 'description': 'Cursor for the next comments page, when available.'}, 'totalCommentsCount': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Totalcommentscount', 'default': None, 'description': 'Total number of comments on the video.'}}, 'additionalProperties': True}
youtube.video_details
Fetch metadata for a public YouTube video by video id or URL. Accepts a bare 11-character video id (for example PuQFESk0BrA) or common YouTube watch, youtu.be, Shorts, and embed URLs. Returns title, description, view count, duration, publish date, channel id, category, keywords, and thumbnails. Cost = 10 tokens.
Esquema de entrada
{'type': 'object', 'title': 'get_youtube_video_detailsArguments', 'required': ['video_id'], 'properties': {'video_id': {'type': 'string', 'title': 'Video Id', 'maxLength': 2048, 'description': 'YouTube video id or URL (for example PuQFESk0BrA, https://youtu.be/PuQFESk0BrA, or https://www.youtube.com/watch?v=PuQFESk0BrA).'}}}
Esquema de salida
{'type': 'object', '$defs': {'YoutubeVideoDetailsResponseThumbnailsItem': {'type': 'object', 'title': 'YoutubeVideoDetailsResponseThumbnailsItem', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Url', 'default': None, 'description': 'Image URL.'}, 'width': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Width', 'default': None, 'description': 'Image width in pixels.'}, 'height': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Height', 'default': None, 'description': 'Image height in pixels.'}}, 'additionalProperties': True}}, 'title': 'YoutubeVideoDetailsResponse', 'properties': {'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Type', 'default': None, 'description': 'Video type (for example NORMAL).'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Title', 'default': None, 'description': 'Video title.'}, 'author': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Author', 'default': None, 'description': 'Channel display name.'}, 'category': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Category', 'default': None, 'description': 'Primary category label.'}, 'keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Keywords', 'default': None, 'description': 'Video keyword tags.'}, 'video_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Video Id', 'default': None, 'description': 'Canonical YouTube video id.'}, 'channel_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Channel Id', 'default': None, 'description': 'Uploader channel id.'}, 'thumbnails': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/$defs/YoutubeVideoDetailsResponseThumbnailsItem'}}, {'type': 'null'}], 'title': 'Thumbnails', 'default': None, 'description': 'Available thumbnail images at different sizes.'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Description', 'default': None, 'description': 'Plain-text video description.'}, 'video_length': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Video Length', 'default': None, 'description': 'Video duration in seconds as a string.'}, 'published_time': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Published Time', 'default': None, 'description': 'Publish date (ISO 8601).'}, 'is_live_content': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Is Live Content', 'default': None, 'description': 'Whether the video is live content (True or False as a string).'}, 'number_of_views': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Number Of Views', 'default': None, 'description': 'Total view count.'}}, 'additionalProperties': True}
Modificado
pages.list
21 de September de 2026 a las 02:56
Modificado
pages.get
21 de September de 2026 a las 02:56
Modificado
pages.list
19 de September de 2026 a las 02:47
Modificado
pages.get
19 de September de 2026 a las 02:47
Añadido
youtube.video_details
17 de September de 2026 a las 12:53
Añadido
youtube.video_comments
17 de September de 2026 a las 12:53
Añadido
youtube.search_autocomplete
17 de September de 2026 a las 12:53
Añadido
youtube.search
17 de September de 2026 a las 12:53
Añadido
youtube.playlist_details
17 de September de 2026 a las 12:53
Añadido
youtube.channel_videos
17 de September de 2026 a las 12:53
Añadido
youtube.channel_search
17 de September de 2026 a las 12:53
Añadido
youtube.channel_details
17 de September de 2026 a las 12:53
Añadido
website-screenshots.capture
17 de September de 2026 a las 12:53
Añadido
clerk.verify_organization_domain_ownership
17 de September de 2026 a las 12:53
Añadido
files.upload_file
17 de September de 2026 a las 12:53
Añadido
clerk.update_user_metadata
17 de September de 2026 a las 12:53
Añadido
clerk.update_user
17 de September de 2026 a las 12:53
Añadido
clerk.update_phone_number
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_role
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_permission
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_metadata
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_membership_metadata
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_membership
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization_domain
17 de September de 2026 a las 12:53
Añadido
clerk.update_organization
17 de September de 2026 a las 12:53
Añadido
clerk.update_machine
17 de September de 2026 a las 12:53
Añadido
clerk.update_jwt_template
17 de September de 2026 a las 12:53
Añadido
clerk.update_enterprise_connection
17 de September de 2026 a las 12:53
Añadido
clerk.update_email_address
17 de September de 2026 a las 12:53
Añadido
clerk.update_api_key
17 de September de 2026 a las 12:53

hyperion

com.thetempleofdoom.hyperion/hyperion

Acts as a paid MCP tool marketplace and utility gateway with server discovery, HTTP and JavaScript tools, research, data conversi…

IA-QA — 130+ QA & Dev Tools for AI Agents

io.github.JcJamet/ia-qa-toolbox

Provides deterministic QA, evaluation, testing, code analysis, prompt and RAG checks, model comparison, and web security diagnost…

validoria-mcp

com.validoria/validoria-mcp

Runs continuous website, API, and webshop tests covering security, SEO, performance, accessibility, browser journeys, and inciden…

HubVibe: Pay-per-Call Tools for AI Agents: Web Search, Email Verify, KYC, Stocks, Crypto, News, Data

io.github.Its-fortunatefolly/hubvibe

Offers paid utilities for web audits, HTTP fetching and extraction, BigQuery analysis, LLM processing, code execution, blockchain…

developer-tools

net.programmes/developer-tools

Provides general-purpose developer utilities for encoding, hashing, encryption, JSON, HTML, CSS, networking, and related data tra…

Qiniso

io.github.qinisolabs/qiniso

Provides deterministic formatting, parsing, holiday and tax lookups, address handling, and checksum or structure validation for i…

ContrastAPI

com.contrastcyber/api

Provides security research and assessment tools covering CVEs, IOCs, dependencies, secrets, injection risks, HTTP headers, domain…

CipherHUB Cryptography Toolkit

io.github.bowenerchen/cipherhub

Provides cryptographic operations including key generation, encryption, signing, verification, hashing, certificates, CMS, COSE, …