quokkapix.apply_recipe
Applies an official recipe id or custom recipe JSON to configure a local browser workflow. Files must still be uploaded through the browser input. This does not start processing.
id: string?, recipe: object?
quokkapix.apply_settings
Applies browser-agent settings for mode, tool, scenario steps and tool options. Files must still be supplied through the browser file input or dropzone.
mode: string?, tool: string?, steps: array?, settings: object?
quokkapix.cancel
Cancels the current QuokkaPix browser-side processing run.
quokkapix.get_contractread-only
Returns the QuokkaPix browser-agent contract, supported image tools, DOM selectors, payment policy and local browser processing constraints.
quokkapix.get_payment_policyread-only
Returns the Image, PDF, scenario, Video and transcription agent pricing rules and product-specific x402 policy.
quokkapix.get_payment_quoteread-only
Counts expanded archive files and PDF pages locally, then returns the exact free or paid tier without starting processing.
quokkapix.get_reciperead-only
Returns one official QuokkaPix recipe by id. The recipe includes applySettings JSON, limits, payment requirement and expected result manifest contract.
id: string
quokkapix.get_result_manifestread-only
Returns a machine-readable browser-local processing result, source and output dimensions when available, warnings, capabilities and stable error code.
quokkapix.get_rule_profileread-only
Returns one sourced platform image requirement profile by id, including requirements, recommendations, source URL, source type and confidence.
id: string
quokkapix.get_stateread-only
Returns current browser-side processing state, selected tool, upload mode, file count, progress, output metadata and payment state.
quokkapix.list_recipesread-only
Returns official QuokkaPix browser-local image workflow recipes such as Shopify product pack, Amazon white background pack, metadata clean batch and website WebP compression.
quokkapix.list_rule_profilesread-only
Returns sourced marketplace and social image requirement profiles used by QuokkaPix QA reports. Secondary sources are marked explicitly.
quokkapix.set_unlock_token
Stores a short-lived x402 unlock token returned by QuokkaPix payment endpoint. The token is verified and consumed when a paid agent batch run starts.
unlockToken: string
quokkapix.start
State-changing action: after local upload and exact quote, starts the selected browser workflow. A required product token is consumed only immediately before processing begins.
quokkapix.validate_reciperead-only
Validates a recipe id or custom recipe object before applying it. This does not upload files and does not start processing.
id: string?, recipe: object?