Skip to main content
The catalog contains 61 account operations plus get_capabilities. Your credential sees only tools permitted by its scopes. All resource access is limited to your account and checked again for each call. Start with the quickstart. Except for get_capabilities, fields below belong inside arguments.input. Writes also require arguments.idempotencyKey: 1–191 printable ASCII characters without spaces. Fields with defaults can be omitted. Do not change identifier spelling or mix page_size with pageSize. The live tools/list schema is the connection’s contract. Successful tool output appears in structuredContent and as JSON text in content. The first execution returns the envelope below. A replay returns replayed: true and a small receipt with available identifiers, not the original full result or API key secret.
execution_pending (409) means the first call is still unresolved. execution_unknown (409), or a receipt with status: unknown, means the side effect may already have happened. Inspect get_execution, then the referenced task, order or account action. Do not create a new idempotency key to bypass these states. A completed MCP execution can still contain a pending model task or a pending website confirmation. Model-result collection is limited to 8 MiB and 300 seconds. If collection is interrupted or exceeds a limit, the execution receipt preserves any known request_id. Inspect get_execution and the existing request or task before further action; do not create another paid request or use a new idempotency key to replace an unresolved call. A client disconnect does not mean an accepted model task was canceled.

get_capabilities

Read · arguments: {} After the client initializes the connection, call get_capabilities with {} and read tools/list. get_capabilities returns audience: user, ownership: self, granted scopes, permitted tools and oauth: false. Every other personal tool uses an input object, including tools without business parameters.

list_models

Required scopes: models:read · Read Result: Paginated items, total, page, page_size; public model IDs, prices and capabilities.

get_model_schema

Required scopes: models:read · Read Result: One permitted model with supported parameters, capabilities and prices.

get_api_guide

Required scopes: models:read · Read Result: Integration URLs, authentication placeholders, endpoint map and task polling guidance for format.

chat_completion

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

create_response

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

create_message

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

generate_content

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

generate_image

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

generate_image_sync

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

edit_image

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference. File operations check ownership, readiness, file count and sizes before reading any file contents. Every file reference counts toward the operation’s limits, including repeated IDs. edit_image: at most 20 files across all fields, including at most one mask; 50 MiB per file / 100 MiB total. The per-field array limits in the input schema still apply.

generate_video

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

generate_video_sync

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

moderate_content

Required scopes: models:invoke · Write; idempotencyKey required Result: Returns status (HTTP), request_id, credits_charged, content_type, and response or collected events. Asynchronous responses include a task to poll with get_task; acceptance is not completion. body is the complete supported HTTP JSON body. model outside it is required for generate_content; other model calls read body.model. files maps edit-image field names to owned file-ID arrays and requires files:write. Use client_request_id for video correlation only. See the matching HTTP request reference.

upload_image

Required scopes: models:invoke, files:write · Write; idempotencyKey required Result: Publishes one JPEG, PNG or WebP and returns its model-input URL inside the standard model response. This URL is shareable. File operations check ownership, readiness, file count and sizes before reading any file contents. Every file reference counts toward the operation’s limits, including repeated IDs. upload_image: one file, at most 50 MiB.

upload_media

Required scopes: files:write · Write; idempotencyKey required Result: Publishes the selected image, video or audio files and returns their URLs. Publishing makes those URLs shareable; it is a separate action from a private upload. File operations check ownership, readiness, file count and sizes before reading any file contents. Every file reference counts toward the operation’s limits, including repeated IDs. upload_media: at most 20 files / 250 MiB total.

get_task

Required scopes: models:invoke · Read Result: Your existing task status and result. Does not create another task or charge again.

list_utilities

Required scopes: models:read · Read Result: items with utility id, title, description, method, body_kind, response_kind, fields, limits and access.

get_utility_schema

Required scopes: models:read · Read Result: The selected utility’s fields, accepted file types, defaults, size limits and access requirements.

run_utility

Required scopes: utilities:invoke · Write; idempotencyKey required Result: Returns status and JSON result, or temporary artifact for binary/large output. Files and non-JSON output also require files:write; account quotas and paid-access requirements still apply. File operations check ownership, readiness, file count and sizes before reading any file contents. Every file reference counts toward the operation’s limits, including repeated IDs. run_utility: the selected utility’s file-count, per-file and total limits from get_utility_schema apply, with a hard ceiling of 250 MiB total even when the catalog permits more.

begin_upload

Required scopes: files:write · Write; idempotencyKey required Result: Temporary file metadata: id, name, mime_type, size, status, expires_at, sha256. Use id as subsequent file_id.

upload_chunk

Required scopes: files:write · Write; idempotencyKey required Result: file_id, index, received: true. Base64 decodes to at most 1 MiB. Reusing an index requires identical bytes.

finish_upload

Required scopes: files:write · Write; idempotencyKey required Result: Verified file metadata with status: ready and SHA-256. All sequential chunks and the exact declared byte size are required.

get_artifact

Required scopes: files:write · Read Result: Without offset: metadata and a download_url requiring website sign-in. With offset: Base64 data, offset, next_offset; null marks the end. Default read length is 1 MiB.

list_api_keys

Required scopes: keys:read · Read Result: Paginated settings and key prefixes; never plaintext secrets.

get_api_key

Required scopes: keys:read · Read Result: Settings for your selected key, without its secret.

create_api_key

Required scopes: keys:write · Write; idempotencyKey required Result: New key metadata only. Use website-approved reveal to retrieve its secret. purpose is a label and grants no MCP rights.

update_api_key

Required scopes: keys:write · Write; idempotencyKey required Result: Updated key settings. Supply at least one setting besides key_id.

set_api_key_status

Required scopes: keys:write · Write; idempotencyKey required Result: Updated settings with active or disabled status.

delete_api_key

Required scopes: keys:write · Write; idempotencyKey required Result: Verified id, status: deleted, deletedAt. Deleted keys cannot be reactivated.

start_reveal_key_action

Required scopes: keys:secrets · Write; idempotencyKey required Result: Pending action with id, confirmation_url, expires_at and proposed effect. No secret is returned.

reveal_api_key

Required scopes: keys:secrets · Write; idempotencyKey required Result: After approval: action_id, key_id, plaintext key, exactly once. Replays do not return the secret.

get_profile

Required scopes: account:read · Read Result: Your profile, current subscription and freeApi eligibility, RPM and batch access. No fields: use input: {}.

get_account_capabilities

Required scopes: account:read · Read Result: Granted scopes, bound_api_key_id, free_api tier/RPM and supported confirmation actions. No fields: use input: {}.

update_profile

Required scopes: account:write · Write; idempotencyKey required Result: Updated profile. Supply name or image; an empty image clears it. Image may be an HTTP(S) URL or supported image data URL.

list_login_records

Required scopes: account:read · Read Result: Recent sign-in items including time, method, IP and location. No session tokens.

get_integration_config

Required scopes: account:read · Read Result: API and MCP connection URLs with placeholder credentials only. No fields: use input: {}.

start_account_action

Required scopes: account:write · Write; idempotencyKey required Result: A pending website confirmation action. Password change and account deletion happen on the website.

get_account_action

Required scopes: account:read · Read Result: Your action’s status, confirmation link, expiry, resource and completion time.

get_balance

Required scopes: billing:read · Read Result: Account balance and optional bound-key budget and remaining credits. No fields: use input: {}.

list_credit_transactions

Required scopes: billing:read · Read Result: Paginated credit transactions: amounts, direction, status, dates and related order or subscription.

list_orders

Required scopes: billing:read · Read Result: Paginated orders with status, amount, currency, product and payment dates. A created order is not proof of payment.

list_billing_products

Required scopes: billing:read · Read Result: Current product IDs, prices, currencies and credit amounts; pass a returned productId as checkout product_id. No fields: use input: {}.

create_checkout

Required scopes: billing:write · Write; idempotencyKey required Result: checkout_url and order_no. The user pays on the website; verify the order with get_payment_status.

get_payment_status

Required scopes: billing:read · Read Result: Your order’s payment status, amount, currency and paid time, with additional payment review state when applicable.

get_invoice

Required scopes: billing:read, files:write · Write; idempotencyKey required Result: order_no and a temporary PDF file. Availability depends on the payment method; this creates a file and requires an idempotency key.

resend_invoice

Required scopes: billing:write · Write; idempotencyKey required Result: order_no, destination email, sent: true. Sends a real invoice email to the address already on the order; use only when requested.

list_subscriptions

Required scopes: billing:read · Read Result: Paginated subscription metadata, product, status, billing period and cancellation dates.

get_current_subscription

Required scopes: billing:read · Read Result: subscription metadata, or null when no current subscription exists. No fields: use input: {}.

cancel_subscription

Required scopes: billing:write · Write; idempotencyKey required Result: Starts a pending confirmation action for one subscription. It is not canceled until the user confirms on the website and completion is verified.

list_redemptions

Required scopes: billing:read · Read Result: Your recent redemption items.

redeem_code

Required scopes: billing:write · Write; idempotencyKey required Result: Added credits and redeemed: true. Invalid or already used codes return an error.

get_credit_alert

Required scopes: billing:read · Read Result: Threshold, email/webhook enabled flags, webhookConfigured and frequency; no secret webhook URL. No fields: use input: {}.

update_credit_alert

Required scopes: billing:write · Write; idempotencyKey required Result: Updated preferences; provide at least one setting. Webhook URLs must be public HTTP(S) addresses.

test_credit_alert

Required scopes: billing:write · Write; idempotencyKey required Result: Sends a real balance alert via delivery; returns delivery type, balance, threshold and HTTP status where available. Use only when requested.

get_overview

Required scopes: usage:read · Read Result: Dashboard summary for the selected timezoneOffset: user, balance, keys, usage, recent activity and subscription.

list_usage

Required scopes: usage:read · Read Result: Paginated retained requests and UTC window; unknown cached-token counts remain null. Usage filters use an inclusive from and exclusive to, with ISO 8601 timestamps including a timezone. The default window is the previous 30 days, maximum 366 days. Results cover retained records only; omitted days are not evidence of zero usage. get_overview.timezoneOffset uses JavaScript getTimezoneOffset minutes (UTC minus local time), default 0; usage listings and grouped summaries remain UTC.

get_usage_detail

Required scopes: usage:read · Read Result: Your request status, timing and billing. Content requires include_content: true, usage:content, and content logging enabled for the API key.

diagnose_request

Required scopes: usage:read · Read Result: request_id, task_id, status, actual error code, billing/refund state and suggested fixes. No model invocation or automatic retry.

summarize_usage

Required scopes: usage:read · Read Result: totals, groups, group_by, UTC window across all matching retained requests. Missing days are omitted; cachedTokens is unknown. Refund totals cover linked asynchronous-task refunds only. Usage filters use an inclusive from and exclusive to, with ISO 8601 timestamps including a timezone. The default window is the previous 30 days, maximum 366 days. Results cover retained records only; omitted days are not evidence of zero usage. get_overview.timezoneOffset uses JavaScript getTimezoneOffset minutes (UTC minus local time), default 0; usage listings and grouped summaries remain UTC. In summarize_usage, creditsCharged and netCreditsCharged represent the retained net charge. linkedRefundCredits covers known refunds linked to asynchronous tasks only. knownGrossCredits adds those known refunds to the net charge; it is not a complete gross-spend total. totalTokens, averageLatencyMs, pending and processing describe the matching retained requests.

list_executions

Required scopes: account:read · Read Result: Paginated execution receipts: operation, status, receipt identifiers, error code and timestamps.

get_execution

Required scopes: account:read · Read Result: One owned execution receipt. Use it to reconcile pending or unknown; it does not replay the full output or reveal secrets.

Utility catalog: 32 operations

Use each slug as run_utility.input.utility. Call get_utility_schema for that slug first: its fields specify exact parameter names, types, required values, defaults, file multiplicity and accepted formats; limits and access specify size, file-count and account requirements. Do not infer a batch schema from the single-file version.