{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.withzero.xyz/openapi.json", "services": "https://agents.withzero.xyz/services", "serviceSpecTemplate": "https://agents.withzero.xyz/services/{slug}/openapi.json", "searchTemplate": "https://agents.withzero.xyz/openapi.json?q={text}", "operationTemplate": "https://agents.withzero.xyz/openapi.json?path={path}&method={method}", "firstPage": "https://agents.withzero.xyz/openapi.json?page=1", "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ] }, "info": { "title": "WithZero", "version": "1.0.0", "description": "Create media, research companies and people, publish to the web, remember context, deploy apps, and schedule work—on demand, without vendor accounts or API keys. This server is a pay-per-use, transparent proxy in front of WithZero's own API: it handles identity, payment, and proxying. Agents can purchase autonomously or with their human's approval. Operations whose x-payment-info.access is \"plan\" are sold on plans, not per call: they answer an unidentified call with 401 and an identified call with no covering plan with 403, never a 402. The complete verified paid surface is listed at /openapi.json, the source of truth for available operations. Each operation here carries its pricing in x-payment-info. Use the operations and details here when they meet your needs. Filtered specs contain only matching operations; if you cannot find what you need here, use search or the service catalog. The live catalog at /manifest.json is authoritative for prices and any free included units (prices[].includedUnits) - some meters include free usage per account before any charge, reserved for agents claimed by a human with a verified email.", "x-guidance": "Start with the free seller advisor: POST https://agents.withzero.xyz/zeroclick/agent/quote with your goal and known budget or requirements. This operation costs $0 and requires only an x402 or MPP wallet proof; it returns a guide and never executes a purchase. Without a wallet, GET https://agents.withzero.xyz/zeroclick/agent/guide?goal=URL_ENCODED_TASK or POST to that guide. Other operations below are the direct API reference; their own prices and access requirements still apply. Call the operations listed in this document at https://agents.withzero.xyz. Each service's full price matrix, plans, and how to buy are at https://agents.withzero.xyz/services/{slug}; each operation's x-payment-info names the service it bills by slug (rates[].service). Slugs identify services in prices and usage reports and are never request values: when one operation serves several services, its request body schema lists the accepted values of the field that selects the service, so send one of those exactly as written. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method - x402 (Base USDC) or MPP (Tempo USDC) today - and retry with the proof attached. No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost. Read GET https://agents.withzero.xyz/manifest.json for the live services, meters, plans, prices, and any free included units, and https://agents.withzero.xyz/llms-full.txt for the full agent guide, including how the free allowance works without funding (it requires an agent identity claimed by a human with a verified email). Operations whose x-payment-info.access is \"plan\" take the plan path instead: 401 without a credential, 403 plan_required without a covering plan. Register once (recipe at https://agents.withzero.xyz/auth.md), buy a plan at POST https://agents.withzero.xyz/plans/{planId}/purchase, then retry with Authorization: Bearer ." }, "x-service-info": { "docs": { "homepage": "https://withzero.xyz", "apiReference": "https://agents.withzero.xyz/openapi.json", "llms": "https://agents.withzero.xyz/llms.txt" } }, "externalDocs": { "url": "https://agents.withzero.xyz/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.withzero.xyz", "description": "Pay-per-use access to WithZero's API" } ], "security": [ { "payPerUse": [] } ], "components": { "securitySchemes": { "payPerUse": { "type": "apiKey", "in": "header", "name": "x-payment", "description": "Pay-per-use access. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method (x402 or MPP today) and retry with the proof in this header (x402) or as Authorization: Payment (MPP; use ZC-Agent-Authorization for a separate buyer bearer). No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost." }, "planAccess": { "type": "http", "scheme": "bearer", "description": "Plan access. Calls are sold on plans (credit or subscription), not per call: an unidentified call returns 401 bearer_required with a registration recipe, and an identified call with no covering plan returns 403 plan_required listing the plans that cover it. Reuse your existing agent identity; register only if new (anonymous registration is one free API call; the recipe is at https://agents.withzero.xyz/auth.md), buy a plan at POST https://agents.withzero.xyz/plans/{planId}/purchase (its priced 402 settles with a supported payment method - x402 or MPP today - or by card), then retry with the access token as Authorization: Bearer . No upstream API key is needed." }, "sellerAgentX402": { "type": "apiKey", "in": "header", "name": "Payment-Signature", "description": "Signed $0 x402 proof from the 402 challenge" }, "sellerAgentMpp": { "type": "http", "scheme": "Payment", "description": "Signed $0 MPP proof from the 402 challenge" } } }, "paths": { "/api/v1/annotate/reviews": { "post": { "summary": "Create an annotation review session. Pass `url` for a live webpage, or `zipData` (base64 zip) + optional `entryFile` for a static code bundle. Returns a `shareUrl` for the human reviewer and, for bundle reviews, a `bundleUrl` to download the original source afterward.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "reviewId", "shareUrl" ], "properties": { "reviewId": { "type": "string", "description": "UUID of the created review session." }, "shareUrl": { "type": "string", "description": "URL to share with the human reviewer." }, "bundleUrl": { "type": "string", "description": "Download URL for the original source zip. Present only for code-bundle reviews." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "201": { "description": "Review created" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "402": { "$ref": "#/components/schemas/PaymentRequired" }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "operationId": "annotate_post__api_v1_reviews", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "entryFile" ], "properties": { "url": { "type": "string", "format": "uri", "description": "The URL of the page to annotate. Mutually exclusive with zipData." }, "zipData": { "type": "string", "description": "Base64-encoded zip of static site files (HTML/CSS/JS). When provided, the site is hosted by annotate and the reviewer annotates it directly. Mutually exclusive with url. Max 10 MiB decoded." }, "entryFile": { "type": "string", "default": "index.html", "description": "Entry point filename within the zip. Defaults to index.html. Only used when zipData is provided." }, "callbackUrl": { "type": "string", "format": "uri", "description": "Webhook URL to POST the full review JSON to when the human submits." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing request body and response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "reviews-create" ], "x-payment-info": { "access": "plan", "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "reviews-create", "meter": "requests", "unit": "requests", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ] }, "security": [ { "planAccess": [] } ] } }, "/api/v1/audio/songs/lyria-3-pro": { "post": { "summary": "Generate one to three complete songs with Google's Lyria 3 Pro, optionally translate vocal functions into instruments, master the audio, rank candidates with local DSP, and return hosted audio URLs.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url", "mimeType", "sizeBytes", "seconds", "model", "price_usdc" ], "properties": { "url": { "type": "string", "description": "Hosted URL of the generated song (MP3)." }, "model": { "type": "string", "description": "The model that produced the song." }, "seconds": { "type": "number", "description": "Approximate duration of the song in seconds." }, "mimeType": { "type": "string", "description": "Content type of the generated audio." }, "sizeBytes": { "type": "number", "description": "Size of the generated audio in bytes." }, "candidates": { "type": "array", "items": { "type": "object", "required": [ "index", "url", "sizeBytes", "seconds", "score", "diagnostics" ], "properties": { "url": { "type": "string" }, "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "index": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 }, "score": { "type": "object", "required": [ "overall", "duration", "groove", "structure", "production" ], "properties": { "groove": { "anyOf": [ { "type": "number", "maximum": 1, "minimum": 0 }, { "type": "null" } ] }, "overall": { "type": "number", "maximum": 1, "minimum": 0 }, "duration": { "type": "number", "maximum": 1, "minimum": 0 }, "structure": { "anyOf": [ { "type": "number", "maximum": 1, "minimum": 0 }, { "type": "null" } ] }, "production": { "type": "number", "maximum": 1, "minimum": 0 } }, "additionalProperties": false }, "seconds": { "type": "number", "exclusiveMinimum": 0 }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "diagnostics": { "type": "object", "required": [ "durationSec", "tempo", "brightness", "energy", "sections", "cues" ], "properties": { "key": { "type": "object", "required": [ "tonic", "mode", "camelot", "confidence" ], "properties": { "mode": { "enum": [ "major", "minor" ], "type": "string" }, "tonic": { "type": "string" }, "camelot": { "type": "string" }, "confidence": { "type": "number", "maximum": 1, "minimum": 0 } }, "additionalProperties": false }, "cues": { "type": "object", "required": [ "mixInSec", "mixOutSec" ], "properties": { "mixInSec": { "type": "number", "minimum": 0 }, "mixOutSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "tempo": { "type": "object", "required": [ "bpm", "beatOffsetSec", "beatIntervalSec", "downbeatOffsetBeats", "downbeatConfidence" ], "properties": { "bpm": { "type": "number", "exclusiveMinimum": 0 }, "beatOffsetSec": { "type": "number", "minimum": 0 }, "beatIntervalSec": { "type": "number", "exclusiveMinimum": 0 }, "downbeatConfidence": { "type": "number", "maximum": 1, "minimum": 0 }, "downbeatOffsetBeats": { "type": "integer", "maximum": 3, "minimum": 0 } }, "additionalProperties": false }, "energy": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "stereo": { "type": "object", "required": [ "correlation", "sideToMidRatio" ], "properties": { "correlation": { "type": "number", "maximum": 1, "minimum": -1 }, "sideToMidRatio": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "loudness": { "type": "object", "required": [ "integratedLufs", "rangeLu", "truePeakDb" ], "properties": { "rangeLu": { "type": "number" }, "truePeakDb": { "type": "number" }, "integratedLufs": { "type": "number" } }, "additionalProperties": false }, "sections": { "type": "array", "items": { "type": "object", "required": [ "kind", "startSec", "endSec" ], "properties": { "kind": { "type": "string" }, "endSec": { "type": "number", "exclusiveMinimum": 0 }, "startSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false } }, "brightness": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "durationSec": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false } }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." }, "diagnostics": { "type": "object", "required": [ "final" ], "properties": { "final": { "type": "object", "required": [ "durationSec", "tempo", "brightness", "energy", "sections", "cues" ], "properties": { "key": { "type": "object", "required": [ "tonic", "mode", "camelot", "confidence" ], "properties": { "mode": { "enum": [ "major", "minor" ], "type": "string" }, "tonic": { "type": "string" }, "camelot": { "type": "string" }, "confidence": { "type": "number", "maximum": 1, "minimum": 0 } }, "additionalProperties": false }, "cues": { "type": "object", "required": [ "mixInSec", "mixOutSec" ], "properties": { "mixInSec": { "type": "number", "minimum": 0 }, "mixOutSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "tempo": { "type": "object", "required": [ "bpm", "beatOffsetSec", "beatIntervalSec", "downbeatOffsetBeats", "downbeatConfidence" ], "properties": { "bpm": { "type": "number", "exclusiveMinimum": 0 }, "beatOffsetSec": { "type": "number", "minimum": 0 }, "beatIntervalSec": { "type": "number", "exclusiveMinimum": 0 }, "downbeatConfidence": { "type": "number", "maximum": 1, "minimum": 0 }, "downbeatOffsetBeats": { "type": "integer", "maximum": 3, "minimum": 0 } }, "additionalProperties": false }, "energy": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "stereo": { "type": "object", "required": [ "correlation", "sideToMidRatio" ], "properties": { "correlation": { "type": "number", "maximum": 1, "minimum": -1 }, "sideToMidRatio": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "loudness": { "type": "object", "required": [ "integratedLufs", "rangeLu", "truePeakDb" ], "properties": { "rangeLu": { "type": "number" }, "truePeakDb": { "type": "number" }, "integratedLufs": { "type": "number" } }, "additionalProperties": false }, "sections": { "type": "array", "items": { "type": "object", "required": [ "kind", "startSec", "endSec" ], "properties": { "kind": { "type": "string" }, "endSec": { "type": "number", "exclusiveMinimum": 0 }, "startSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false } }, "brightness": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "durationSec": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "beforeMastering": { "type": "object", "required": [ "durationSec", "tempo", "brightness", "energy", "sections", "cues" ], "properties": { "key": { "type": "object", "required": [ "tonic", "mode", "camelot", "confidence" ], "properties": { "mode": { "enum": [ "major", "minor" ], "type": "string" }, "tonic": { "type": "string" }, "camelot": { "type": "string" }, "confidence": { "type": "number", "maximum": 1, "minimum": 0 } }, "additionalProperties": false }, "cues": { "type": "object", "required": [ "mixInSec", "mixOutSec" ], "properties": { "mixInSec": { "type": "number", "minimum": 0 }, "mixOutSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "tempo": { "type": "object", "required": [ "bpm", "beatOffsetSec", "beatIntervalSec", "downbeatOffsetBeats", "downbeatConfidence" ], "properties": { "bpm": { "type": "number", "exclusiveMinimum": 0 }, "beatOffsetSec": { "type": "number", "minimum": 0 }, "beatIntervalSec": { "type": "number", "exclusiveMinimum": 0 }, "downbeatConfidence": { "type": "number", "maximum": 1, "minimum": 0 }, "downbeatOffsetBeats": { "type": "integer", "maximum": 3, "minimum": 0 } }, "additionalProperties": false }, "energy": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "stereo": { "type": "object", "required": [ "correlation", "sideToMidRatio" ], "properties": { "correlation": { "type": "number", "maximum": 1, "minimum": -1 }, "sideToMidRatio": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "loudness": { "type": "object", "required": [ "integratedLufs", "rangeLu", "truePeakDb" ], "properties": { "rangeLu": { "type": "number" }, "truePeakDb": { "type": "number" }, "integratedLufs": { "type": "number" } }, "additionalProperties": false }, "sections": { "type": "array", "items": { "type": "object", "required": [ "kind", "startSec", "endSec" ], "properties": { "kind": { "type": "string" }, "endSec": { "type": "number", "exclusiveMinimum": 0 }, "startSec": { "type": "number", "minimum": 0 } }, "additionalProperties": false } }, "brightness": { "type": "array", "items": { "type": "number", "maximum": 1, "minimum": 0 } }, "durationSec": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false }, "selectionNotes": { "type": "array", "items": { "type": "string" } }, "selectionMethod": { "type": "string", "const": "local-dsp" }, "selectedCandidate": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Zero-based selected candidate index when candidateCount is greater than one." }, "generationFailures": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "audio_post__api_v1_songs_lyria_3_pro", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "prompt": "A short upbeat synthwave instrumental with a driving bassline" }, "required": [ "prompt", "candidateCount" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Seed for repeatable generation (best effort)." }, "topP": { "type": "number", "maximum": 1, "minimum": 0, "description": "OpenRouter nucleus-sampling probability from 0 to 1." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the song to generate (1–4000 characters)." }, "sections": { "type": "array", "items": { "type": "object", "required": [ "startSec", "endSec", "name", "description" ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Section label, for example Intro, Verse, Chorus, or Bridge." }, "endSec": { "type": "integer", "maximum": 300, "minimum": 1, "description": "Exclusive section end in whole seconds." }, "startSec": { "type": "integer", "maximum": 300, "minimum": 0, "description": "Inclusive section start in whole seconds." }, "intensity": { "type": "integer", "maximum": 10, "minimum": 1, "description": "Target section intensity from 1 (minimal) to 10 (maximum)." }, "description": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Instrumentation, melody, rhythm, and production instructions for this section." } }, "additionalProperties": false }, "maxItems": 20, "description": "Up to 20 ordered, non-overlapping arrangement sections converted to Lyria timestamp directives." }, "mastering": { "type": "object", "required": [ "targetLufs", "truePeakDb", "fadeOutSec" ], "properties": { "fadeOutSec": { "type": "number", "default": 1, "maximum": 10, "minimum": 0, "description": "Final fade duration in seconds." }, "targetLufs": { "type": "number", "default": -14, "maximum": -8, "minimum": -24, "description": "Target integrated loudness in LUFS." }, "truePeakDb": { "type": "number", "default": -1, "maximum": -0.1, "minimum": -6, "description": "Maximum true peak in dBTP." } }, "description": "Optional ffmpeg loudness normalization, true-peak control, and final fade. Omit to return Lyria audio unchanged.", "additionalProperties": false }, "durationSec": { "type": "integer", "maximum": 300, "minimum": 30, "description": "Target duration in seconds (30–300; best effort)." }, "temperature": { "type": "number", "maximum": 2, "minimum": 0, "description": "OpenRouter sampling temperature from 0 to 2." }, "instrumental": { "type": "boolean", "description": "When true, explicitly excludes vocals, speech, vocal chops, and choir." }, "candidateCount": { "type": "integer", "default": 1, "maximum": 3, "minimum": 1, "description": "Generate 1–3 seeded candidates. Extra candidates cost the normal per-song price; the objectively closest result is returned at top level." }, "negativePrompt": { "type": "string", "maxLength": 1000, "minLength": 1, "description": "Elements to discourage, appended to the Lyria prompt as explicit exclusions." }, "tailReserveSec": { "type": "integer", "maximum": 15, "minimum": 0, "description": "Reserve the final seconds for non-essential decay so an early model stop does not remove the musical resolution." }, "selectionTarget": { "type": "object", "properties": { "bpm": { "type": "number", "maximum": 240, "minimum": 40 }, "matchPriorities": { "type": "object", "properties": { "groove": { "type": "integer", "maximum": 5, "minimum": 1 }, "harmony": { "type": "integer", "maximum": 5, "minimum": 1 }, "structure": { "type": "integer", "maximum": 5, "minimum": 1 }, "production": { "type": "integer", "maximum": 5, "minimum": 1 }, "instrumentation": { "type": "integer", "maximum": 5, "minimum": 1 } }, "description": "Optional 1–5 importance weights. Higher-weight traits receive stronger analysis, prompting, and candidate-ranking emphasis.", "additionalProperties": false } }, "description": "Optional BPM and match weights used to rank multiple candidates with local DSP.", "additionalProperties": false }, "referenceImageUrls": { "type": "array", "items": { "type": "string", "format": "uri", "maxLength": 2048 }, "maxItems": 10, "description": "Up to 10 public reference images to guide mood, visual story, and style." }, "instrumentalLeadMapping": { "type": "array", "items": { "type": "object", "required": [ "role", "instrument" ], "properties": { "role": { "enum": [ "lead", "harmony", "response", "ad-lib", "sustained", "ensemble" ], "type": "string", "description": "The source vocal function being reassigned." }, "register": { "enum": [ "low", "mid", "high", "wide" ], "type": "string" }, "instrument": { "type": "string", "maxLength": 80, "minLength": 1, "description": "Instrument that should perform this role, for example expressive piano or bright pluck synth." }, "articulation": { "type": "string", "maxLength": 160, "minLength": 1, "description": "Phrasing and envelope, for example clipped staccato attacks with short releases." } }, "additionalProperties": false }, "maxItems": 8, "minItems": 1, "description": "Map source vocal functions to instrumental parts such as lead → expressive piano and harmony → warm strings." }, "instrumentalLeadContinuity": { "enum": [ "sectional", "persistent" ], "type": "string", "description": "How strongly to retain the mapped lead instrument. Persistent reasserts it after every transition and prevents another instrument from replacing it." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing request body and response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "lyria-3-pro" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "80000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.080000 per songs (songs, service lyria-3-pro, first 1 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.080000" }, "rates": [ { "service": "lyria-3-pro", "meter": "songs", "unit": "songs", "unitSize": 1, "priceUsd": "0.080000", "includedUnits": 1 } ], "included": [ { "meterSlug": "songs", "unit": "songs", "freeUnits": 1, "per": "account" } ] } } }, "/api/v1/audio/speech/gemini-3.1-flash-tts": { "post": { "summary": "Convert text to natural-sounding speech with Google Gemini 3.1 Flash TTS and return a hosted audio URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url", "mimeType", "sizeBytes", "seconds", "model", "price_usdc" ], "properties": { "url": { "type": "string", "description": "Hosted URL of the generated audio (WAV, 24kHz mono)." }, "model": { "type": "string", "description": "The model that produced the audio." }, "seconds": { "type": "number", "description": "Approximate duration of the generated audio in seconds." }, "mimeType": { "type": "string", "description": "Content type of the generated audio." }, "sizeBytes": { "type": "number", "description": "Size of the generated audio in bytes." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "audio_post__api_v1_speech_gemini_3_1_flash_tts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "input": "Hello from WithZero — this is a text to speech sample." }, "required": [ "input", "voice" ], "properties": { "text": { "type": "string" }, "input": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "The text to convert to speech (1–4000 characters)." }, "voice": { "type": "string", "default": "Kore", "maxLength": 64, "minLength": 1, "description": "Voice to speak with. Defaults to \"Kore\"." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing detailed parameter definitions and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "gemini-3-1-flash-tts" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 250 characterss (characters, service gemini-3-1-flash-tts, first 2500 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "gemini-3-1-flash-tts", "meter": "characters", "unit": "characters", "unitSize": 250, "priceUsd": "0.010000", "includedUnits": 2500 } ], "included": [ { "meterSlug": "characters", "unit": "characters", "freeUnits": 2500, "per": "account" } ] } } }, "/api/v1/audio/speech/grok-voice": { "post": { "summary": "Convert text to natural-sounding speech with xAI's Grok Voice and return a hosted audio URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url", "mimeType", "sizeBytes", "seconds", "model", "price_usdc" ], "properties": { "url": { "type": "string", "description": "Hosted URL of the generated audio (WAV, 24kHz mono)." }, "model": { "type": "string", "description": "The model that produced the audio." }, "seconds": { "type": "number", "description": "Approximate duration of the generated audio in seconds." }, "mimeType": { "type": "string", "description": "Content type of the generated audio." }, "sizeBytes": { "type": "number", "description": "Size of the generated audio in bytes." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "audio_post__api_v1_speech_grok_voice", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "input": "Hello from WithZero — this is a text to speech sample." }, "required": [ "input", "voice" ], "properties": { "text": { "type": "string" }, "input": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "The text to convert to speech (1–4000 characters)." }, "voice": { "type": "string", "default": "default", "maxLength": 64, "minLength": 1, "description": "Voice to speak with. Defaults to \"default\"." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing detailed parameter definitions and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "grok-voice" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 500 characterss (characters, service grok-voice, first 5000 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "grok-voice", "meter": "characters", "unit": "characters", "unitSize": 500, "priceUsd": "0.010000", "includedUnits": 5000 } ], "included": [ { "meterSlug": "characters", "unit": "characters", "freeUnits": 5000, "per": "account" } ] } } }, "/api/v1/audio/transcripts/gpt-4o-transcribe": { "post": { "summary": "Transcribe spoken audio to text with OpenAI's GPT-4o Transcribe.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "text", "seconds", "model", "price_usdc" ], "properties": { "text": { "type": "string", "description": "The transcript of the audio." }, "model": { "type": "string", "description": "The model that produced the transcript." }, "seconds": { "type": "number", "description": "Detected duration of the input audio in seconds." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "audio_post__api_v1_transcripts_gpt_4o_transcribe", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "audio": "UklGRiYAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YQIAAAAAAA==", "format": "wav" }, "required": [ "audio", "format" ], "properties": { "audio": { "type": "string", "maxLength": 20971524, "minLength": 1, "description": "Base64-encoded audio to transcribe (decoded size up to 15 MB)." }, "format": { "enum": [ "wav", "mp3" ], "type": "string", "description": "Container format of the audio." } }, "additionalProperties": false } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing detailed parameter definitions and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "gpt-4o-transcribe" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 2 minutess (minutes, service gpt-4o-transcribe, first 20 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "gpt-4o-transcribe", "meter": "minutes", "unit": "minutes", "unitSize": 2, "priceUsd": "0.010000", "includedUnits": 20 } ], "included": [ { "meterSlug": "minutes", "unit": "minutes", "freeUnits": 20, "per": "account" } ] } } }, "/api/v1/audio/transcripts/whisper-large-v3": { "post": { "summary": "Transcribe spoken audio to text with OpenAI Whisper Large v3.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "text", "seconds", "model", "price_usdc" ], "properties": { "text": { "type": "string", "description": "The transcript of the audio." }, "model": { "type": "string", "description": "The model that produced the transcript." }, "seconds": { "type": "number", "description": "Detected duration of the input audio in seconds." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "audio_post__api_v1_transcripts_whisper_large_v3", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "audio": "UklGRiYAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YQIAAAAAAA==", "format": "wav" }, "required": [ "audio", "format" ], "properties": { "audio": { "type": "string", "maxLength": 20971524, "minLength": 1, "description": "Base64-encoded audio to transcribe (decoded size up to 15 MB)." }, "format": { "enum": [ "wav", "mp3" ], "type": "string", "description": "Container format of the audio." } }, "additionalProperties": false } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing detailed parameter definitions and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "whisper-large-v3" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 5 minutess (minutes, service whisper-large-v3, first 50 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "whisper-large-v3", "meter": "minutes", "unit": "minutes", "unitSize": 5, "priceUsd": "0.010000", "includedUnits": 50 } ], "included": [ { "meterSlug": "minutes", "unit": "minutes", "freeUnits": 50, "per": "account" } ] } } }, "/api/v1/cdn/deploys": { "post": { "summary": "Deploy a large static site (up to 5,000 files / 500 MiB) by manifest: send every path with its size and MD5, get upload URLs for only the files not already stored, PUT the bytes, then commit. Redeploys upload only what changed.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "deployId", "expiresAt", "uploads", "commit" ], "properties": { "commit": { "type": "string", "description": "Then POST here to make the deploy live." }, "uploads": { "type": "array", "items": { "type": "object", "required": [ "md5", "size", "contentType", "paths", "url" ], "properties": { "md5": { "type": "string" }, "url": { "type": "string", "description": "PUT the bytes here, e.g. `curl -X PUT --data-binary @ -H \"content-type: \" \"\"`. Treat as a secret." }, "size": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "paths": { "type": "array", "items": { "type": "string" }, "description": "Every path in this deploy with these exact bytes — upload once." }, "contentType": { "type": "string" } }, "additionalProperties": false }, "description": "Only the files this wallet has not uploaded before; an empty list means every byte is already stored. GCS rejects bytes that do not match the declared MD5 and size. A 412 on PUT means that content is already stored — skip it." }, "deployId": { "type": "string" }, "expiresAt": { "type": "string", "description": "Commit before this time; afterwards the upload URLs and the deploy lapse." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "cdn_post__api_v1_deploys", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "slug", "files" ], "properties": { "slug": { "type": "string", "maxLength": 512, "minLength": 1, "description": "The site to deploy, served at /// — the same slug as a kind:site upload. Redeploying a slug replaces the site." }, "files": { "type": "array", "items": { "type": "object", "required": [ "path", "size", "md5" ], "properties": { "md5": { "type": "string", "description": "MD5 of the bytes as 32 lowercase hex chars (what `md5sum` / `md5 -q` print)." }, "path": { "type": "string", "maxLength": 512, "minLength": 1, "description": "Path within the site, e.g. \"index.html\" or \"assets/app.js\". `_redirects` / `_headers` at the root are read as site rules." }, "size": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Size in bytes." } }, "additionalProperties": false }, "maxItems": 5000, "minItems": 1, "description": "Every file of the site. Up to 5000 files, 100 MiB each, 500 MiB in total." }, "cacheTtlSeconds": { "type": "integer", "maximum": 9007199254740991, "description": "Edge cache lifetime for the deployed files, as for kind:site uploads. Default 3600, clamped to [60, 86400].", "exclusiveMinimum": 0 } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-deploys-create" ], "description": "Deploy a large static site (up to 5,000 files / 500 MiB) by manifest: send every path with its size and MD5, get upload URLs for only the files not already stored, PUT the bytes, then commit. Redeploys upload only what changed.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/deploys/{id}/commit": { "post": { "summary": "Make a planned deploy live once its files are uploaded. Takes the same visibility / password / spa options as a kind:site upload.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "walletId", "cacheTtlSeconds", "files" ], "properties": { "spa": { "type": "boolean", "description": "kind:site only — whether single-page-app routing is on after this upload." }, "files": { "type": "array", "items": { "type": "object", "required": [ "url", "path", "sizeBytes" ], "properties": { "url": { "type": "string", "description": "Public URL this file is served from." }, "path": { "type": "string", "description": "Path within your wallet namespace (the part after /)." }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Decoded file size in bytes." } }, "additionalProperties": false }, "description": "One entry per uploaded file. kind:file — a single entry. kind:site — one entry per file in the zip; the hosted site's entry point is ///, which serves /index.html." }, "shareUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "kind:site with link or password visibility — the private URL to share. For a link site it is the whole credential; for a password site viewers also need the password." }, "walletId": { "type": "string", "description": "Random per-wallet base62 id used as the folder in the URL path (the in ///)." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "kind:site only — rules in _redirects / _headers that were skipped (unsupported syntax, a disallowed header). The deploy itself succeeded." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "kind:site only — the site's visibility after this upload." }, "cacheTtlSeconds": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Resolved edge cache lifetime (Cache-Control max-age) applied to every uploaded object." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_post__api_v1_deploys__id__commit", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "spa": { "type": "boolean", "description": "Single-page app routing. true: a missing extensionless path (e.g. /dashboard/settings) serves the site index.html with 200 so a client-side router handles it; missing assets (.js, .png…) still 404. false: misses serve the site 404.html, if it has one, with status 404. Omit to keep the current setting (new sites default to false)." }, "password": { "type": "string", "maxLength": 256, "minLength": 8, "description": "Sets or changes the site password (implies visibility:\"password\"). 8–256 chars. Omit to keep the current one." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "As for kind:site uploads: \"public\" (default for a new site), \"link\" or \"password\". Omit to keep the current visibility." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-deploys-commit" ], "description": "Make a planned deploy live once its files are uploaded. Takes the same visibility / password / spa options as a kind:site upload.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/sites": { "get": { "summary": "List the sites you host — slug, visibility, URL or share URL, file count, size, and last update.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "sites" ], "properties": { "sites": { "type": "array", "items": { "type": "object", "required": [ "slug", "visibility", "url", "shareUrl", "spa", "files", "sizeBytes", "updatedAt" ], "properties": { "spa": { "type": "boolean", "description": "Single-page-app routing: extensionless misses serve the site index.html." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public URL when visibility is public; null otherwise." }, "slug": { "type": "string", "description": "The slug the site was deployed under — pass it (URL-encoded) to PATCH or DELETE /api/v1/sites/{slug}." }, "files": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Files currently deployed." }, "shareUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Private URL for link/password sites; null when public. Treat as a secret." }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Total size of those files." }, "updatedAt": { "type": "string", "description": "ISO time of the last deploy or settings change." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string" } }, "additionalProperties": false }, "description": "Most recently updated first. Sites deployed before site settings existed appear as public, found by their index.html." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "cdn_get__api_v1_sites", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 2 ], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-sites-list" ], "description": "List the sites you host — slug, visibility, URL or share URL, file count, size, and last update.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/sites/{slug}": { "delete": { "summary": "Delete a site you host — its files, its public URL, and any share link.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "const": true } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "204": { "description": "Site deleted" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_delete__api_v1_sites__slug_", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body details if any", "Missing error response schemas" ], "pages": [ 2 ], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing OpenAPI contract details in provided text" ], "pages": [], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "cdn-sites-delete" ], "description": "Delete a site you host — its files, its public URL, and any share link.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } }, "patch": { "summary": "Change who can view a site you host: make it private behind an unguessable share link, rotate that link, or make it public again. URL-encode slashes in a nested slug (my%2Fsite).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "visibility", "shareUrl", "url", "spa" ], "properties": { "spa": { "type": "boolean", "description": "Whether single-page-app routing is on." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public URL when visibility is public; null otherwise." }, "shareUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Private URL for link/password sites; null when public. Treat as a secret." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_patch__api_v1_sites__slug_", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "spa": { "type": "boolean", "description": "Single-page app routing. true: a missing extensionless path (e.g. /dashboard/settings) serves the site index.html with 200 so a client-side router handles it; missing assets (.js, .png…) still 404. false: misses serve the site 404.html, if it has one, with status 404. Omit to keep the current setting (new sites default to false)." }, "password": { "type": "string", "maxLength": 256, "minLength": 8, "description": "Sets or changes the site password (implies visibility:\"password\"). 8–256 chars. Omit to keep the current one." }, "rotateLink": { "type": "boolean", "const": true, "description": "Issue a new share URL; the old one stops working immediately. Private sites only." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "New visibility. \"link\" moves the site to a private /p// URL; \"password\" puts it behind a password on its own origin, shared as cdn.withzero.xyz/p// (a redirect); \"public\" moves it back to ///. Any change of visibility issues a new shareUrl." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing request body and response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-sites-update" ], "description": "Change who can view a site you host: make it private behind an unguessable share link, rotate that link, or make it public again. URL-encode slashes in a nested slug (my%2Fsite).", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/sites/{slug}/deploys": { "get": { "summary": "A site's deploy history: the live deploy and up to 9 earlier ones you can roll back to.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "deploys" ], "properties": { "deploys": { "type": "array", "items": { "type": "object", "required": [ "deployId", "status", "files", "sizeBytes", "createdAt", "committedAt", "rolledBackFrom" ], "properties": { "files": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "status": { "enum": [ "pending", "committing", "live", "superseded" ], "type": "string" }, "deployId": { "type": "string" }, "createdAt": { "type": "string" }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "committedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rolledBackFrom": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Set when this deploy restored an earlier one." } }, "additionalProperties": false }, "description": "Newest first: the live deploy, up to 9 earlier ones you can roll back to, and any pending plans." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_get__api_v1_sites__slug__deploys", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-sites-deploys" ], "description": "A site's deploy history: the live deploy and up to 9 earlier ones you can roll back to.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/sites/{slug}/rollback": { "post": { "summary": "Restore an earlier deploy of a site you host. Its files and rules come back; visibility, password and spa stay as they are now.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "walletId", "cacheTtlSeconds", "files", "deployId" ], "properties": { "spa": { "type": "boolean", "description": "kind:site only — whether single-page-app routing is on after this upload." }, "files": { "type": "array", "items": { "type": "object", "required": [ "url", "path", "sizeBytes" ], "properties": { "url": { "type": "string", "description": "Public URL this file is served from." }, "path": { "type": "string", "description": "Path within your wallet namespace (the part after /)." }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Decoded file size in bytes." } }, "additionalProperties": false }, "description": "One entry per uploaded file. kind:file — a single entry. kind:site — one entry per file in the zip; the hosted site's entry point is ///, which serves /index.html." }, "deployId": { "type": "string", "description": "The new deploy that restored the old one." }, "shareUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "kind:site with link or password visibility — the private URL to share. For a link site it is the whole credential; for a password site viewers also need the password." }, "walletId": { "type": "string", "description": "Random per-wallet base62 id used as the folder in the URL path (the in ///)." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "kind:site only — rules in _redirects / _headers that were skipped (unsupported syntax, a disallowed header). The deploy itself succeeded." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "kind:site only — the site's visibility after this upload." }, "cacheTtlSeconds": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Resolved edge cache lifetime (Cache-Control max-age) applied to every uploaded object." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_post__api_v1_sites__slug__rollback", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "deployId" ], "properties": { "deployId": { "type": "string", "description": "A deploy from GET /api/v1/sites/{slug}/deploys with status \"superseded\"." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body and response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-sites-rollback" ], "description": "Restore an earlier deploy of a site you host. Its files and rules come back; visibility, password and spa stay as they are now.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/sites/{slug}/stats": { "get": { "summary": "Daily requests and page views for a public site you host, including visits served from the CDN cache. ?days=1–90 (default 7).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "slug", "days", "estimated" ], "properties": { "days": { "type": "array", "items": { "type": "object", "required": [ "day", "requests", "pageViews" ], "properties": { "day": { "type": "string", "description": "UTC date, YYYY-MM-DD. Days with no traffic are omitted." }, "requests": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Successful requests for any file of the site, including cached ones." }, "pageViews": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Of those, requests for pages (directories, .html, extensionless paths)." } }, "additionalProperties": false }, "description": "Oldest first. Counts trail real time by a few minutes." }, "slug": { "type": "string" }, "estimated": { "type": "boolean", "description": "True when request logging is sampled, so counts are scaled up from a sample." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string" }, "required": true } ], "operationId": "cdn_get__api_v1_sites__slug__stats", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 2 ], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "cdn-sites-stats" ], "description": "Daily requests and page views for a public site you host, including visits served from the CDN cache. ?days=1–90 (default 7).", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/cdn/uploads": { "post": { "summary": "Host a static website on a fast public CDN — upload a zip of your site (kind:site) and it is served instantly at ///. Also doubles as a one-off file host (kind:file) for individual assets like images, PDFs, or JSON.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "walletId", "cacheTtlSeconds", "files" ], "properties": { "spa": { "type": "boolean", "description": "kind:site only — whether single-page-app routing is on after this upload." }, "files": { "type": "array", "items": { "type": "object", "required": [ "url", "path", "sizeBytes" ], "properties": { "url": { "type": "string", "description": "Public URL this file is served from." }, "path": { "type": "string", "description": "Path within your wallet namespace (the part after /)." }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Decoded file size in bytes." } }, "additionalProperties": false }, "description": "One entry per uploaded file. kind:file — a single entry. kind:site — one entry per file in the zip; the hosted site's entry point is ///, which serves /index.html." }, "shareUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "kind:site with link or password visibility — the private URL to share. For a link site it is the whole credential; for a password site viewers also need the password." }, "walletId": { "type": "string", "description": "Random per-wallet base62 id used as the folder in the URL path (the in ///)." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "kind:site only — rules in _redirects / _headers that were skipped (unsupported syntax, a disallowed header). The deploy itself succeeded." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "kind:site only — the site's visibility after this upload." }, "cacheTtlSeconds": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Resolved edge cache lifetime (Cache-Control max-age) applied to every uploaded object." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Publish a static site or one-off file at a fast public URL.", "operationId": "cdn_post__api_v1_uploads", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "ext": { "type": "string", "maxLength": 8, "minLength": 1, "description": "Required only for kind:file with no slug; ignored otherwise." }, "spa": { "type": "boolean", "description": "kind:site only. Single-page app routing. true: a missing extensionless path (e.g. /dashboard/settings) serves the site index.html with 200 so a client-side router handles it; missing assets (.js, .png…) still 404. false: misses serve the site 404.html, if it has one, with status 404. Omit to keep the current setting (new sites default to false)." }, "data": { "type": "string", "minLength": 1, "description": "Base64-encoded bytes. For kind:site, a zip of your static website (HTML/CSS/JS). A `_redirects` and/or `_headers` file at the zip root is read as Netlify-format rules, with paths relative to the site root (redirects apply only where no file exists; headers are limited to a safe allowlist), and a root `CNAME` is ignored. For kind:file, the raw file bytes. Max 10 MiB after decode (same cap for kind:site decompressed total)." }, "kind": { "enum": [ "file", "site" ], "type": "string", "description": "\"site\" hosts a static website: data is a zip atomically deployed to your wallet folder under the slug prefix and served at /// — replaces any previous deploy at that prefix. \"file\" (default) uploads a single asset under your wallet folder." }, "slug": { "type": "string", "maxLength": 512, "minLength": 1, "description": "Custom path within your wallet folder. kind:site — the folder prefix the site is deployed under (e.g. \"my-site\" → served at //my-site/). kind:file — full filename including extension (e.g. \"logo.png\"). Re-uploads to the same slug overwrite; site re-deploys delete orphans from the previous deploy." }, "password": { "type": "string", "maxLength": 256, "minLength": 8, "description": "Sets or changes the site password (implies visibility:\"password\"). 8–256 chars. Omit to keep the current one." }, "visibility": { "enum": [ "public", "link", "password" ], "type": "string", "description": "kind:site only. \"public\" (default for a new site): served at ///. \"link\": private — served only at an unguessable /p// URL returned as shareUrl; anyone holding it can view the site. \"password\": private behind a password; shareUrl is cdn.withzero.xyz/p//, a redirect to the private origin https://.private.withzero.xyz/ — browsers get a form, agents send Authorization: Basic with any username. Omit on a re-deploy to keep the current visibility. Private responses are never edge-cached." }, "cacheTtlSeconds": { "type": "integer", "maximum": 9007199254740991, "description": "Edge cache lifetime (Cache-Control max-age) in seconds, applied to every object in this upload. Default 3600, clamped to [60, 86400]. Does not affect how long files are stored.", "exclusiveMinimum": 0 } }, "additionalProperties": false } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing requestBody schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "cdn-uploads" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/crustdata/company/enrich": { "post": { "summary": "Core workflow route: hydrate up to 25 selected accounts per call with company headcount, industry, taxonomy, people, and other detailed firmographics after identify or search. For large lists, chunk identifiers into groups of 25 so each group uses one payment instead of one payment per company. Defaults to basic_info only to prevent unexpectedly large headcount-history and people payloads; request other documented sections explicitly. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. DB company enrich costs two Crustdata credits per identifier, plus two credits for each returned technographics section.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "people" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "people": { "type": "array", "items": { "type": "object", "required": [ "inputIndex", "matchIndex", "people" ], "properties": { "people": { "description": "Raw Crustdata company_data.people object, commonly including decision_makers, founders, and cxos." }, "matchType": { "type": "string", "description": "Provider-reported match type, when returned by Crustdata." }, "matchedOn": { "type": "string", "description": "Provider-reported match key, when returned by Crustdata." }, "inputIndex": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Index of the requested company identifier in the raw Crustdata response." }, "matchIndex": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Index of the matched company within the raw Crustdata matches array." }, "companyName": { "type": "string", "description": "Matched company name from basic_info, when present." }, "companyDomain": { "type": "string", "description": "Matched company primary domain from basic_info, when present." } }, "additionalProperties": false }, "description": "Convenience extraction of nested company_data.people blocks from each Crustdata match so callers can find decision_makers/founders/cxos without traversing the raw payload." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_company_enrich", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "fields": [ "basic_info" ], "domains": [ "browserbase.com" ], "exact_match": true }, "required": [ "fields" ], "properties": { "names": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "OpenAI" ], "maxItems": 25, "minItems": 1, "description": "Company names to identify or enrich." }, "fields": { "type": "array", "items": { "enum": [ "basic_info", "headcount", "funding", "locations", "taxonomy", "revenue", "hiring", "followers", "seo", "competitors", "social_profiles", "web_traffic", "employee_reviews", "people", "news", "software_reviews", "public_launches", "market_intel", "technographics", "reviews" ], "type": "string" }, "default": [ "basic_info" ], "example": [ "basic_info" ], "description": "Documented company enrich sections to include. Defaults to basic_info only to keep payloads lean; request headcount, taxonomy, people, or other sections explicitly." }, "domains": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "openai.com" ], "maxItems": 25, "minItems": 1, "description": "Website domains to identify or enrich." }, "company_id": { "type": "string" }, "exact_match": { "type": "boolean", "example": true, "description": "Restrict matching to exact domain/name behavior when supported by Crustdata. Recommended for domain-sensitive account lookups." }, "crustdata_company_ids": { "type": "array", "items": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "example": [ 12345 ], "maxItems": 25, "minItems": 1, "description": "Crustdata company IDs." }, "professional_network_profile_urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "https://www.linkedin.com/company/openai" ], "maxItems": 25, "minItems": 1, "description": "Company professional-network profile URLs." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/company/identify": { "post": { "summary": "Core workflow route: normalize company inputs from domains, names, professional-network company URLs, or Crustdata IDs before account enrichment or people search. Minimum-charge route: $0.01 on successful upstream calls.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_company_identify", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "domains": [ "openai.com" ], "exact_match": true }, "properties": { "names": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "OpenAI" ], "maxItems": 25, "minItems": 1, "description": "Company names to identify or enrich." }, "domain": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "openai.com" ], "maxItems": 25, "minItems": 1, "description": "Website domains to identify or enrich." }, "exact_match": { "type": "boolean", "example": true, "description": "Restrict matching to exact domain/name behavior when supported by Crustdata. Recommended for domain-sensitive account lookups." }, "crustdata_company_ids": { "type": "array", "items": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "example": [ 12345 ], "maxItems": 25, "minItems": 1, "description": "Crustdata company IDs." }, "professional_network_profile_urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "https://www.linkedin.com/company/openai" ], "maxItems": 25, "minItems": 1, "description": "Company professional-network profile URLs." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/company/search": { "post": { "summary": "Core workflow route: build a target account page from the cached Crustdata company dataset using provider-native filters, fields, sorts, cursor, aggregations, and limit. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. CompanyDB search is priced at 0.03 Crustdata credits per returned company.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_company_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "limit": 10, "fields": [ "basic_info.name", "basic_info.primary_domain", "headcount.total" ], "filters": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] } }, "properties": { "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum records to return. Max 100." }, "query": { "type": "string" }, "sorts": { "type": "array", "items": { "type": "object", "required": [ "field", "order" ], "properties": { "field": { "type": "string", "example": "headcount.total", "minLength": 1, "description": "Provider-native field path. The live 2025-11-01 API expects field even though some Crustdata examples use column." }, "order": { "enum": [ "asc", "desc" ], "type": "string", "example": "desc", "description": "Sort direction." } }, "additionalProperties": {} }, "example": [ { "field": "headcount.total", "order": "desc" } ], "description": "Crustdata sort descriptors using the live API field/order contract." }, "cursor": { "type": "string", "example": "eyJwYWdlIjoyfQ", "minLength": 1, "description": "Cursor returned by the previous page." }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "basic_info.name", "basic_info.primary_domain", "headcount.total" ], "description": "Response field sections or dot-paths to include." }, "filters": { "example": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] }, "description": "Crustdata provider-native filter condition or condition group." }, "preview": { "type": "boolean", "example": false, "description": "Return preview metadata when supported by the endpoint." }, "aggregations": { "example": { "field": "taxonomy.professional_network_industry" }, "description": "Provider-native aggregation request for endpoints that support it." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/company/search/autocomplete": { "post": { "summary": "Query-builder helper route: autocomplete company search field values for UI/filter construction. Minimum-charge route: $0.01 on successful upstream calls.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_company_search_autocomplete", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "field": "taxonomy.professional_network_industry", "limit": 10, "query": "Software" }, "required": [ "field" ], "properties": { "field": { "type": "string", "example": "taxonomy.professional_network_industry", "minLength": 1, "description": "Company search field to autocomplete, using Crustdata dot-path notation for indexed endpoints." }, "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum suggestions to return." }, "query": { "type": "string", "example": "Software", "description": "Partial value to match." }, "filters": { "example": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] }, "description": "Optional provider-native filters to narrow suggestions." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/job/search": { "post": { "summary": "Core workflow route: search cached job listings to infer account growth, hiring priorities, expansion, or technology adoption. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. Indexed job search is priced at 0.03 Crustdata credits per returned job.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_job_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "limit": 10, "fields": [ "job_details.title", "company.basic_info.name", "job_details.url" ], "filters": { "op": "and", "conditions": [ { "type": "=", "field": "company.basic_info.primary_domain", "value": "browserbase.com" } ] } }, "properties": { "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum records to return. Max 100." }, "query": { "type": "string" }, "sorts": { "type": "array", "items": { "type": "object", "required": [ "field", "order" ], "properties": { "field": { "type": "string", "example": "headcount.total", "minLength": 1, "description": "Provider-native field path. The live 2025-11-01 API expects field even though some Crustdata examples use column." }, "order": { "enum": [ "asc", "desc" ], "type": "string", "example": "desc", "description": "Sort direction." } }, "additionalProperties": {} }, "example": [ { "field": "headcount.total", "order": "desc" } ], "description": "Crustdata sort descriptors using the live API field/order contract." }, "cursor": { "type": "string", "example": "eyJwYWdlIjoyfQ", "minLength": 1, "description": "Cursor returned by the previous page." }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "basic_info.name", "basic_info.primary_domain", "headcount.total" ], "description": "Response field sections or dot-paths to include." }, "filters": { "example": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] }, "description": "Crustdata provider-native filter condition or condition group." }, "preview": { "type": "boolean", "example": false, "description": "Return preview metadata when supported by the endpoint." }, "aggregations": { "example": { "field": "taxonomy.professional_network_industry" }, "description": "Provider-native aggregation request for endpoints that support it." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/job/search/autocomplete": { "post": { "summary": "Query-builder helper route: autocomplete job search field values for hiring-signal filter construction. Minimum-charge route: $0.01 on successful upstream calls.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_job_search_autocomplete", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "field": "title", "limit": 10, "query": "Software" }, "required": [ "field", "query" ], "properties": { "field": { "type": "string", "example": "title", "minLength": 1, "description": "Job search field to autocomplete, using Crustdata job-search field names or documented aliases." }, "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum suggestions to return." }, "query": { "type": "string", "example": "Software", "description": "Partial value to match. Use an empty string for top values when supported." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/person/contact/enrich": { "post": { "summary": "Core workflow route: enrich one person's contact records by professional-network profile URL or business email. Use this when the workflow specifically needs business emails, personal emails, or phone numbers; request only the contact sub-fields needed to control credits. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. Contact enrich is priced at one to five Crustdata credits per record and may require contact-enrich entitlement on the configured Crustdata key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_person_contact_enrich", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "fields": [ "contact.business_emails" ], "professional_network_profile_urls": [ "https://www.linkedin.com/in/example" ] }, "properties": { "fields": { "type": "array", "items": { "enum": [ "contact", "contact.business_emails", "contact.business_emails.email", "contact.business_emails.status", "contact.personal_emails", "contact.personal_emails.email", "contact.personal_emails.status", "contact.phone_numbers", "crustdata_person_id" ], "type": "string" }, "example": [ "contact.business_emails" ], "description": "Contact data fields to request. Use contact for all contact records, or request specific contact tiers or sub-fields to control credits." }, "person_id": { "type": "string" }, "business_emails": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "founder@example.com" ], "maxItems": 25, "minItems": 1, "description": "Business emails for reverse lookup. Max 25." }, "professional_network_profile_urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "https://www.linkedin.com/in/example" ], "maxItems": 25, "minItems": 1, "description": "Person profile URLs to enrich for contact data. Max 25." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/person/enrich": { "post": { "summary": "Core workflow route: enrich up to 25 people per call by LinkedIn/professional-network profile URL or business email. For large lists, chunk identifiers into groups of 25 so each group uses one payment instead of one payment per person. Request narrow dot-paths when possible; use raw current_title as the primary scoring signal because normalized_title is beta, and note that some fields require field-level permission on the configured Crustdata key. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. DB profile enrich starts at one credit by profile URL or two credits by business-email reverse lookup; contact and developer field bundles settle according to Crustdata's documented add-ons up to seven credits per profile.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_person_enrich", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "fields": [ "basic_profile.name", "basic_profile.current_title", "social_handles.professional_network_identifier.profile_url" ], "professional_network_profile_urls": [ "https://www.linkedin.com/in/example" ] }, "properties": { "fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "basic_profile.name", "basic_profile.current_title", "social_handles.professional_network_identifier.profile_url" ], "description": "Provider-native person sections or dot-paths to include. Some documented fields require field-level permission on the configured Crustdata key; unsupported or unentitled fields return an upstream error and settle $0." }, "person_id": { "type": "string" }, "business_emails": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "founder@example.com" ], "maxItems": 25, "minItems": 1, "description": "Business emails for reverse lookup. Max 25." }, "min_similarity_score": { "type": "number", "example": 0.8, "maximum": 1, "minimum": 0, "description": "Minimum confidence threshold for business-email reverse lookup matches." }, "professional_network_profile_urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "https://www.linkedin.com/in/example" ], "maxItems": 25, "minItems": 1, "description": "Person profile URLs to enrich. Max 25." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/person/search": { "post": { "summary": "Core workflow route: find a page of people and prospects from the cached Crustdata person dataset using provider-native filters, fields, sorts, cursor, aggregations, and limit. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. PersonDB search is priced at 0.03 Crustdata credits per returned profile.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_person_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "limit": 10, "fields": [ "basic_profile.name", "basic_profile.current_title", "social_handles.professional_network_identifier.profile_url", "experience.employment_details.current.name" ], "filters": { "op": "and", "conditions": [ { "type": "=", "field": "experience.employment_details.current.company_website_domain", "value": "browserbase.com" } ] } }, "properties": { "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum records to return. Max 100." }, "query": { "type": "string" }, "sorts": { "type": "array", "items": { "type": "object", "required": [ "field", "order" ], "properties": { "field": { "type": "string", "example": "headcount.total", "minLength": 1, "description": "Provider-native field path. The live 2025-11-01 API expects field even though some Crustdata examples use column." }, "order": { "enum": [ "asc", "desc" ], "type": "string", "example": "desc", "description": "Sort direction." } }, "additionalProperties": {} }, "example": [ { "field": "headcount.total", "order": "desc" } ], "description": "Crustdata sort descriptors using the live API field/order contract." }, "cursor": { "type": "string", "example": "eyJwYWdlIjoyfQ", "minLength": 1, "description": "Cursor returned by the previous page." }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "basic_info.name", "basic_info.primary_domain", "headcount.total" ], "description": "Response field sections or dot-paths to include." }, "filters": { "example": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] }, "description": "Crustdata provider-native filter condition or condition group." }, "preview": { "type": "boolean", "example": false, "description": "Return preview metadata when supported by the endpoint." }, "aggregations": { "example": { "field": "taxonomy.professional_network_industry" }, "description": "Provider-native aggregation request for endpoints that support it." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/person/search/autocomplete": { "post": { "summary": "Query-builder helper route: autocomplete person search field values for UI/filter construction. Minimum-charge route: $0.01 on successful upstream calls.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_person_search_autocomplete", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "field": "basic_profile.country", "limit": 10, "query": "United" }, "required": [ "field" ], "properties": { "field": { "type": "string", "example": "basic_profile.country", "minLength": 1, "description": "Person search field to autocomplete, using Crustdata-supported person autocomplete fields." }, "limit": { "type": "integer", "example": 10, "maximum": 100, "minimum": 1, "description": "Maximum suggestions to return." }, "query": { "type": "string", "example": "United", "description": "Partial value to match." }, "filters": { "example": { "op": "and", "conditions": [ { "type": "=", "field": "basic_info.primary_domain", "value": "browserbase.com" } ] }, "description": "Optional provider-native filters to narrow suggestions." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/person/search/role-cluster": { "post": { "summary": "Decision-maker helper route: find founders, executives, GTM, product, technical, partnerships, or other role-cluster candidates at one current employer using Crustdata person/search nested filters. Returns raw Crustdata people profiles with basic_profile, social_handles, and experience rows by default so callers can inspect profile URLs and matching current employment. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. Priced like PersonDB search at 0.03 Crustdata credits per returned profile.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_person_search_role_cluster", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "limit": 10, "role_cluster": "decision_makers", "company_domain": "browserbase.com" }, "required": [ "role_cluster" ], "properties": { "limit": { "type": "integer", "maximum": 25, "minimum": 1, "description": "Maximum profiles to return. Defaults to 10; max 25." }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Crustdata response fields or sections to return. Defaults to basic_profile, social_handles, and experience so callers can inspect current-employment rows and profile URLs." }, "company_name": { "type": "string", "minLength": 1, "description": "Current employer company name when a domain or professional-network URL is not available." }, "role_cluster": { "enum": [ "decision_makers", "executive_founder", "product_growth_gtm", "technical_platform_api_security", "partnerships_ecosystem_devrel" ], "type": "string", "default": "decision_makers", "description": "Motion-oriented role cluster to search. Defaults to decision_makers." }, "company_domain": { "type": "string", "minLength": 1, "description": "Current employer website domain, e.g. browserbase.com." }, "company_professional_network_profile_url": { "type": "string", "format": "uri", "description": "Exact current employer professional-network company profile URL." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/web/enrich/live": { "post": { "summary": "Core workflow route: fetch and enrich public web pages returned by web search or supplied by the caller. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. Estimates one Crustdata credit per URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "crustdata_post__api_v1_web_enrich_live", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "urls": [ "https://example.com" ] }, "required": [ "urls" ], "properties": { "url": { "type": "string" }, "urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "example": [ "https://example.com" ], "maxItems": 10, "minItems": 1, "description": "Public URLs to fetch. Max 10." }, "human_mode": { "type": "boolean", "example": false, "description": "Attempt a browser-like retrieval path when standard access is blocked." } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/crustdata/web/search/live": { "post": { "summary": "Core workflow route: run live web, news, scholar, AI, or social search to add external context around accounts, people, funding, markets, or recent events. Default pricing is $0.10 per Crustdata credit with a $0.01 minimum successful-call settlement. Upstream Crustdata errors settle $0. Estimates one Crustdata credit per query.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "description": "Raw JSON response returned by Crustdata." }, "billing": { "type": "object", "required": [ "apiCredits", "minimumCallUsdcMicro", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "example": 0.06, "description": "Estimated Crustdata API credits charged for this request." }, "settledUsdcMicro": { "type": "string", "example": "10000", "description": "USDC micro-units settled for this request." }, "minimumCallUsdcMicro": { "type": "string", "example": "10000", "description": "Configured minimum successful-call settlement in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "example": "100000", "description": "Configured USDC micro-units charged per Crustdata API credit." } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Perform a live search using Crustdata.", "operationId": "crustdata_post__api_v1_web_search_live", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "page": 1, "query": "recent funding news for AI infrastructure startups", "sources": [ "web", "news" ], "location": "US" }, "required": [ "query" ], "properties": { "page": { "type": "integer", "example": 1, "maximum": 1, "minimum": 1, "description": "Number of result pages to aggregate." }, "site": { "type": "string", "example": "example.com", "maxLength": 500, "description": "Restrict results to a domain or path." }, "query": { "type": "string", "example": "recent funding news for AI infrastructure startups", "maxLength": 5000, "minLength": 1, "description": "Search query text." }, "sources": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "web", "news" ], "description": "Sources to query, such as web, news, scholar-articles, ai, or social." }, "end_date": { "type": "integer", "example": 1767225600, "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Unix timestamp in seconds; only results before this date." }, "location": { "type": "string", "example": "US", "maxLength": 2, "minLength": 2, "description": "ISO 3166-1 alpha-2 country code for region-specific results." }, "human_mode": { "type": "boolean", "example": false, "description": "Attempt a browser-like retrieval path when standard access is blocked." }, "start_date": { "type": "integer", "example": 1735689600, "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Unix timestamp in seconds; only results after this date." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing detailed request/response schema properties" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "crustdata-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service crustdata-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "crustdata-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/deploy/apps": { "post": { "summary": "Node.js hosting: ship the Node app you built locally, unchanged — full server runtime on Cloud Run with a dedicated Postgres. Native modules OK. App reads DATABASE_URL + listens on PORT. Filesystem is writable but ephemeral (scale-to-zero) — keep durable state in Postgres. Durable /data file storage (1 GiB included).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "appId", "slug", "url", "status", "billing_rail", "replayed" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "null on a fresh accept — poll GET /api/v1/apps/:id for the live serving URL. An idempotent replay returns the URL once the deploy has persisted it." }, "slug": { "type": "string" }, "appId": { "type": "string" }, "status": { "type": "string", "description": "'building' on a fresh accept; an idempotent replay returns the app's current status. Poll GET /api/v1/apps/:id for progress." }, "replayed": { "type": "boolean" }, "billing_rail": { "enum": [ "direct", "zeroclick", "internal", "key" ], "type": "string", "description": "Which rail paid for this term: 'direct' = an on-chain USDC charge, 'zeroclick' = a marketplace term grant, 'key' = the buyer account's prepaid balance drawn by an API key, 'internal' = no money moved." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Deploy a new application.", "operationId": "deploy_post__api_v1_apps", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "source" ], "properties": { "env": { "type": "object", "description": "Extra environment variables for your app, KMS-encrypted at rest. DATABASE_URL / PORT / ZERO_* are injected at deploy — do not set them.", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "slug": { "type": "string", "maxLength": 63, "minLength": 1, "description": "Subdomain to serve at (.withzero.xyz). Lowercase letters, digits, hyphens. Defaults to a generated id. A taken slug is a 409 SLUG_TAKEN before any charge." }, "source": { "type": "string", "minLength": 1, "description": "Base64-encoded zip of your Node app (must contain a top-level package.json with a `start` script). Runtime is Node." }, "ackEphemeral": { "type": "boolean", "description": "Acknowledge the filesystem is ephemeral: required to deploy an app whose package.json depends on sqlite3/better-sqlite3 (else 400 SQLITE_NOT_DURABLE, before any charge). Durable state belongs in the injected DATABASE_URL Postgres." }, "term_fee_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Direct rail only: per-term hosting fee in micro-USDC. MUST equal the X-Pay-Amount-Micros header and current termFeeMicros. Omit through ZeroClick; its app-terms usage ledger is authoritative." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing detailed request/response schema properties" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing requestBody schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "app-terms" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "600000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.600000 per terms (terms, service app-terms)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.600000" }, "rates": [ { "service": "app-terms", "meter": "terms", "unit": "terms", "unitSize": 1, "priceUsd": "0.600000", "includedUnits": 0 } ] } } }, "/api/v1/deploy/apps/{id}/renew": { "post": { "summary": "Extend an app hosting term.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "appId", "termExpiresAt", "resumed", "billing_rail", "replayed" ], "properties": { "appId": { "type": "string" }, "resumed": { "type": "boolean", "description": "True when this renewal brought a paused (lapsed) app back — a redeploy from its last source was queued." }, "replayed": { "type": "boolean" }, "billing_rail": { "enum": [ "direct", "zeroclick", "key" ], "type": "string", "description": "Which rail paid for this term: 'direct' = an on-chain USDC charge, 'zeroclick' = a marketplace term grant, 'key' = the buyer account's prepaid balance drawn by an API key." }, "termExpiresAt": { "type": "string", "description": "The new hosting-term expiry after this renewal (ISO-8601)." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "deploy_post__api_v1_apps__id__renew", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "term_fee_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Direct rail only: per-term hosting fee in micro-USDC. MUST equal X-Pay-Amount-Micros. Omit through ZeroClick; its app-terms usage ledger is authoritative." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing requestBody schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "app-terms" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "600000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.600000 per terms (terms, service app-terms)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.600000" }, "rates": [ { "service": "app-terms", "meter": "terms", "unit": "terms", "unitSize": 1, "priceUsd": "0.600000", "includedUnits": 0 } ] } } }, "/api/v1/forms/forms": { "post": { "summary": "Create a hosted web form from a field schema and get a public URL where it can be filled in.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "url", "submitUrl", "redirectUrl" ], "properties": { "id": { "type": "string", "description": "6-character form id." }, "url": { "type": "string", "format": "uri", "description": "Public URL where the form renders." }, "submitUrl": { "type": "string", "format": "uri", "description": "Endpoint the rendered form POSTs submissions to — also usable as the action of a plain HTML
." }, "redirectUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where a plain HTML form post lands after a successful submit; null shows a minimal \"Thanks\" page." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Create a new form.", "operationId": "forms_post__api_v1_forms", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "schema", "recipients" ], "properties": { "title": { "type": "string", "maxLength": 200, "description": "Optional heading shown above the form." }, "schema": { "type": "object", "description": "JSON Schema describing the form fields (rjsf-compatible).", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "webhook": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "description": "Each submission is POSTed here (HMAC-signed), alongside the email notification." }, "secret": { "type": "string", "maxLength": 256, "minLength": 8, "description": "HMAC secret. Required when the receiver verifies signatures — e.g. an inbox generic connection." } }, "description": "Optional delivery webhook. Point it at an inbox connection URL to flow submissions into an agent inbox.", "additionalProperties": false }, "uiSchema": { "type": "object", "description": "Optional rjsf UiSchema for widget hints and ordering.", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recipients": { "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "maxItems": 20, "minItems": 1, "description": "1–20 email addresses notified on each submission." }, "redirectUrl": { "type": "string", "maxLength": 2048, "description": "Absolute https: URL a plain HTML form post (application/x-www-form-urlencoded, no JavaScript) is redirected to (303) after a successful submit. Without it the visitor sees a minimal \"Thanks\" page." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing detailed request/response schema properties" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "forms-create" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/forms/forms/{id}/submissions": { "get": { "summary": "Read back the submissions to a form you created, newest first. Only the identity that created the form can read them. Paginate with limit (max 200) and the returned nextCursor.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "submissions", "nextCursor" ], "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next (older) page; null when this is the last page." }, "submissions": { "type": "array", "items": { "type": "object", "required": [ "id", "createdAt", "payload" ], "properties": { "id": { "type": "string" }, "payload": { "type": "object", "description": "The submitted field values.", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "required": false, "description": "Page size, 1–200 (default 50)." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "required": false, "description": "The `nextCursor` from the previous page; omit for the newest submissions." } ], "operationId": "forms_get__api_v1_forms__id__submissions", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "forms-submissions-list" ], "description": "Read back the submissions to a form you created, newest first. Only the identity that created the form can read them. Paginate with limit (max 200) and the returned nextCursor.", "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/image/images/gpt-5-image": { "post": { "summary": "Generate images from a text prompt with OpenAI GPT-5 Image — strongest instruction following and legible in-image text. Returns hosted image URLs.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "images", "model", "price_usdc" ], "properties": { "model": { "type": "string", "description": "The model that produced the images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url", "mimeType", "sizeBytes" ], "properties": { "url": { "type": "string" }, "mimeType": { "type": "string" }, "sizeBytes": { "type": "number" } }, "additionalProperties": false }, "description": "The generated images, as hosted URLs." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Generate hosted images with flagship text-to-image models.", "operationId": "image_post__api_v1_images_gpt_5_image", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "count": 1, "prompt": "A watercolor painting of a lighthouse at sunrise" }, "required": [ "prompt", "count" ], "properties": { "count": { "type": "integer", "default": 1, "maximum": 4, "minimum": 1, "description": "How many images to generate (1–4)." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the image to generate." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "gpt-5-image" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "210000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.210000 per images (images, service gpt-5-image)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.210000" }, "rates": [ { "service": "gpt-5-image", "meter": "images", "unit": "images", "unitSize": 1, "priceUsd": "0.210000", "includedUnits": 0 } ] } } }, "/api/v1/image/images/grok-imagine": { "post": { "summary": "Generate images from a text prompt with xAI's Grok Imagine quality tier. Returns hosted image URLs.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "images", "model", "price_usdc" ], "properties": { "model": { "type": "string", "description": "The model that produced the images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url", "mimeType", "sizeBytes" ], "properties": { "url": { "type": "string" }, "mimeType": { "type": "string" }, "sizeBytes": { "type": "number" } }, "additionalProperties": false }, "description": "The generated images, as hosted URLs." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Generate hosted images with flagship text-to-image models.", "operationId": "image_post__api_v1_images_grok_imagine", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "count": 1, "prompt": "A watercolor painting of a lighthouse at sunrise" }, "required": [ "prompt", "count" ], "properties": { "count": { "type": "integer", "default": 1, "maximum": 4, "minimum": 1, "description": "How many images to generate (1–4)." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the image to generate." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "grok-imagine" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per images (images, service grok-imagine, first 2 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "grok-imagine", "meter": "images", "unit": "images", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 2 } ], "included": [ { "meterSlug": "images", "unit": "images", "freeUnits": 2, "per": "account" } ] } } }, "/api/v1/image/images/nano-banana-2": { "post": { "summary": "Generate images from a text prompt with Google's Nano Banana 2 (Gemini 3.1 Flash Image) — fast, high-quality generation. Returns hosted image URLs.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "images", "model", "price_usdc" ], "properties": { "model": { "type": "string", "description": "The model that produced the images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url", "mimeType", "sizeBytes" ], "properties": { "url": { "type": "string" }, "mimeType": { "type": "string" }, "sizeBytes": { "type": "number" } }, "additionalProperties": false }, "description": "The generated images, as hosted URLs." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Generate hosted images with flagship text-to-image models.", "operationId": "image_post__api_v1_images_nano_banana_2", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "count": 1, "prompt": "A watercolor painting of a lighthouse at sunrise" }, "required": [ "prompt", "count" ], "properties": { "count": { "type": "integer", "default": 1, "maximum": 4, "minimum": 1, "description": "How many images to generate (1–4)." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the image to generate." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "nano-banana-2" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "70000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.070000 per images (images, service nano-banana-2, first 1 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.070000" }, "rates": [ { "service": "nano-banana-2", "meter": "images", "unit": "images", "unitSize": 1, "priceUsd": "0.070000", "includedUnits": 1 } ], "included": [ { "meterSlug": "images", "unit": "images", "freeUnits": 1, "per": "account" } ] } } }, "/api/v1/image/images/nano-banana-pro": { "post": { "summary": "Generate images from a text prompt with Google's Nano Banana Pro (Gemini 3 Pro Image) — highest-quality photorealistic output. Returns hosted image URLs.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "images", "model", "price_usdc" ], "properties": { "model": { "type": "string", "description": "The model that produced the images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url", "mimeType", "sizeBytes" ], "properties": { "url": { "type": "string" }, "mimeType": { "type": "string" }, "sizeBytes": { "type": "number" } }, "additionalProperties": false }, "description": "The generated images, as hosted URLs." }, "price_usdc": { "type": "string", "description": "The amount charged for this request, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Generate hosted images with flagship text-to-image models.", "operationId": "image_post__api_v1_images_nano_banana_pro", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "count": 1, "prompt": "A watercolor painting of a lighthouse at sunrise" }, "required": [ "prompt", "count" ], "properties": { "count": { "type": "integer", "default": 1, "maximum": 4, "minimum": 1, "description": "How many images to generate (1–4)." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the image to generate." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "nano-banana-pro" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "140000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.140000 per images (images, service nano-banana-pro)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.140000" }, "rates": [ { "service": "nano-banana-pro", "meter": "images", "unit": "images", "unitSize": 1, "priceUsd": "0.140000", "includedUnits": 0 } ] } } }, "/api/v1/inbox/inboxes": { "post": { "summary": "Provision your inbox — call this FIRST (free, ~6-month lease keyed to your signed wallet; re-call to extend before it expires). Then: publish via POST /api/v1/events, long-poll GET /api/v1/inbox, ack handled events via POST /api/v1/inbox/ack, check the lease via GET /api/v1/inboxes/me. Receive other wallets’ events via POST /api/v1/subscriptions and external webhooks via POST /api/v1/connections. See the API description for the full workflow. 📖 Full guide: https://inbox.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "owner", "expiresAt", "messageTtlDays", "maxMessages", "lifetimeTopups" ], "properties": { "owner": { "type": "string", "description": "Your wallet address; the inbox is keyed to it." }, "expiresAt": { "type": "string", "description": "ISO timestamp the lease is active until." }, "maxMessages": { "type": "number", "description": "Maximum stored (unexpired) messages." }, "lifetimeTopups": { "type": "number", "description": "Number of times this lease has been extended." }, "messageTtlDays": { "type": "number", "description": "How long delivered messages are retained." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Provision durable inboxes.", "operationId": "inbox_post__api_v1_inboxes", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "inbox-inboxes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/memory/memories": { "post": { "summary": "Remember a fact or context in durable agent memory.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "key", "billing_rail", "replayed", "balance_micros" ], "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "replayed": { "type": "boolean" }, "billing_rail": { "enum": [ "direct", "zeroclick" ], "type": "string" }, "balance_micros": { "type": "string", "description": "Remaining refundable direct-rail prepaid balance in USDC micros. ZeroClick usage never changes it." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Durable, private agent memory operations.", "operationId": "memory_post__api_v1_memories", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "content" ], "properties": { "ns": { "type": "string", "maxLength": 128, "minLength": 1, "description": "Namespace under the caller (e.g. agent:coder). Defaults to \"default\"." }, "key": { "type": "string", "maxLength": 256, "minLength": 1, "description": "Caller-chosen key, unique per (owner, ns). Omit to auto-generate." }, "tags": { "type": "array", "items": { "type": "string" }, "maxItems": 32, "description": "Optional tags for later filtering." }, "pinned": { "type": "boolean", "description": "Mark as a \"standing order\": always surfaced by recall and never consolidated/suppressed by dreaming. Omit on update to leave it unchanged." }, "content": { "type": "string", "maxLength": 8192, "minLength": 1, "description": "The memory text to remember." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "memory-ops" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per ops (ops, service memory-ops, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "memory-ops", "meter": "ops", "unit": "ops", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "ops", "unit": "ops", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/openrouter/chat/completions": { "post": { "summary": "OpenAI-compatible chat completion via any OpenRouter model, paid in one shot: price = estimated input tokens x input rate + max_tokens x output rate, resolved before the call and capped per model (from $0.10 for cheap models up to $5 for premium models like anthropic/claude-fable-5). For longer generations use POST /api/v1/chat/completions/metered. 📖 Full guide: https://openrouter.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "object", "created", "model", "choices", "billing" ], "properties": { "id": { "type": "string" }, "model": { "type": "string" }, "usage": { "type": "object", "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "properties": { "cost": { "type": "number" }, "total_tokens": { "type": "number" }, "prompt_tokens": { "type": "number" }, "completion_tokens": { "type": "number" } }, "additionalProperties": false }, "object": { "type": "string" }, "billing": { "type": "object", "required": [ "promptTokens", "completionTokens", "reservedUsdcMicro", "settledUsdcMicro", "actualUsdcMicro", "costBasis" ], "properties": { "costBasis": { "enum": [ "openrouter", "rates", "estimated" ], "type": "string", "description": "Where actualUsdcMicro came from: OpenRouter usage accounting > cached per-token rates > character estimate" }, "promptTokens": { "type": "number", "description": "Actual input tokens consumed" }, "actualUsdcMicro": { "type": "string", "description": "Best-known actual cost of the call in micro-USDC. On the fixed route this is informational — the charge is settledUsdcMicro." }, "completionTokens": { "type": "number", "description": "Actual output tokens generated" }, "settledUsdcMicro": { "type": "string", "description": "Micro-USDC actually charged to the buyer. Fixed route: the up-front worst-case estimate (= reservedUsdcMicro). Metered route: actual usage (= actualUsdcMicro)." }, "reservedUsdcMicro": { "type": "string", "description": "Worst-case micro-USDC committed before the call" } }, "additionalProperties": false }, "choices": { "type": "array", "items": { "type": "object", "required": [ "index", "message", "finish_reason" ], "properties": { "index": { "type": "number" }, "message": { "type": "object", "required": [ "role", "content" ], "properties": { "role": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tool_calls": { "type": "array", "items": {} } }, "additionalProperties": false }, "logprobs": {}, "finish_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created": { "type": "number" }, "system_fingerprint": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Call any OpenRouter chat model with metered, at-cost billing.", "operationId": "openrouter_post__api_v1_chat_completions", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "model": "openai/gpt-4o-mini", "messages": [ { "role": "user", "content": "Say hello in one sentence." } ], "max_tokens": 64 }, "required": [ "model", "messages", "max_tokens", "stream" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Random seed for deterministic outputs (support varies by model)." }, "stop": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Stop sequence(s): generation halts when any is produced." }, "model": { "type": "string", "minLength": 1, "description": "OpenRouter model ID, e.g. \"openai/gpt-4o-mini\", \"anthropic/claude-haiku-4-5\", \"google/gemini-flash-1.5\". Use GET /api/v1/models to list all available models with pricing." }, "route": { "type": "string", "description": "OpenRouter routing strategy, e.g. \"fallback\". Requires an explicit `models` list so every candidate model can be priced." }, "tools": { "type": "array", "items": {}, "description": "OpenAI-format tool definitions for function calling." }, "top_k": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Top-k sampling: limit to the k most likely next tokens." }, "top_p": { "type": "number", "maximum": 1, "minimum": 0, "description": "Nucleus sampling probability mass 0–1. Alternative to temperature." }, "models": { "type": "array", "items": { "type": "string" }, "description": "Fallback model list for OpenRouter auto-routing. Tried in order if the primary model is unavailable. The price reservation is taken at the most expensive rates across model + models, since any of them may serve the call; the difference is refunded on the metered route." }, "stream": { "type": "boolean", "const": false, "default": false, "description": "Must be false — streaming is not supported in v1." }, "messages": { "type": "array", "items": { "type": "object", "required": [ "role", "content" ], "properties": { "name": { "type": "string", "description": "Optional display name for the message author" }, "role": { "enum": [ "system", "user", "assistant", "tool" ], "type": "string", "description": "Message role: system (instructions), user (human turn), assistant (model turn), or tool (tool result)" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Message text content, or null for tool-call-only assistant turns" }, "tool_calls": { "type": "array", "items": {}, "description": "For role=assistant: tool calls the model is making" }, "tool_call_id": { "type": "string", "description": "For role=tool: the tool_call_id this result responds to" } }, "additionalProperties": false }, "minItems": 1, "description": "Conversation history as an array of {role, content} objects. At minimum one user message is required." }, "reasoning": { "type": "object", "properties": { "effort": { "enum": [ "none", "minimal", "low", "medium", "high", "xhigh" ], "type": "string", "description": "Reasoning effort level. Mutually exclusive with max_tokens." }, "enabled": { "type": "boolean", "description": "Enable reasoning at the default (medium) effort." }, "exclude": { "type": "boolean", "description": "Generate reasoning but omit it from the response." }, "max_tokens": { "type": "integer", "maximum": 9007199254740991, "description": "Explicit reasoning token budget.", "exclusiveMinimum": 0 } }, "description": "OpenRouter reasoning config for thinking models. Reasoning tokens bill as output tokens and are added to the price reservation.", "additionalProperties": false }, "logit_bias": { "type": "object", "description": "Token ID → bias (-100 to 100) to adjust generation likelihood.", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "max_tokens": { "type": "integer", "default": 4096, "maximum": 9007199254740991, "description": "Maximum output tokens. Controls your spend ceiling — the price reservation is input estimate x input_rate + (max_tokens + reasoning budget) x output_rate. The fixed route rejects requests reserving above its cap; use the metered route for large values.", "exclusiveMinimum": 0 }, "transforms": { "type": "array", "items": { "type": "string" }, "description": "OpenRouter prompt transforms, e.g. [\"middle-out\"] for context compression." }, "temperature": { "type": "number", "maximum": 2, "minimum": 0, "description": "Sampling temperature 0–2. Higher = more random. Defaults to model default (usually ~1.0)." }, "tool_choice": { "description": "Tool selection strategy: \"auto\", \"none\", \"required\", or a specific tool name." }, "response_format": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } }, "description": "Output format, e.g. {\"type\":\"json_object\"} to force JSON output.", "additionalProperties": false }, "presence_penalty": { "type": "number", "description": "Penalise tokens that have appeared at all in the context (-2 to 2)." }, "frequency_penalty": { "type": "number", "description": "Penalise tokens proportional to how often they already appear (-2 to 2)." }, "repetition_penalty": { "type": "number", "description": "Repetition penalty multiplier (1.0 = no penalty). Some models only." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "openrouter-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service openrouter-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "openrouter-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/openrouter/chat/completions/metered": { "post": { "summary": "OpenAI-compatible chat completion via any OpenRouter model with metered at-cost billing: escrow a worst-case reservation (up to 5 USDC), pay only actual token usage — the difference is refunded after the call. Use this route for long generations, big contexts, and reasoning models; the fixed route caps out much lower. 📖 Full guide: https://openrouter.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "object", "created", "model", "choices", "billing" ], "properties": { "id": { "type": "string" }, "model": { "type": "string" }, "usage": { "type": "object", "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "properties": { "cost": { "type": "number" }, "total_tokens": { "type": "number" }, "prompt_tokens": { "type": "number" }, "completion_tokens": { "type": "number" } }, "additionalProperties": false }, "object": { "type": "string" }, "billing": { "type": "object", "required": [ "promptTokens", "completionTokens", "reservedUsdcMicro", "settledUsdcMicro", "actualUsdcMicro", "costBasis" ], "properties": { "costBasis": { "enum": [ "openrouter", "rates", "estimated" ], "type": "string", "description": "Where actualUsdcMicro came from: OpenRouter usage accounting > cached per-token rates > character estimate" }, "promptTokens": { "type": "number", "description": "Actual input tokens consumed" }, "actualUsdcMicro": { "type": "string", "description": "Best-known actual cost of the call in micro-USDC. On the fixed route this is informational — the charge is settledUsdcMicro." }, "completionTokens": { "type": "number", "description": "Actual output tokens generated" }, "settledUsdcMicro": { "type": "string", "description": "Micro-USDC actually charged to the buyer. Fixed route: the up-front worst-case estimate (= reservedUsdcMicro). Metered route: actual usage (= actualUsdcMicro)." }, "reservedUsdcMicro": { "type": "string", "description": "Worst-case micro-USDC committed before the call" } }, "additionalProperties": false }, "choices": { "type": "array", "items": { "type": "object", "required": [ "index", "message", "finish_reason" ], "properties": { "index": { "type": "number" }, "message": { "type": "object", "required": [ "role", "content" ], "properties": { "role": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tool_calls": { "type": "array", "items": {} } }, "additionalProperties": false }, "logprobs": {}, "finish_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created": { "type": "number" }, "system_fingerprint": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Call any OpenRouter chat model with metered, at-cost billing.", "operationId": "openrouter_post__api_v1_chat_completions_metered", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "model": "openai/gpt-4o-mini", "messages": [ { "role": "user", "content": "Say hello in one sentence." } ], "max_tokens": 64 }, "required": [ "model", "messages", "max_tokens", "stream" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Random seed for deterministic outputs (support varies by model)." }, "stop": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Stop sequence(s): generation halts when any is produced." }, "model": { "type": "string", "minLength": 1, "description": "OpenRouter model ID, e.g. \"openai/gpt-4o-mini\", \"anthropic/claude-haiku-4-5\", \"google/gemini-flash-1.5\". Use GET /api/v1/models to list all available models with pricing." }, "route": { "type": "string", "description": "OpenRouter routing strategy, e.g. \"fallback\". Requires an explicit `models` list so every candidate model can be priced." }, "tools": { "type": "array", "items": {}, "description": "OpenAI-format tool definitions for function calling." }, "top_k": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "description": "Top-k sampling: limit to the k most likely next tokens." }, "top_p": { "type": "number", "maximum": 1, "minimum": 0, "description": "Nucleus sampling probability mass 0–1. Alternative to temperature." }, "models": { "type": "array", "items": { "type": "string" }, "description": "Fallback model list for OpenRouter auto-routing. Tried in order if the primary model is unavailable. The price reservation is taken at the most expensive rates across model + models, since any of them may serve the call; the difference is refunded on the metered route." }, "stream": { "type": "boolean", "const": false, "default": false, "description": "Must be false — streaming is not supported in v1." }, "messages": { "type": "array", "items": { "type": "object", "required": [ "role", "content" ], "properties": { "name": { "type": "string", "description": "Optional display name for the message author" }, "role": { "enum": [ "system", "user", "assistant", "tool" ], "type": "string", "description": "Message role: system (instructions), user (human turn), assistant (model turn), or tool (tool result)" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Message text content, or null for tool-call-only assistant turns" }, "tool_calls": { "type": "array", "items": {}, "description": "For role=assistant: tool calls the model is making" }, "tool_call_id": { "type": "string", "description": "For role=tool: the tool_call_id this result responds to" } }, "additionalProperties": false }, "minItems": 1, "description": "Conversation history as an array of {role, content} objects. At minimum one user message is required." }, "reasoning": { "type": "object", "properties": { "effort": { "enum": [ "none", "minimal", "low", "medium", "high", "xhigh" ], "type": "string", "description": "Reasoning effort level. Mutually exclusive with max_tokens." }, "enabled": { "type": "boolean", "description": "Enable reasoning at the default (medium) effort." }, "exclude": { "type": "boolean", "description": "Generate reasoning but omit it from the response." }, "max_tokens": { "type": "integer", "maximum": 9007199254740991, "description": "Explicit reasoning token budget.", "exclusiveMinimum": 0 } }, "description": "OpenRouter reasoning config for thinking models. Reasoning tokens bill as output tokens and are added to the price reservation.", "additionalProperties": false }, "logit_bias": { "type": "object", "description": "Token ID → bias (-100 to 100) to adjust generation likelihood.", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "max_tokens": { "type": "integer", "default": 4096, "maximum": 9007199254740991, "description": "Maximum output tokens. Controls your spend ceiling — the price reservation is input estimate x input_rate + (max_tokens + reasoning budget) x output_rate. The fixed route rejects requests reserving above its cap; use the metered route for large values.", "exclusiveMinimum": 0 }, "transforms": { "type": "array", "items": { "type": "string" }, "description": "OpenRouter prompt transforms, e.g. [\"middle-out\"] for context compression." }, "temperature": { "type": "number", "maximum": 2, "minimum": 0, "description": "Sampling temperature 0–2. Higher = more random. Defaults to model default (usually ~1.0)." }, "tool_choice": { "description": "Tool selection strategy: \"auto\", \"none\", \"required\", or a specific tool name." }, "response_format": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } }, "description": "Output format, e.g. {\"type\":\"json_object\"} to force JSON output.", "additionalProperties": false }, "presence_penalty": { "type": "number", "description": "Penalise tokens that have appeared at all in the context (-2 to 2)." }, "frequency_penalty": { "type": "number", "description": "Penalise tokens proportional to how often they already appear (-2 to 2)." }, "repetition_penalty": { "type": "number", "description": "Repetition penalty multiplier (1.0 = no penalty). Some models only." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "openrouter-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service openrouter-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "openrouter-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/company/identity": { "post": { "summary": "Resolve one company name through Pipe0 company:identity@3. At-cost fixed cap: max($0.01, 0.30 Pipe0 credits × $999/34,000 credits). Useful as a lightweight first step, fallback, or corroboration step before Crustdata enrichment workflows.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run company enrichment workflows.", "operationId": "pipe0_post__api_v1_company_identity", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "company_names": [ "OpenAI" ] }, "required": [ "company_names" ], "properties": { "environment": { "enum": [ "production", "sandbox" ], "type": "string" }, "company_names": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 1, "minItems": 1, "description": "Company names to resolve through company:identity@3." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/company/overview": { "post": { "summary": "Enrich one company domain or professional-network company profile URL through Pipe0 company:overview@3. At-cost cap: 1.00 Pipe0 credit × $999/34,000 credits for company description, industry, geography, size, and related overview fields.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run company enrichment workflows.", "operationId": "pipe0_post__api_v1_company_overview", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "company_domains": [ "openai.com" ] }, "properties": { "environment": { "enum": [ "production", "sandbox" ], "type": "string" }, "company_domains": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 1, "minItems": 1, "description": "Company domains to enrich through company:overview@3." }, "company_profile_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "maxItems": 1, "minItems": 1, "description": "Professional-network company profile URLs to enrich through company:overview@3." }, "company_website_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "maxItems": 1, "minItems": 1, "description": "Compatibility alias for website URLs. Normalized to company_domain before calling Pipe0 company:overview@3." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/company/search": { "post": { "summary": "Search one Pipe0 company profile page through companies:profiles:crustdata@2 with provider-native include/exclude filters, cursor, output fields, and a bounded 100-result limit. At-cost cap: 2 Pipe0 credits per page × $999/34,000 credits.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run company enrichment workflows.", "operationId": "pipe0_post__api_v1_company_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "limit": 10, "filters": { "linkedin_industries": { "exclude": [], "include": [ "Software Development" ] } } }, "required": [ "filters" ], "properties": { "limit": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum results. Default and max 100." }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "Pipe0 pagination cursor from next_page." }, "filters": { "type": "object", "example": { "linkedin_industries": { "exclude": [], "include": [ "Software Development" ] } }, "description": "Pipe0 provider-native company search filters. Current Crustdata company search filters use include/exclude objects, e.g. { \"linkedin_industries\": { \"include\": [\"Software Development\"], \"exclude\": [] } }.", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "environment": { "enum": [ "production", "sandbox" ], "type": "string" }, "output_fields": { "type": "object", "description": "Pipe0 output_fields config for companies:profiles:crustdata@2.", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/person/profile": { "post": { "summary": "Enrich one person profile URL through Pipe0 people:profile:waterfall@1. At-cost cap: 1.00 Pipe0 credit × $999/34,000 credits for successful profile enrichment.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run person enrichment workflows.", "operationId": "pipe0_post__api_v1_person_profile", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "profile_urls": [ "https://www.linkedin.com/in/satyanadella" ] }, "required": [ "profile_urls" ], "properties": { "environment": { "enum": [ "production", "sandbox" ], "type": "string" }, "profile_urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 1, "minItems": 1, "description": "LinkedIn/profile URLs to enrich through people:profile:waterfall@1." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/pipes/run/sync": { "post": { "summary": "Composable Pipe0-native workflow pass-through for allowlisted pipe IDs only. Runs POST /v1/pipes/run/sync for workflows that are not exposed directly by Crustdata or Wiza. Settles at cost from the bounded pipe/input estimate because Pipe0 does not return actual credits charged.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run enrichment workflows.", "operationId": "pipe0_post__api_v1_pipes_run_sync", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "input": [ { "id": "1", "company_name": "Acme" } ], "pipes": [ { "pipe_id": "company:identity@3" } ] }, "required": [ "pipes", "input" ], "properties": { "input": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "Unique record id within this Pipe0 request." } }, "additionalProperties": {} }, "maxItems": 1, "minItems": 1 }, "pipes": { "type": "array", "items": { "type": "object", "required": [ "pipe_id" ], "properties": { "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "run_if": {}, "pipe_id": { "type": "string", "minLength": 1, "description": "Pipe0 pipe id, for example company:identity@3." }, "connector": {} }, "additionalProperties": {} }, "maxItems": 1, "minItems": 1 }, "config": { "type": "object", "properties": { "widgets": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "environment": { "enum": [ "production", "sandbox" ], "type": "string", "description": "Pipe0 environment. Production consumes Pipe0 credits; sandbox uses mock/test behavior." }, "field_definitions": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": {} }, "scopes": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "field_annotations": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pipe0/search/run/sync": { "post": { "summary": "Composable Pipe0-native search workflow pass-through for allowlisted singular search IDs only. Runs POST /v1/search/run/sync for safe allowlisted company-profile search and settles at the allowlisted per-page Pipe0 catalog cost.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "billing" ], "properties": { "data": { "description": "Raw JSON response returned by Pipe0." }, "billing": { "type": "object", "required": [ "pipe0Credits", "maxPipe0Credits", "planUsdcMicro", "planCredits", "pricingVersion", "settledUsdcMicro" ], "properties": { "planCredits": { "type": "string" }, "pipe0Credits": { "type": "number" }, "planUsdcMicro": { "type": "string" }, "pricingVersion": { "type": "number" }, "maxPipe0Credits": { "type": "number" }, "settledUsdcMicro": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Run search enrichment workflows.", "operationId": "pipe0_post__api_v1_search_run_sync", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "search": { "config": { "limit": 10, "filters": { "linkedin_industries": { "exclude": [], "include": [ "Software Development" ] } } }, "search_id": "companies:profiles:crustdata@2" } }, "required": [ "search" ], "properties": { "config": { "type": "object", "properties": { "widgets": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "environment": { "enum": [ "production", "sandbox" ], "type": "string", "description": "Pipe0 environment. Production consumes Pipe0 credits; sandbox uses mock/test behavior." }, "field_definitions": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": {} }, "search": { "type": "object", "required": [ "search_id" ], "properties": { "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "connector": {}, "search_id": { "type": "string", "minLength": 1, "description": "Pipe0 search id, for example companies:profiles:crustdata@2." } }, "additionalProperties": {} } }, "additionalProperties": {} } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "pipe0-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service pipe0-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "pipe0-credits", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "cents", "unit": "cents", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pixelart/canvas": { "post": { "summary": "Create a new pixel art canvas. Returns editing, manifest, full-spec, guide, and interactive-view URLs. Optionally pre-load base64 RGBA pixels. Full agent guide: https://pixelart.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "width", "height", "viewUrl", "apiUrl", "ansiUrl", "manifestUrl", "fullSpecUrl", "guideUrl" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Canvas UUID — use in all subsequent API calls." }, "width": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "apiUrl": { "type": "string", "description": "Base API URL for this canvas." }, "height": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "ansiUrl": { "type": "string", "description": "URL that returns ANSI half-block art of the canvas. Pipe via `curl ` to render in any terminal or agent context." }, "viewUrl": { "type": "string", "description": "URL to the interactive pixel editor pre-loaded with this canvas." }, "guideUrl": { "type": "string", "description": "Holistic agent workflow guide." }, "fullSpecUrl": { "type": "string", "description": "Complete OpenAPI surface including free editing routes." }, "manifestUrl": { "type": "string", "description": "Engine-ready animation manifest for this mutable canvas." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Create agent-owned pixel canvases.", "operationId": "pixelart_post__api_v1_canvas", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "loop" ], "properties": { "fps": { "type": "integer", "maximum": 60, "minimum": 1, "description": "Playback rate for animation consumers." }, "game": { "type": "object", "properties": { "clips": { "type": "array", "items": { "type": "object", "required": [ "name", "fromFrame", "toFrame" ], "properties": { "fps": { "type": "integer", "maximum": 60, "minimum": 1 }, "loop": { "type": "boolean" }, "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "toFrame": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 }, "fromFrame": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 } }, "additionalProperties": false }, "maxItems": 64, "description": "Named animation ranges within this canvas." }, "facing": { "enum": [ "left", "right", "none" ], "type": "string", "description": "Native facing direction of the authored art." }, "frames": { "type": "object", "description": "Metadata keyed by canonical zero-based frame index.", "propertyNames": { "type": "string", "pattern": "^(0|[1-9]\\d*)$" }, "additionalProperties": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "required": [ "kind", "x", "y", "width", "height" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "kind": { "enum": [ "hit", "hurt", "collision", "interaction" ], "type": "string" }, "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "width": { "type": "number", "exclusiveMinimum": 0 }, "height": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "maxItems": 64, "description": "Gameplay geometry associated with this frame." }, "pivot": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "description": "Per-frame pivot override. Omit to use defaultPivot.", "additionalProperties": false }, "events": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "payload": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } }, "additionalProperties": false }, "maxItems": 64, "description": "Events emitted when playback enters this frame." }, "sockets": { "type": "object", "description": "Named attachment points such as feet, muzzle, hand, or weapon.", "propertyNames": { "type": "string", "maxLength": 64, "minLength": 1 }, "additionalProperties": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "additionalProperties": false } }, "durationMs": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Per-frame duration override. Omit to use the clip or canvas FPS." } }, "additionalProperties": false } }, "rootMotion": { "anyOf": [ { "type": "string", "const": "none" }, { "type": "object", "properties": { "socket": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Socket whose movement represents root motion." } }, "additionalProperties": false } ], "description": "Whether movement is in-place or derived from a named socket." }, "defaultPivot": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "description": "Default render pivot shared by frames without an override.", "additionalProperties": false } }, "description": "Optional engine metadata: pivots, facing, root motion, clips, sockets, boxes, and events.", "additionalProperties": false }, "loop": { "type": "boolean", "default": true, "description": "Whether playback loops (false = play once)." }, "name": { "type": "string", "maxLength": 100, "description": "Human-readable label for this canvas." }, "width": { "type": "integer", "default": 64, "maximum": 256, "minimum": 8, "description": "Canvas width in pixels (8–256). Default: 64." }, "height": { "type": "integer", "default": 64, "maximum": 256, "minimum": 8, "description": "Canvas height in pixels (8–256). Default: 64." }, "initData": { "type": "string", "maxLength": 349528, "minLength": 1, "description": "Base64-encoded RGBA pixel data to initialise the canvas. Must be exactly width × height × 4 bytes after decoding. Omit to start with a transparent (empty) canvas." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "canvas-create" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per requests (requests, service canvas-create, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "canvas-create", "meter": "requests", "unit": "requests", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "requests", "unit": "requests", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/pixelart/canvas/import": { "post": { "summary": "Convert a public PNG/JPEG/WebP/GIF or base64 image into an editable, palette-quantized pixel canvas. Full agent guide: https://pixelart.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "width", "height", "viewUrl", "apiUrl", "ansiUrl", "manifestUrl", "fullSpecUrl", "guideUrl", "colorCount" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "width": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "apiUrl": { "type": "string" }, "height": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "ansiUrl": { "type": "string", "description": "URL that returns ANSI half-block art — pipe via `curl ` to render in any terminal or agent context." }, "viewUrl": { "type": "string" }, "guideUrl": { "type": "string", "description": "Holistic agent workflow guide." }, "colorCount": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Distinct RGBA colors in the imported result." }, "fullSpecUrl": { "type": "string", "description": "Complete OpenAPI surface including free editing routes." }, "manifestUrl": { "type": "string", "description": "Engine-ready animation manifest for this mutable canvas." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "description": "Import agent-owned pixel canvases.", "operationId": "pixelart_post__api_v1_canvas_import", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "width": 64, "height": 64, "imageUrl": "https://httpbin.org/image/png" }, "required": [ "width", "height", "scaleMode", "fit", "loop" ], "properties": { "fit": { "enum": [ "fill", "contain", "cover", "crop" ], "type": "string", "default": "contain", "description": "fill = stretch; contain = letterbox; cover/crop = crop to fill. Default contain." }, "fps": { "type": "integer", "maximum": 60, "minimum": 1, "description": "Default playback rate for frames added after import." }, "game": { "type": "object", "properties": { "clips": { "type": "array", "items": { "type": "object", "required": [ "name", "fromFrame", "toFrame" ], "properties": { "fps": { "type": "integer", "maximum": 60, "minimum": 1 }, "loop": { "type": "boolean" }, "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "toFrame": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 }, "fromFrame": { "type": "integer", "maximum": 9007199254740991, "minimum": 0 } }, "additionalProperties": false }, "maxItems": 64, "description": "Named animation ranges within this canvas." }, "facing": { "enum": [ "left", "right", "none" ], "type": "string", "description": "Native facing direction of the authored art." }, "frames": { "type": "object", "description": "Metadata keyed by canonical zero-based frame index.", "propertyNames": { "type": "string", "pattern": "^(0|[1-9]\\d*)$" }, "additionalProperties": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "required": [ "kind", "x", "y", "width", "height" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "kind": { "enum": [ "hit", "hurt", "collision", "interaction" ], "type": "string" }, "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "width": { "type": "number", "exclusiveMinimum": 0 }, "height": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "maxItems": 64, "description": "Gameplay geometry associated with this frame." }, "pivot": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "description": "Per-frame pivot override. Omit to use defaultPivot.", "additionalProperties": false }, "events": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1 }, "payload": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } }, "additionalProperties": false }, "maxItems": 64, "description": "Events emitted when playback enters this frame." }, "sockets": { "type": "object", "description": "Named attachment points such as feet, muzzle, hand, or weapon.", "propertyNames": { "type": "string", "maxLength": 64, "minLength": 1 }, "additionalProperties": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "additionalProperties": false } }, "durationMs": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Per-frame duration override. Omit to use the clip or canvas FPS." } }, "additionalProperties": false } }, "rootMotion": { "anyOf": [ { "type": "string", "const": "none" }, { "type": "object", "properties": { "socket": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Socket whose movement represents root motion." } }, "additionalProperties": false } ], "description": "Whether movement is in-place or derived from a named socket." }, "defaultPivot": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number", "description": "Horizontal pixel coordinate from the left edge of the frame." }, "y": { "type": "number", "description": "Vertical pixel coordinate from the top edge of the frame." } }, "description": "Default render pivot shared by frames without an override.", "additionalProperties": false } }, "description": "Optional engine metadata for the imported art.", "additionalProperties": false }, "loop": { "type": "boolean", "default": true, "description": "Whether animation playback loops by default." }, "name": { "type": "string", "maxLength": 100, "description": "Canvas name. Shown in the viewer tab." }, "width": { "type": "integer", "default": 64, "maximum": 256, "minimum": 4, "description": "Target canvas width in pixels. Default 64." }, "colors": { "type": "integer", "maximum": 256, "minimum": 2, "description": "Quantize result to N distinct colors using median-cut. Omit to keep full color fidelity." }, "height": { "type": "integer", "default": 64, "maximum": 256, "minimum": 4, "description": "Target canvas height in pixels. Default 64." }, "canvasId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "If provided, overwrite an existing canvas instead of creating a new one." }, "imageUrl": { "type": "string", "format": "uri", "description": "Publicly accessible image URL to fetch server-side. Max 5 MB." }, "imageData": { "type": "string", "description": "Base64-encoded image bytes (PNG / JPEG / WebP / GIF). Max 2 MB encoded (≈1.5 MB actual)." }, "scaleMode": { "enum": [ "nearest", "smooth" ], "type": "string", "default": "nearest", "description": "nearest = pixel-art-preserving (best for existing pixel art). smooth = Lanczos3 downscale (best for photos → pixel art)." }, "background": { "type": "array", "description": "[r, g, b, a] fill color for letterbox padding. Default transparent.", "prefixItems": [ { "type": "integer", "maximum": 255, "minimum": 0 }, { "type": "integer", "maximum": 255, "minimum": 0 }, { "type": "integer", "maximum": 255, "minimum": 0 }, { "type": "integer", "maximum": 255, "minimum": 0 } ] } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "canvas-import" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per requests (requests, service canvas-import, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "canvas-import", "meter": "requests", "unit": "requests", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "requests", "unit": "requests", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/scheduler/owner/usage": { "get": { "summary": "Cross-task usage rollup for the caller. current_balance_micros is refundable escrow on the direct rail and a non-refundable seller-local execution cap on the ZeroClick rail. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "billing_rail", "total_spend_micros", "total_runs", "current_balance_micros", "top_tasks", "next_cursor" ], "properties": { "top_tasks": { "type": "array", "items": { "type": "object", "required": [ "task_id", "lifetime_cost_micros", "lifetime_runs" ], "properties": { "task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lifetime_runs": { "type": "number" }, "lifetime_cost_micros": { "type": "string" } }, "additionalProperties": false } }, "total_runs": { "type": "number" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "total_spend_micros": { "type": "string" }, "current_balance_micros": { "type": "string", "description": "Direct rail: aggregate remaining escrow. ZeroClick rail: aggregate remaining seller-local execution cap, not refundable money." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "operationId": "scheduler_get__api_v1_owner_usage", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/runs/{id}": { "get": { "summary": "Deep-dive single run with truncated stdout/stderr + logs_url. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "task_id", "status", "trigger", "started_at", "finished_at", "claimed_at", "heartbeat_at", "exit_code", "stdout", "stderr", "cost_daytona_micros", "cost_overhead_micros", "cost_siblings_micros", "cost_total_micros", "sibling_call_count", "daytona_sandbox_id", "logs_url", "artifacts" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "stderr": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stdout": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "trigger": { "type": "string" }, "logs_url": { "type": "string" }, "artifacts": { "type": "array", "items": { "type": "object", "required": [ "name", "url", "path", "bytes", "content_type", "created_at" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "bytes": { "type": "number" }, "created_at": { "type": "string" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "description": "Durable artifacts stored by the run via the cdn capability. Fetchable by URL." }, "exit_code": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "claimed_at": { "type": "string" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "heartbeat_at": { "type": "string" }, "cost_total_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "daytona_sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sibling_call_count": { "type": "number" }, "cost_daytona_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cost_overhead_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cost_siblings_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_get__api_v1_runs__id_", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks": { "post": { "summary": "Create a recurring or on-demand task. Direct endpoint: max_amount_usdc_micros is refundable escrow and X-Pay-Amount-Micros must match it. ZeroClick endpoint: it is a seller-local lifetime execution cap; marketplace access/usage is authoritative and no seller escrow is created. Optional: schedule, max_sibling_calls, llm, tool_list, dependencies, env, notify_email, end_at. See GET /api/v1 and /llms.txt for rail-specific setup.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "status", "next_run_at", "billing_rail", "channel_id", "channel_open_tx", "max_amount_micros", "balance_available_micros", "estimated_ceiling_micros", "cron", "timezone" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "timezone": { "type": "string" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "channel_open_tx": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_amount_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balance_available_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "estimated_ceiling_micros": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CRON", "UNSUPPORTED_RUNTIME", "UNSUPPORTED_DEPENDENCY", "UNKNOWN_SIBLING" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "IDEMPOTENCY_CONFLICT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "header", "name": "X-Pay-Amount-Micros", "schema": { "type": "string", "pattern": "^[1-9]\\d*$" }, "required": true, "description": "The actual amount charged for THIS call, in USDC micros (1 USDC = 1_000_000 micros), as a positive-integer decimal string with no decimal point, sign, or fractional part (e.g. \"1500000\" for $1.50). It MUST exactly equal the amount field mirrored in the request body — `max_amount_usdc_micros` on create (the upfront escrow deposit) and `top_up_amount_micros` on fund. The payment middleware reads this header to size the x402/MPP 402 challenge (it runs BEFORE the handler), and the handler independently reads the body field; the two are cross-checked. A missing, non-positive-integer, or mismatched value fails the cross-check and returns `400 PRICE_RESOLVER_FAILED`. This header is the charge that the resulting 402 payment challenge settles on-chain." }, { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "minLength": 1 }, "required": true, "description": "A unique, client-generated key identifying ONE logical create. A retry that resends the SAME key with an identical body returns the EXISTING task — no duplicate task is created and the buyer is NOT charged a second time. Resending the SAME key with a DIFFERENT body is rejected with `409 IDEMPOTENCY_CONFLICT`. Required so this real-money create can be retried safely (e.g. after a network timeout) without risking a double charge." } ], "description": "Run repeatable cron and on-demand tasks.", "operationId": "scheduler_post__api_v1_tasks", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "runtime", "source", "entrypoint", "max_runtime_sec", "max_sibling_calls" ], "properties": { "env": { "type": "object", "description": "BYO env vars injected into the sandbox. Never returned in any GET response.", "propertyNames": { "type": "string", "pattern": "^[A-Z_][A-Z0-9_]*$" }, "additionalProperties": { "type": "string", "maxLength": 4096 } }, "llm": { "type": "object", "required": [ "profile" ], "properties": { "model": { "type": "string", "pattern": "^[a-z][a-z0-9-]*(\\/[A-Za-z0-9._:-]+)?$", "description": "Optional preferred model selector used when sandbox code omits a model." }, "models": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*(\\/[A-Za-z0-9._:-]+)?$" }, "maxItems": 16, "minItems": 1, "description": "Optional allowlist of internal LLM aliases or provider/model ids this task may use. Defaults from the profile." }, "profile": { "enum": [ "quick", "standard", "bulk", "research", "long" ], "type": "string", "default": "standard", "description": "LLM workload envelope. Use 'quick', 'standard', 'bulk', 'research', or 'long'." }, "max_calls_per_run": { "type": "integer", "maximum": 100, "description": "Optional lower hard cap on LLM broker calls per run.", "exclusiveMinimum": 0 }, "max_input_bytes_per_call": { "type": "integer", "maximum": 1048576, "description": "Optional lower hard cap on UTF-8 prompt+system bytes per LLM call.", "exclusiveMinimum": 0 }, "max_output_tokens_per_call": { "type": "integer", "maximum": 128000, "description": "Optional lower hard cap on generated tokens requested from the broker.", "exclusiveMinimum": 0 }, "max_cost_usdc_micros_per_run": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Optional lower per-run LLM spend ceiling in USDC micros (string or number). Added to the task claim ceiling." } }, "description": "Enables the built-in LLM for your source (call generate_text(...) — pre-imported, auto-authenticated). Omit to disable LLM calls. Pick a profile (quick|standard|bulk|research|long); GET /api/v1/rates → llm_profiles lists each profile's models, default_model, and caps. FUNDING: the chosen profile's max_cost_usdc_micros_per_run is reserved into estimated_ceiling_micros every run (quick $0.05, standard $0.15, bulk $0.15, research $1.00, long $2.00), so raise max_amount_usdc_micros to match — or lower the reserve with max_cost_usdc_micros_per_run.", "additionalProperties": false }, "end_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "Optional ISO-8601 auto-stop time. The dispatch loop flips status to `completed` once now() >= end_at." }, "source": { "type": "string", "minLength": 1, "description": "Verbatim code for the run, written to /workspace/. It can reach the public internet, and four helpers are available as GLOBALS — no import, no keys, no setup: generate_text(...) for the built-in LLM (needs an `llm` profile on the task), call(sibling, path, body?, method?, max_price_micros?) to invoke another Zero capability through the per-run proxy, store_artifact(name, data, content_type?) for durable cdn hosting (needs `artifacts.enabled`), and request_continuation(delay_sec?) to schedule an immediate follow-up run when the work is larger than one run cap (chunk → persist progress externally → request_continuation() → exit 0; granted only on a clean exit, capped back-to-back). Call them directly — e.g. python `r = generate_text('hi')`, node `const r = await call('cdn','/x')`. (The explicit `from withzero_sdk import generate_text, call, store_artifact` / `import { generateText, call, storeArtifact } from './withzero-sdk.js'` also works but is optional.) `generate_text` accepts optional OpenRouter reasoning config. CALL() CONTRACT: every helper returns `{ status, body }` where `status` is the upstream HTTP status (int) and `body` is the parsed JSON response (or null). In node these are ASYNC — `await call(...)` / `await generate_text(...)`; in python they are SYNCHRONOUS — `r = call(...)` (no await). call() TARGETS, two kinds: (a) a FIRST-PARTY sibling by NAME (urlshortener/cdn/forms/screenshot/inbox) — billed a flat per-call fee, no max_price_micros needed. (b) ANY PAID marketplace capability by its capabilityId. PAID MARKETPLACE FLOW (discover-then-cap): the sandbox has public internet egress, so to call a paid third-party capability you FIRST discover its `capabilityId`, price, accepted payment protocol (x402 or MPP), and request path/body by querying Zero yourself at https://api.zero.xyz (capability search/get; the capability's OWN OpenAPI describes its request path + body). THEN call it as `call(capabilityId, path, body?, method?, max_price_micros)` — pass the capabilityId as the FIRST arg and max_price_micros (the most USDC micros you accept for this one call). The scheduler resolves the capabilityId server-side, pays via x402 (from a Base float) or MPP (from Tempo escrow) out of the escrow wallet, enforces your cap before signing, and refunds the difference — you never handle keys or sign anything. EXAMPLE (paid, python): `r = call(\"cap_abc123\", \"/v1/enrich\", {\"domain\": \"acme.com\"}, max_price_micros=50000)` — pays at most 0.05 USDC for one call to capability cap_abc123. ERROR CODES a call() may surface in the proxy response: PRICE_CAP_EXCEEDED (the paid challenge exceeded your max_price_micros — payment aborted before signing, nothing spent), PRICE_UNKNOWN (missing/invalid max_price_micros or capabilityId for a paid target), CAPABILITY_PROTOCOL_UNSUPPORTED (the capability offers neither x402 nor MPP), SIBLING_NOT_ALLOWED (target not in the task `tool_list`), CALL_CAP_EXCEEDED (per-run max_sibling_calls hit), SIBLING_PAYMENT_FAILED (resolution/settlement failed; reservation released). ALLOWLIST: a target (sibling name or capabilityId) is callable only when it is in the task `tool_list`, OR when `tool_list` is left open with `max_sibling_calls` > 0 (then `max_sibling_spend_micros` is REQUIRED and bounds total per-run paid spend). The full catalog + worked examples are at GET /api/v1 (the `sandbox` section)." }, "runtime": { "enum": [ "python", "node" ], "type": "string", "description": "Sandbox runtime; 'python' or 'node'." }, "schedule": { "anyOf": [ { "type": "object", "required": [ "cron", "timezone" ], "properties": { "cron": { "type": "string", "minLength": 1, "description": "Raw 5-field cron expression (e.g. '0 7 * * *')." }, "timezone": { "type": "string", "default": "UTC", "description": "IANA timezone (default UTC)." } }, "additionalProperties": false }, { "type": "object", "required": [ "every", "timezone" ], "properties": { "at": { "type": "string", "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$", "description": "HH:MM 24h time; required for 'daily' and 'weekly'." }, "every": { "enum": [ "minute", "hourly", "daily", "weekly" ], "type": "string" }, "timezone": { "type": "string", "default": "UTC", "description": "IANA timezone (default UTC)." }, "dayOfWeek": { "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ], "type": "string", "description": "Three-letter day of week; required for 'weekly'." } }, "additionalProperties": false } ], "description": "Either a raw cron expression or a convenience shape; the convenience shape compiles to a 5-field cron string server-side." }, "artifacts": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "default": false, "description": "Opt in to durable artifact storage. Off by default." }, "max_uploads_per_run": { "type": "integer", "maximum": 20, "description": "Optional lower hard cap on artifact uploads per run; max 20. Default 5.", "exclusiveMinimum": 0 }, "max_bytes_per_upload": { "type": "integer", "maximum": 10485760, "description": "Optional lower hard cap on decoded bytes per artifact; max 10485760. Default 1048576.", "exclusiveMinimum": 0 } }, "description": "Optional durable artifact storage for sandbox code via the cdn capability. Omit to disable. Free in v1; bounded by per-run caps.", "additionalProperties": false }, "tool_list": { "type": "array", "items": { "type": "string", "maxLength": 256, "minLength": 1 }, "maxItems": 64, "description": "Allowlist of capability identifiers the run may proxy through — first-party sibling names (urlshortener/cdn/forms/screenshot/inbox) AND/OR marketplace capabilityIds. THREE states: OMIT the field → OPEN proxy when `max_sibling_calls` > 0 (reach ANY capability; `max_sibling_spend_micros` is then REQUIRED to bound spend) — with `max_sibling_calls` 0/omitted it is stored as DENY-ALL instead; send `[]` → DENY-ALL (every capability is blocked; the safe restriction default); send `[items]` → SCOPED to exactly those identifiers. An explicit `[]` is NOT open — only an omitted tool_list with `max_sibling_calls` > 0 is. Marketplace capabilityIds (and their pricing/protocol) are discovered via Zero's capability search at https://api.zero.xyz; first-party sibling names + their per-call openapi are listed at GET /api/v1/_siblings." }, "entrypoint": { "type": "string", "minLength": 1, "description": "File name for `source` (e.g. 'main.py' or 'index.js')." }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string", "description": "Which payment rail this create is billed against. Optional for direct/zeroclick callers. REQUIRED to be \"account\" when authenticating with an API key (zsk_… bearer) — it is the explicit opt-in that lets max_amount_usdc_micros be omitted." }, "dependencies": { "type": "object", "properties": { "node": { "type": "array", "items": { "type": "string", "pattern": "^(@[a-z0-9-]+\\/)?[a-z0-9-]+(@[\\w.-]+)?$" }, "maxItems": 20 }, "python": { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z0-9._-]+(==[\\w.-]+)?$" }, "maxItems": 20 } }, "description": "Optional extra packages installed in the sandbox prelude; max 20 per runtime. **Always pin versions** — sandboxes install fresh on every run, so an unpinned package silently upgrades when a new major ships. Node: \"name@version\" or \"@scope/name@version\" (e.g. [\"mppx@0.7.0\", \"viem@2.21.0\"]). Python: \"name==version\" (e.g. [\"requests==2.31.0\"]).", "additionalProperties": false }, "notify_email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "Optional address for best-effort run-completion emails. When set, each scheduled (cron) or async `/trigger` run sends one email on finalize with its status, duration, cost, and the tail of stdout. Synchronous runs (`/runs`, `/webhook`) do not email — the result is returned inline. Delivery never blocks or fails a run." }, "max_runtime_sec": { "type": "integer", "maximum": 900, "description": "Hard cap on per-run wall-clock seconds; max 900.", "exclusiveMinimum": 0 }, "max_sibling_calls": { "type": "integer", "default": 0, "maximum": 1000, "minimum": 0, "description": "Hard cap on sibling proxy calls per run; max 1000. Defaults to 0 — no sibling calls; set it > 0 to let `source` use call(...)." }, "max_amount_usdc_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Channel deposit ceiling in USDC micros (positive integer as string, or number up to 2^53-1). Bounds total lifetime spend. Size it >= estimated_ceiling_micros * (runs you want before a top-up); if it is below one ceiling the task pauses before its first run. LLM-enabled tasks reserve the profile cost cap per run — see the `llm` field. REQUIRED unless billing_rail is \"account\" — account-rail tasks draw from the account credit balance instead; omit for an uncapped task, or set it as an additional per-task lifetime execution cap." }, "max_sibling_spend_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Optional per-run sibling-spend ceiling in USDC micros (positive integer as string, or number up to 2^53-1). REQUIRED when `tool_list` is omitted AND `max_sibling_calls` > 0 (open proxy) so spend stays bounded; optional otherwise. Replaces the legacy max_sibling_calls × per-call-fee reservation in the run ceiling." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 10,000 cost_micross (cost_micros, service scheduler-runtime, first 100000 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "scheduler-runtime", "meter": "cost_micros", "unit": "cost_micros", "unitSize": 10000, "priceUsd": "0.010000", "includedUnits": 100000 } ], "included": [ { "meterSlug": "cost_micros", "unit": "cost_micros", "freeUnits": 100000, "per": "account" } ] } } }, "/api/v1/scheduler/tasks/clone": { "post": { "summary": "Clone an existing task spec into a fresh template (env values masked). 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "runtime", "source", "entrypoint", "dependencies", "llm", "artifacts", "max_runtime_sec", "max_sibling_calls", "notify_email", "end_at" ], "properties": { "env": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "llm": { "anyOf": [ {}, { "type": "null" } ] }, "end_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "runtime": { "type": "string" }, "schedule": { "type": "object", "required": [ "cron", "timezone" ], "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "additionalProperties": false }, "artifacts": { "anyOf": [ {}, { "type": "null" } ] }, "tool_list": { "type": "array", "items": { "type": "string" } }, "entrypoint": { "type": "string" }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "dependencies": { "anyOf": [ {}, { "type": "null" } ] }, "notify_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_runtime_sec": { "type": "number" }, "max_sibling_calls": { "type": "number" }, "max_amount_usdc_micros": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "operationId": "scheduler_post__api_v1_tasks_clone", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "from_task_id" ], "properties": { "from_task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Source task to clone the spec from. May be deleted or completed." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}": { "delete": { "summary": "Stop a task. Direct rail closes the payment channel and refunds remaining escrow. ZeroClick rail releases pending reservations and reports no refund because buyer billing is held by the marketplace. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "status", "billing_rail", "channel_close_tx", "seller_claimed_micros", "buyer_refunded_micros" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "channel_close_tx": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "buyer_refunded_micros": { "type": "string" }, "seller_claimed_micros": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "204": { "description": "Task deleted" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "503": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VOUCHER_BEHIND_CUMULATIVE" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Service unavailable" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_delete__api_v1_tasks__id_", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing OpenAPI contract details in provided text" ], "pages": [], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } }, "get": { "summary": "Fetch a task. Owner-gated by proof. `env` is never returned. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "owner", "status", "billing_rail", "cron", "timezone", "runtime", "entrypoint", "source", "dependencies", "tool_list", "llm", "notify_email", "max_runtime_sec", "max_sibling_calls", "channel_id", "channel_open_tx", "channel_close_tx", "max_amount_micros", "cumulative_cost_micros", "latest_voucher_micros", "balance_available_micros", "estimated_ceiling_micros", "lifetime_cost_micros", "lifetime_runs", "avg_cost_per_run_micros", "next_run_at", "last_run_at", "end_at", "last_paused_reason", "last_paused_at", "recovery_hint", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "llm": { "anyOf": [ {}, { "type": "null" } ] }, "cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner": { "type": "string" }, "end_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "status": { "type": "string" }, "runtime": { "type": "string" }, "timezone": { "type": "string" }, "tool_list": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Direct rail payment channel/challenge id. Null on the ZeroClick rail." }, "created_at": { "type": "string" }, "entrypoint": { "type": "string" }, "updated_at": { "type": "string" }, "last_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "dependencies": { "anyOf": [ {}, { "type": "null" } ] }, "notify_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lifetime_runs": { "type": "number" }, "recovery_hint": { "anyOf": [ { "type": "object", "required": [ "reason", "needs_top_up_micros", "recommended_top_up_micros", "fund_route", "delete_route" ], "properties": { "reason": { "type": "string" }, "fund_route": { "type": "string", "description": "Endpoint to call to increase direct escrow or the ZeroClick seller-local execution cap." }, "delete_route": { "type": "string", "description": "Stop the task. Direct rail refunds remaining escrow; ZeroClick rail has no seller-held balance to refund." }, "needs_top_up_micros": { "type": "string", "description": "Minimum top_up_amount_micros that would let the task resume." }, "recommended_top_up_micros": { "type": "string", "description": "Suggested top-up that covers ~10 more worst-case runs." } }, "additionalProperties": false }, { "type": "null" } ], "description": "Populated when status is paused_insufficient_funds. Tells the agent exactly how to recover." }, "last_paused_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel_open_tx": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Direct rail payment reference. Null on the ZeroClick rail." }, "max_runtime_sec": { "type": "number" }, "channel_close_tx": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_amount_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Direct rail: refundable escrow ceiling. ZeroClick rail: seller-local lifetime execution cap; no buyer money is deposited here. Account rail: null when uncapped (the account credit balance is the real ceiling — see GET /api/v1/owner/usage), else the additional per-task cap." }, "max_sibling_calls": { "type": "number" }, "last_paused_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lifetime_cost_micros": { "type": "string" }, "latest_voucher_micros": { "type": "string" }, "cumulative_cost_micros": { "type": "string", "description": "Actual finalized run usage plus active reservations, in micros. ZeroClick settlement is reported to the marketplace." }, "avg_cost_per_run_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balance_available_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Direct rail: remaining escrow. ZeroClick rail: remaining seller-local execution cap, not a refundable monetary balance. Account rail: null in lockstep with max_amount_micros when uncapped." }, "estimated_ceiling_micros": { "type": "string", "description": "Worst-case cost of one run given max_runtime_sec + max_sibling_calls. Compare against balance_available_micros to predict remaining runs." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_get__api_v1_tasks__id_", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } }, "patch": { "summary": "Update notify_email, end_at, or tool_list (additions only). 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "tool_list", "max_sibling_spend_micros", "max_runtime_sec", "estimated_ceiling_micros", "notify_email", "end_at" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "end_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tool_list": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "notify_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_runtime_sec": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "estimated_ceiling_micros": { "type": "string" }, "max_sibling_spend_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_patch__api_v1_tasks__id_", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "end_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "tool_list": { "type": "array", "items": { "type": "string" } }, "notify_email": { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "max_runtime_sec": { "type": "integer", "maximum": 900, "description": "Raise the per-run wall-clock cap in seconds (max 900). Raises only — lowering forces clone+recreate. 409 RUN_IN_FLIGHT while a run is claimed/running; retry after it finishes. Raising it raises the per-run ceiling reservation — top up if the balance drops below one ceiling.", "exclusiveMinimum": 0 }, "max_sibling_spend_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Raise the per-run sibling-spend ceiling (USDC micros; string, or number up to 2^53-1). Raises only — lowering forces clone+recreate." } }, "description": "Only `notify_email`, `end_at`, `tool_list` (additions only), `max_sibling_spend_micros` (raises only), and `max_runtime_sec` (raises only, no run in flight) may be patched. All other fields are immutable.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing request body and response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/enqueue": { "post": { "summary": "DEPRECATED — use POST /tasks/:id/trigger. Behaves identically (async, non-blocking). 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "task_id", "status", "next_run_at", "enqueued" ], "properties": { "status": { "type": "string" }, "task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enqueued": { "type": "boolean", "description": "true if next_run_at was pulled forward; false if the task was not active (no-op)." }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "description": "Run on-demand tasks.", "operationId": "scheduler_post__api_v1_tasks__id__enqueue", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body. Triggers a run asynchronously — pulls the task's next run forward to now so the dispatch tick executes it within ~1 minute; returns immediately WITHOUT waiting for the result. Contrast POST /tasks/:id/runs (synchronous). A non-active task is a safe no-op.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/env": { "put": { "summary": "Replace the BYO env blob. KMS-re-encrypted at rest; never echoed. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "env_key_version", "env_keys" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "env_keys": { "type": "array", "items": { "type": "string" } }, "env_key_version": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_put__api_v1_tasks__id__env", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "env" ], "properties": { "env": { "type": "object", "description": "Full replacement env map; submit `{}` to clear.", "propertyNames": { "type": "string", "pattern": "^[A-Z_][A-Z0-9_]*$" }, "additionalProperties": { "type": "string", "maxLength": 4096 } } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/fund": { "post": { "summary": "Increase max_amount_micros. Direct endpoint: X-Pay-Amount-Micros must match top_up_amount_micros and the settled payment extends refundable escrow; no Idempotency-Key header required because replay protection is payment-bound. ZeroClick endpoint: the amount only raises the seller-local lifetime execution cap; marketplace usage remains authoritative and no seller escrow moves. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "status", "max_amount_micros", "cumulative_cost_micros", "balance_available_micros", "estimated_ceiling_micros", "topped_up_micros", "billing_rail", "fund_tx_hash" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "description": "New status — flips from 'paused_insufficient_funds' to 'active' if the top-up covers the ceiling." }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "fund_tx_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Direct rail: on-chain channel id. ZeroClick rail: null because no seller escrow moved." }, "topped_up_micros": { "type": "string" }, "max_amount_micros": { "type": "string", "description": "New cap after the top-up." }, "cumulative_cost_micros": { "type": "string" }, "balance_available_micros": { "type": "string" }, "estimated_ceiling_micros": { "type": "string" } }, "description": "Top-up confirmation. The new balance covers (max_amount - cumulative_cost); compare against estimated_ceiling_micros to see how many runs the topped-up balance can still cover.", "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "IDEMPOTENCY_CONFLICT", "CHANNEL_MISMATCH" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "header", "name": "X-Pay-Amount-Micros", "schema": { "type": "string", "pattern": "^[1-9]\\d*$" }, "required": true, "description": "The actual amount charged for THIS call, in USDC micros (1 USDC = 1_000_000 micros), as a positive-integer decimal string with no decimal point, sign, or fractional part (e.g. \"1500000\" for $1.50). It MUST exactly equal the amount field mirrored in the request body — `max_amount_usdc_micros` on create (the upfront escrow deposit) and `top_up_amount_micros` on fund. The payment middleware reads this header to size the x402/MPP 402 challenge (it runs BEFORE the handler), and the handler independently reads the body field; the two are cross-checked. A missing, non-positive-integer, or mismatched value fails the cross-check and returns `400 PRICE_RESOLVER_FAILED`. This header is the charge that the resulting 402 payment challenge settles on-chain." } ], "operationId": "scheduler_post__api_v1_tasks__id__fund", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "top_up_amount_micros" ], "properties": { "top_up_amount_micros": { "type": "string", "pattern": "^[1-9]\\d*$", "description": "Additional USDC to add to the task, in micros (1 USDC = 1_000_000 micros; string or number up to 2^53-1). Bumped onto max_amount_micros." } }, "description": "Top up a task to extend its runway. Use when a task is `paused_insufficient_funds` or you want a margin before it pauses.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per 10,000 cost_micross (cost_micros, service scheduler-runtime, first 100000 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "scheduler-runtime", "meter": "cost_micros", "unit": "cost_micros", "unitSize": 10000, "priceUsd": "0.010000", "includedUnits": 100000 } ], "included": [ { "meterSlug": "cost_micros", "unit": "cost_micros", "freeUnits": 100000, "per": "account" } ] } } }, "/api/v1/scheduler/tasks/{id}/ledger": { "get": { "summary": "Cursor-paginated task audit. Direct rail: authoritative append-only money ledger. ZeroClick rail: operational rows only; ZeroClick marketplace usage is authoritative for buyer billing. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "billing_rail", "authoritative_billing", "entries", "next_cursor" ], "properties": { "entries": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "amount_micros", "balance_available_after", "balance_reserved_after", "on_chain_tx", "run_id", "metadata", "created_at" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "metadata": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "created_at": { "type": "string" }, "on_chain_tx": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_micros": { "type": "string", "description": "Signed; positive = inbound, negative = outbound." }, "balance_reserved_after": { "type": "string" }, "balance_available_after": { "type": "string" } }, "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_rail": { "enum": [ "direct", "zeroclick", "account" ], "type": "string" }, "authoritative_billing": { "enum": [ "scheduler_ledger", "zeroclick_marketplace", "account_ledger" ], "type": "string", "description": "Direct buyer money is authoritative in this ledger. ZeroClick buyer billing is authoritative in the marketplace usage ledger. Account-rail buyer billing is authoritative in GET /api/v1/account/ledger — this per-task feed is always empty for account-rail tasks." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_get__api_v1_tasks__id__ledger", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/pause": { "post": { "summary": "Manually pause a task. Future runs are skipped until resumed. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "status", "last_paused_reason", "last_paused_at" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "last_paused_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_paused_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_post__api_v1_tasks__id__pause", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body; pauses the task.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/resume": { "post": { "summary": "Resume a paused task. 409 TASK_PAUSED_INSUFFICIENT_FUNDS if balance < ceiling. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "id", "status", "next_run_at", "balance_available_micros", "estimated_ceiling_micros" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balance_available_micros": { "type": "string" }, "estimated_ceiling_micros": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_post__api_v1_tasks__id__resume", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body; recomputes next_run_at and flips status to active.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/runs": { "get": { "summary": "Slim per-run rows, cursor-paginated (limit ≤50). 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "runs", "next_cursor" ], "properties": { "runs": { "type": "array", "items": { "type": "object", "required": [ "id", "status", "started_at", "finished_at", "exit_code", "cost_total_micros", "sibling_call_count", "trigger" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "trigger": { "type": "string" }, "exit_code": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cost_total_micros": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sibling_call_count": { "type": "number" } }, "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_get__api_v1_tasks__id__runs", "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing explicit OpenAPI schema definition in source" ], "pages": [ 1 ], "sourceId": "sds_-TT_K2x_S7LgQhnqELw8Y", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_piqg-WoUfbH57LxfMfj9I" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_CLvfOm82D3URSI-mH_p93", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_nvOc1frV5_AZ1V8seNXOI" }, { "gaps": [ "Missing response schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } }, "post": { "summary": "Run a task right now, synchronously: claims, runs the sandbox inline, and blocks until the run finalizes, then returns it. Billed like a normal cron run. Use it to trigger an on-demand run or to test a cron you just set up before trusting the schedule. Does NOT advance next_run_at. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "run_id", "task_id", "status", "trigger", "claimed_at" ], "properties": { "run_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "trigger": { "type": "string" }, "claimed_at": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_post__api_v1_tasks__id__runs", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body. Runs the task immediately and synchronously — blocks until the run finalizes, then returns it.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/trigger": { "post": { "summary": "Trigger a run asynchronously (non-blocking): pulls next_run_at to now; the dispatch tick runs it within ~1 min. Returns immediately. No-op on non-active tasks. Use POST /tasks/:id/runs for a synchronous run. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "task_id", "status", "next_run_at", "enqueued" ], "properties": { "status": { "type": "string" }, "task_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enqueued": { "type": "boolean", "description": "true if next_run_at was pulled forward; false if the task was not active (no-op)." }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_post__api_v1_tasks__id__trigger", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body. Triggers a run asynchronously — pulls the task's next run forward to now so the dispatch tick executes it within ~1 minute; returns immediately WITHOUT waiting for the result. Contrast POST /tasks/:id/runs (synchronous). A non-active task is a safe no-op.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/scheduler/tasks/{id}/webhook": { "delete": { "summary": "Disable the task webhook (clears the secret). Idempotent. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "204": { "description": "Webhook deleted" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_delete__api_v1_tasks__id__webhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body. Disables the task webhook (clears the secret).", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing OpenAPI schema details" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing OpenAPI contract details in provided text" ], "pages": [], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } }, "put": { "summary": "Enable or rotate the task webhook secret (returned ONCE). Present it as Authorization: Bearer to POST /tasks/:id/webhook to trigger a run without a wallet. 📖 Full guide: https://scheduler.withzero.xyz/llms.txt", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "secret", "enabled" ], "properties": { "secret": { "type": "string", "description": "The webhook secret — shown ONCE. Present it as `Authorization: Bearer ` to POST /api/v1/tasks/:id/webhook." }, "enabled": { "type": "boolean" } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "VALIDATION_ERROR", "IMMUTABLE_FIELD", "IMMUTABLE_TOOL_REMOVAL" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Validation or schema error" }, "402": { "description": "Payment required" }, "404": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_NOT_FOUND" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_PAUSED_INSUFFICIENT_FUNDS", "TASK_PAUSED_MANUAL", "RUN_IN_FLIGHT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Conflict with current resource state" }, "410": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "TASK_DELETED", "TASK_COMPLETED" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Resource is gone (deleted / completed)" }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "enum": [ "RATE_LIMIT" ], "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "message": { "type": "string" } } } } } } }, "description": "Rate-limited" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "operationId": "scheduler_put__api_v1_tasks__id__webhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "description": "Empty body. Enables or rotates the task webhook secret.", "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "scheduler-runtime" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/screenshot/screenshots": { "post": { "summary": "Capture a screenshot of any web page and return an image URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url", "path", "format", "fullPage", "sizeBytes" ], "properties": { "url": { "type": "string", "description": "Public CDN URL the screenshot is served from." }, "path": { "type": "string", "description": "Path of the stored object within the CDN wallet namespace." }, "format": { "enum": [ "png", "jpeg" ], "type": "string", "description": "Image format of the stored screenshot." }, "fullPage": { "type": "boolean", "description": "Whether the capture spanned the full scrollable page." }, "sizeBytes": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Size of the stored image in bytes." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "screenshot_post__api_v1_screenshots", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url" ], "properties": { "url": { "type": "string", "minLength": 1, "description": "Absolute http(s) URL of the page to capture." }, "clip": { "type": "object", "required": [ "x", "y", "width", "height" ], "properties": { "x": { "type": "number", "minimum": 0 }, "y": { "type": "number", "minimum": 0 }, "width": { "type": "number", "exclusiveMinimum": 0 }, "height": { "type": "number", "exclusiveMinimum": 0 } }, "description": "Capture only this rectangular region of the page. Cannot combine with fullPage.", "additionalProperties": false }, "width": { "type": "integer", "maximum": 3840, "minimum": 1, "description": "Viewport width in CSS pixels. Default 1280." }, "format": { "enum": [ "png", "jpeg" ], "type": "string", "description": "Image format. Default png." }, "height": { "type": "integer", "maximum": 4320, "minimum": 1, "description": "Viewport height in CSS pixels. Default 800. fullPage captures extend below this." }, "delayMs": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Extra settle time in milliseconds after navigation, for late-loading content." }, "quality": { "type": "integer", "maximum": 100, "minimum": 1, "description": "JPEG compression quality 1-100. Only valid when format is jpeg." }, "fullPage": { "type": "boolean", "description": "Capture the entire scrollable page (a long vertical screenshot) instead of just the viewport. Cannot combine with clip." }, "waitUntil": { "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation lifecycle event to wait for before capturing. Default load." }, "autoScroll": { "type": "boolean", "description": "Scroll the page top-to-bottom before capturing so scroll-triggered content (lazy-loaded sections, reveal-on-scroll animations) renders. Defaults to true for fullPage captures, false otherwise." }, "omitBackground": { "type": "boolean", "description": "Render a transparent background instead of white. Only valid when format is png." }, "deviceScaleFactor": { "type": "number", "maximum": 3, "minimum": 1, "description": "Pixel-density multiplier (e.g. 2 for a retina capture). Default 1." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "screenshot-captures" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/urlshortener/links": { "post": { "summary": "Create a short link that redirects to a long URL for one year.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "code", "shortUrl", "expires" ], "properties": { "code": { "type": "string", "description": "Four-character base62 code assigned to the URL." }, "expires": { "type": "string", "description": "ISO timestamp at which the code stops resolving." }, "shortUrl": { "type": "string", "description": "Short URL of the form 0url.to/." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "urlshortener_post__api_v1_links", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "description": "The long URL to shorten." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "urlshortener-links" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/video/videos/kling-v3.0-pro": { "post": { "summary": "Generate a video from a text prompt with Kuaishou Kling 3.0 Pro — premium realism and motion, clips from 3 to 15 seconds. Returns a job id; poll the status route for the finished video URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "job_id", "status", "model", "price_usdc", "poll_path" ], "properties": { "model": { "type": "string", "description": "The model generating the video." }, "job_id": { "type": "string", "description": "Job id for the generation. Poll the status route with this id." }, "status": { "type": "string", "const": "pending", "description": "The job has been accepted and is generating." }, "poll_path": { "type": "string", "description": "Path of the free status route to poll for the finished video." }, "price_usdc": { "type": "string", "description": "The amount charged for this generation, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "video_post__api_v1_videos_kling_v3_0_pro", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "prompt": "A slow aerial shot over a foggy pine forest at dawn", "duration": 5 }, "required": [ "prompt", "duration", "resolution", "audio" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Seed for repeatable generation (best effort)." }, "audio": { "type": "boolean", "default": false, "description": "Generate a synchronized audio track." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the video to generate." }, "duration": { "anyOf": [ { "type": "number", "const": 3 }, { "type": "number", "const": 4 }, { "type": "number", "const": 5 }, { "type": "number", "const": 6 }, { "type": "number", "const": 7 }, { "type": "number", "const": 8 }, { "type": "number", "const": 9 }, { "type": "number", "const": 10 }, { "type": "number", "const": 11 }, { "type": "number", "const": 12 }, { "type": "number", "const": 13 }, { "type": "number", "const": 14 }, { "type": "number", "const": 15 } ], "default": 5, "description": "Clip length in seconds. One of: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15." }, "resolution": { "enum": [ "720p" ], "type": "string", "default": "720p", "description": "Output resolution. One of: 720p." }, "aspect_ratio": { "enum": [ "16:9", "9:16", "1:1" ], "type": "string", "description": "Aspect ratio of the output. One of: 16:9, 9:16, 1:1." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "kling-v3-0-pro" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service kling-v3-0-pro)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "kling-v3-0-pro", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/api/v1/video/videos/sora-2-pro": { "post": { "summary": "Generate a video from a text prompt with OpenAI Sora 2 Pro — production-quality motion with synchronized audio. Returns a job id; poll the status route for the finished video URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "job_id", "status", "model", "price_usdc", "poll_path" ], "properties": { "model": { "type": "string", "description": "The model generating the video." }, "job_id": { "type": "string", "description": "Job id for the generation. Poll the status route with this id." }, "status": { "type": "string", "const": "pending", "description": "The job has been accepted and is generating." }, "poll_path": { "type": "string", "description": "Path of the free status route to poll for the finished video." }, "price_usdc": { "type": "string", "description": "The amount charged for this generation, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "video_post__api_v1_videos_sora_2_pro", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "prompt": "A slow aerial shot over a foggy pine forest at dawn", "duration": 8 }, "required": [ "prompt", "duration", "resolution" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Seed for repeatable generation (best effort)." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the video to generate." }, "duration": { "anyOf": [ { "type": "number", "const": 4 }, { "type": "number", "const": 8 }, { "type": "number", "const": 12 }, { "type": "number", "const": 16 }, { "type": "number", "const": 20 } ], "default": 8, "description": "Clip length in seconds. One of: 4, 8, 12, 16, 20." }, "resolution": { "enum": [ "720p", "1080p" ], "type": "string", "default": "720p", "description": "Output resolution. One of: 720p, 1080p." }, "aspect_ratio": { "enum": [ "16:9", "9:16" ], "type": "string", "description": "Aspect ratio of the output. One of: 16:9, 9:16." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "sora-2-pro" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service sora-2-pro)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "sora-2-pro", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/api/v1/video/videos/veo-3.1": { "post": { "summary": "Generate a video from a text prompt with Google Veo 3.1 — maximum visual fidelity up to 4K with native audio. Returns a job id; poll the status route for the finished video URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "job_id", "status", "model", "price_usdc", "poll_path" ], "properties": { "model": { "type": "string", "description": "The model generating the video." }, "job_id": { "type": "string", "description": "Job id for the generation. Poll the status route with this id." }, "status": { "type": "string", "const": "pending", "description": "The job has been accepted and is generating." }, "poll_path": { "type": "string", "description": "Path of the free status route to poll for the finished video." }, "price_usdc": { "type": "string", "description": "The amount charged for this generation, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "video_post__api_v1_videos_veo_3_1", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "prompt": "A slow aerial shot over a foggy pine forest at dawn", "duration": 8 }, "required": [ "prompt", "duration", "resolution", "audio" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Seed for repeatable generation (best effort)." }, "audio": { "type": "boolean", "default": true, "description": "Generate a synchronized audio track." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the video to generate." }, "duration": { "anyOf": [ { "type": "number", "const": 4 }, { "type": "number", "const": 6 }, { "type": "number", "const": 8 } ], "default": 8, "description": "Clip length in seconds. One of: 4, 6, 8." }, "resolution": { "enum": [ "720p", "1080p", "4K" ], "type": "string", "default": "1080p", "description": "Output resolution. One of: 720p, 1080p, 4K." }, "aspect_ratio": { "enum": [ "16:9", "9:16" ], "type": "string", "description": "Aspect ratio of the output. One of: 16:9, 9:16." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "veo-3-1" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service veo-3-1)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "veo-3-1", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/api/v1/video/videos/veo-3.1-fast": { "post": { "summary": "Generate a video from a text prompt with Google Veo 3.1 Fast — high quality with native audio at a faster turnaround. Returns a job id; poll the status route for the finished video URL.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "job_id", "status", "model", "price_usdc", "poll_path" ], "properties": { "model": { "type": "string", "description": "The model generating the video." }, "job_id": { "type": "string", "description": "Job id for the generation. Poll the status route with this id." }, "status": { "type": "string", "const": "pending", "description": "The job has been accepted and is generating." }, "poll_path": { "type": "string", "description": "Path of the free status route to poll for the finished video." }, "price_usdc": { "type": "string", "description": "The amount charged for this generation, in USDC." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "video_post__api_v1_videos_veo_3_1_fast", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "prompt": "A slow aerial shot over a foggy pine forest at dawn", "duration": 8 }, "required": [ "prompt", "duration", "resolution", "audio" ], "properties": { "seed": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Seed for repeatable generation (best effort)." }, "audio": { "type": "boolean", "default": true, "description": "Generate a synchronized audio track." }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "description": "Text description of the video to generate." }, "duration": { "anyOf": [ { "type": "number", "const": 4 }, { "type": "number", "const": 6 }, { "type": "number", "const": 8 } ], "default": 8, "description": "Clip length in seconds. One of: 4, 6, 8." }, "resolution": { "enum": [ "720p", "1080p", "4K" ], "type": "string", "default": "720p", "description": "Output resolution. One of: 720p, 1080p, 4K." }, "aspect_ratio": { "enum": [ "16:9", "9:16" ], "type": "string", "description": "Aspect ratio of the output. One of: 16:9, 9:16." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "veo-3-1-fast" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per cents (cents, service veo-3-1-fast)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "veo-3-1-fast", "meter": "cents", "unit": "cents", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/api/v1/wiza/company-enrichments": { "post": { "summary": "Enrich one company by name, domain, LinkedIn ID, or LinkedIn slug. Returns Wiza company industry, size, revenue, funding, social, and location fields. Metered billing settles from Wiza company enrichment API credits.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string" }, "credits": { "type": "object", "properties": { "api_credits": { "type": "object", "properties": { "total": { "type": "number" }, "email_credits": { "type": "number" }, "phone_credits": { "type": "number" }, "scrape_credits": { "type": "number" }, "company_credits": { "type": "number" } }, "additionalProperties": {} } }, "additionalProperties": {} }, "company_name": { "type": "string" }, "company_size": { "type": "number" }, "company_type": { "type": "string" }, "company_domain": { "type": "string" }, "company_region": { "type": "string" }, "company_street": { "type": "string" }, "company_ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_country": { "type": "string" }, "company_founded": { "type": "number" }, "company_funding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "company_twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_industry": { "type": "string" }, "company_linkedin": { "type": "string" }, "company_locality": { "type": "string" }, "company_location": { "type": "string" }, "company_size_range": { "type": "string" }, "company_description": { "type": "string" }, "company_linkedin_id": { "type": "string" }, "company_postal_code": { "type": "string" }, "company_revenue_range": { "type": "string" }, "company_last_funding_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_last_funding_round": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_last_funding_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": {} }, "type": { "type": "string" }, "status": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "additionalProperties": {} }, "billing": { "type": "object", "required": [ "apiCredits", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "description": "Wiza API credits found in the upstream response and used for metered settlement." }, "settledUsdcMicro": { "type": "string", "description": "Actual metered MPP settlement amount in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "description": "Configured USDC micro-units charged per Wiza API credit." } }, "additionalProperties": false } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_company_enrichments", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "company_domain": "wiza.co" }, "properties": { "company_name": { "type": "string", "minLength": 1, "description": "Company name to enrich, e.g. Wiza." }, "company_domain": { "type": "string", "minLength": 1, "description": "Company domain to enrich, e.g. wiza.co." }, "company_linkedin_id": { "type": "string", "minLength": 1, "description": "LinkedIn company ID." }, "company_linkedin_slug": { "type": "string", "minLength": 1, "description": "LinkedIn company slug from the company URL." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "wiza-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credits (credits, service wiza-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "wiza-credits", "meter": "credits", "unit": "credits", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "credits", "unit": "credits", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/wiza/credits": { "post": { "summary": "Get the Wiza account credit balance for email, phone, export, and API credits. Proof-only route: no payment.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "credits": { "type": "object", "properties": { "api_credits": { "type": "number" }, "email_credits": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "phone_credits": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "export_credits": { "type": "number" } }, "additionalProperties": {} } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_credits", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "Free", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.000000" } } } }, "/api/v1/wiza/individual-reveals": { "post": { "summary": "Start a Wiza individual reveal for one contact and poll until completion. Accepts name + company/domain, email, or LinkedIn profile URL. Advertised unit price starts at $0.01/profile; final metered settlement follows Wiza api_credits.total and can be up to $0.08/profile when Wiza returns contact-field credits.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "data": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "email_type": { "type": "string" }, "email_status": { "anyOf": [ { "enum": [ "valid", "risky", "invalid", "unfound" ], "type": "string" }, { "type": "string" } ] } }, "additionalProperties": {} } }, "phones": { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "enum": [ "mobile", "other" ], "type": "string" }, { "type": "string" } ] }, "number": { "type": "string" }, "pretty_number": { "type": "string" } }, "additionalProperties": {} } }, "status": { "type": "string" }, "company": { "type": "string" }, "credits": { "anyOf": [ { "type": "object", "properties": { "api_credits": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "number" }, "email_credits": { "type": "number" }, "phone_credits": { "type": "number" }, "scrape_credits": { "type": "number" }, "company_credits": { "type": "number" } }, "additionalProperties": {} }, { "type": "null" } ] } }, "additionalProperties": {} }, { "type": "null" } ] }, "location": { "type": "string" }, "email_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fail_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_complete": { "type": "boolean" }, "company_size": { "type": "number" }, "company_type": { "type": "string" }, "email_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_domain": { "type": "string" }, "company_region": { "type": "string" }, "company_street": { "type": "string" }, "company_country": { "type": "string" }, "company_founded": { "type": "number" }, "company_funding": { "type": "number" }, "company_revenue": { "type": "number" }, "company_industry": { "type": "string" }, "company_linkedin": { "type": "string" }, "company_locality": { "type": "string" }, "company_location": { "type": "string" }, "enrichment_level": { "type": "string" }, "company_size_range": { "type": "string" }, "company_description": { "type": "string" }, "company_postal_code": { "type": "string" }, "company_subindustry": { "type": "string" }, "linkedin_profile_url": { "type": "string" } }, "additionalProperties": {} }, "type": { "type": "string", "const": "individual_reveal" }, "status": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "additionalProperties": {} }, "billing": { "type": "object", "required": [ "apiCredits", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "description": "Wiza API credits found in the upstream response and used for metered settlement." }, "settledUsdcMicro": { "type": "string", "description": "Actual metered MPP settlement amount in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "description": "Configured USDC micro-units charged per Wiza API credit." } }, "additionalProperties": false } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_individual_reveals", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "enrichment_level": "partial", "individual_reveal": { "company": "Analytical Engines", "full_name": "Ada Lovelace" } }, "required": [ "individual_reveal", "enrichment_level" ], "properties": { "max_wait_ms": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Maximum time to poll Wiza before returning a timeout if the upstream job is still queued/running. Defaults to 25000." }, "callback_url": { "type": "string", "format": "uri", "description": "Optional Wiza webhook URL for asynchronous completion updates." }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails Wiza may return for an individual reveal.", "additionalProperties": false }, "wait_for_result": { "type": "boolean", "const": true, "description": "Poll Wiza status endpoints before returning. Metered Wiza routes require this to stay true so billing can settle from final credit usage." }, "enrichment_level": { "enum": [ "none", "partial", "phone", "full" ], "type": "string", "description": "none = LinkedIn/profile data only; partial = email; phone = phone; full = email and phone." }, "poll_interval_ms": { "type": "integer", "maximum": 10000, "minimum": 500, "description": "Delay between Wiza status polls. Defaults to 2000." }, "individual_reveal": { "anyOf": [ { "type": "object", "required": [ "full_name" ], "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "Known email address for this contact." }, "domain": { "type": "string", "minLength": 1, "description": "Company domain. Required with full_name when company is absent." }, "company": { "type": "string", "minLength": 1, "description": "Company name. Required with full_name when domain is absent." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the contact, e.g. \"Stephen Hakami\"." }, "profile_url": { "type": "string", "minLength": 1, "description": "LinkedIn profile URL, if already known." } }, "additionalProperties": false }, { "type": "object", "required": [ "profile_url" ], "properties": { "profile_url": { "type": "string", "minLength": 1, "description": "LinkedIn, Sales Navigator, or Recruiter profile URL." } }, "additionalProperties": false }, { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "Known email address for this contact." } }, "additionalProperties": false } ], "example": { "company": "Analytical Engines", "full_name": "Ada Lovelace" }, "description": "Contact to enrich. Provide full_name plus company or domain, an email, or a LinkedIn profile URL." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "wiza-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credits (credits, service wiza-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "wiza-credits", "meter": "credits", "unit": "credits", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "credits", "unit": "credits", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/wiza/lists": { "post": { "summary": "Create a Wiza enrichment list from explicit contacts, emails, or LinkedIn profile URLs. Supports up to 30 items per call; payment escrow is sized from the submitted item count and final settlement comes from Wiza list api_credits.total.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "data": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stats": { "type": "object", "properties": { "people": { "type": "number" }, "credits": { "type": "object", "properties": { "api_credits": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "number" }, "email_credits": { "type": "number" }, "phone_credits": { "type": "number" }, "scrape_credits": { "type": "number" }, "company_credits": { "type": "number" } }, "additionalProperties": {} }, { "type": "null" } ] } }, "additionalProperties": {} } }, "additionalProperties": {} }, "status": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report_type": { "type": "string" }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_generic": { "type": "boolean", "description": "Return generic role addresses such as hello@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails Wiza may return for list-style enrichment.", "additionalProperties": false }, "enrichment_level": { "type": "string" } }, "additionalProperties": {} }, "type": { "type": "string", "const": "list" }, "status": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "additionalProperties": {} }, "billing": { "type": "object", "required": [ "apiCredits", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "description": "Wiza API credits found in the upstream response and used for metered settlement." }, "settledUsdcMicro": { "type": "string", "description": "Actual metered MPP settlement amount in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "description": "Configured USDC micro-units charged per Wiza API credit." } }, "additionalProperties": false } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_lists", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "list": { "name": "Enrichment sample", "items": [ { "company": "Analytical Engines", "full_name": "Ada Lovelace" } ], "email_options": { "accept_work": true }, "enrichment_level": "partial" } }, "required": [ "list" ], "properties": { "list": { "type": "object", "required": [ "name", "enrichment_level", "email_options", "items" ], "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the Wiza enrichment list." }, "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "full_name" ], "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "Known email address for this contact." }, "domain": { "type": "string", "minLength": 1, "description": "Company domain. Required with full_name when company is absent." }, "company": { "type": "string", "minLength": 1, "description": "Company name. Required with full_name when domain is absent." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the contact, e.g. \"Stephen Hakami\"." }, "profile_url": { "type": "string", "minLength": 1, "description": "LinkedIn profile URL, if already known." } }, "additionalProperties": false }, { "type": "object", "required": [ "profile_url" ], "properties": { "profile_url": { "type": "string", "minLength": 1, "description": "LinkedIn, Sales Navigator, or Recruiter profile URL." } }, "additionalProperties": false }, { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "Known email address for this contact." } }, "additionalProperties": false } ], "example": { "company": "Analytical Engines", "full_name": "Ada Lovelace" }, "description": "One Wiza contact input." }, "maxItems": 30, "minItems": 1, "description": "People to enrich. Wiza supports larger lists, but this public listing caps one call at 30 items to keep max payment bounded." }, "callback_url": { "type": "string", "format": "uri", "description": "Optional Wiza webhook URL for asynchronous completion updates." }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_generic": { "type": "boolean", "description": "Return generic role addresses such as hello@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails to return.", "additionalProperties": false }, "enrichment_level": { "enum": [ "none", "partial", "full" ], "type": "string", "description": "none = profile data only; partial = emails; full = emails and phone numbers." } }, "additionalProperties": false }, "max_wait_ms": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Maximum time to poll Wiza before returning a timeout if the upstream job is still queued/running. Defaults to 25000." }, "wait_for_result": { "type": "boolean", "const": true, "description": "Poll Wiza status endpoints before returning. Metered Wiza routes require this to stay true so billing can settle from final credit usage." }, "poll_interval_ms": { "type": "integer", "maximum": 10000, "minimum": 500, "description": "Delay between Wiza status polls. Defaults to 2000." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "wiza-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credits (credits, service wiza-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "wiza-credits", "meter": "credits", "unit": "credits", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "credits", "unit": "credits", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/wiza/prospect-lists": { "post": { "summary": "Create an enriched Wiza prospect list from search filters, including company-name aliases normalized to Wiza job_company. Capped at 30 profiles per call; payment escrow is sized from list.max_profiles and final settlement comes from Wiza list api_credits.total.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "data": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stats": { "type": "object", "properties": { "people": { "type": "number" }, "credits": { "type": "object", "properties": { "api_credits": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "number" }, "email_credits": { "type": "number" }, "phone_credits": { "type": "number" }, "scrape_credits": { "type": "number" }, "company_credits": { "type": "number" } }, "additionalProperties": {} }, { "type": "null" } ] } }, "additionalProperties": {} } }, "additionalProperties": {} }, "status": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report_type": { "type": "string" }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_generic": { "type": "boolean", "description": "Return generic role addresses such as hello@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails Wiza may return for list-style enrichment.", "additionalProperties": false }, "enrichment_level": { "type": "string" } }, "additionalProperties": {} }, "type": { "type": "string", "const": "list" }, "status": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "additionalProperties": {} }, "billing": { "type": "object", "required": [ "apiCredits", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "description": "Wiza API credits found in the upstream response and used for metered settlement." }, "settledUsdcMicro": { "type": "string", "description": "Actual metered MPP settlement amount in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "description": "Configured USDC micro-units charged per Wiza API credit." } }, "additionalProperties": false } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_prospect_lists", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "list": { "name": "US founders sample", "max_profiles": 3 }, "filters": { "job_title": [ { "v": "founder" } ] } }, "required": [ "list", "filters" ], "properties": { "list": { "type": "object", "required": [ "name", "max_profiles" ], "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the prospect list." }, "callback_url": { "type": "string", "format": "uri", "description": "Optional Wiza webhook URL for asynchronous completion updates." }, "max_profiles": { "type": "integer", "maximum": 30, "minimum": 1, "description": "Number of prospects to enrich. Capped at 30 for bounded metered pricing." }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_generic": { "type": "boolean", "description": "Return generic role addresses such as hello@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails Wiza may return for list-style enrichment.", "additionalProperties": false }, "skip_duplicates": { "type": "boolean", "description": "Skip contacts previously found in other API lists." }, "enrichment_level": { "enum": [ "none", "partial", "full" ], "type": "string", "description": "none = profile data only; partial = emails; full = emails and phone numbers. Defaults to partial." } }, "additionalProperties": false }, "filters": { "type": "object", "properties": { "major": { "type": "array", "items": { "type": "string" }, "description": "Majors to match." }, "skill": { "type": "array", "items": { "type": "string" }, "description": "Skills to match." }, "school": { "type": "array", "items": { "type": "string" }, "description": "Exact school names." }, "company": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Alias for job_company. Use this when targeting prospects at specific current companies." }, "revenue": { "type": "array", "items": { "enum": [ "$0-$1M", "$1M-$10M", "$10M-$25M", "$25M-$50M", "$50M-$100M", "$100M-$250M", "$250M-$500M", "$500M-$1B", "$1B-$10B", "$10B+" ], "type": "string" } }, "job_role": { "type": "array", "items": { "enum": [ "customer_service", "design", "education", "engineering", "finance", "health", "human_resources", "legal", "marketing", "media", "operations", "public_relations", "real_estate", "sales", "trades" ], "type": "string" }, "description": "Functional roles." }, "location": { "type": "array", "items": { "type": "object", "required": [ "v", "b" ], "properties": { "b": { "enum": [ "city", "state", "country" ], "type": "string", "description": "Location type." }, "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Location name. City format: \"city, state, country\"; state format: \"state, country\"; country format: \"country\"." } }, "additionalProperties": false }, "description": "Prospect locations to include or exclude." }, "job_title": { "type": "array", "items": { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, "description": "Job titles to include or exclude. Wrap a title in quotes for exact title matching." }, "last_name": { "type": "array", "items": { "type": "string" }, "description": "Exact last-name matches." }, "first_name": { "type": "array", "items": { "type": "string" }, "description": "Exact first-name matches." }, "funding_max": { "type": "string" }, "funding_min": { "type": "string" }, "job_company": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Current company names to include or exclude. Strings are accepted and normalized to include filters." }, "company_name": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Alias for job_company. Use this when targeting prospects at specific current companies." }, "company_size": { "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+" ], "type": "string" } }, "company_type": { "type": "array", "items": { "enum": [ "private", "public", "educational", "government", "nonprofit", "public_subsidiary" ], "type": "string" } }, "funding_date": { "type": "object", "required": [ "t", "v" ], "properties": { "t": { "enum": [ "last", "any" ], "type": "string", "description": "Match the last funding event or any funding event." }, "v": { "type": "string", "minLength": 1, "description": "Wiza funding value such as 60d, 90d, 1y, seed, series_a, or venture depending on the field." } }, "additionalProperties": false }, "funding_type": { "type": "object", "required": [ "t", "v" ], "properties": { "t": { "enum": [ "last", "any" ], "type": "string" }, "v": { "type": "array", "items": { "enum": [ "angel", "venture", "grant", "debt_financing", "private_equity", "crowdfunding", "other" ], "type": "string" } } }, "additionalProperties": false }, "job_sub_role": { "type": "array", "items": { "type": "string" }, "description": "Wiza job sub-role values such as software, recruiting, customer_success, product, or data." }, "past_company": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Past company names to include or exclude. Strings are accepted and normalized to include filters." }, "business_name": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Alias for job_company. Use this when targeting prospects at specific current companies." }, "funding_stage": { "type": "object", "required": [ "t", "v" ], "properties": { "t": { "enum": [ "last", "any" ], "type": "string" }, "v": { "type": "array", "items": { "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e-j", "other" ], "type": "string" } } }, "additionalProperties": false }, "linkedin_slug": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn profile slugs or full LinkedIn profile URLs." }, "company_summary": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Words to include or exclude in the company summary. Strings are accepted and normalized to include filters." }, "current_company": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Alias for job_company. Use this when targeting prospects at specific current companies." }, "department_size": { "type": "array", "items": { "type": "string" }, "description": "Department headcount filters such as \"sales:10-50\", \"engineering:10-\", or \"marketing:-50\"." }, "job_title_level": { "type": "array", "items": { "enum": [ "CXO", "Director", "Entry", "Manager", "Owner", "Partner", "Senior", "Training", "Unpaid", "VP" ], "type": "string" }, "description": "Seniority levels." }, "company_industry": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "v" ], "properties": { "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Filter value." } }, "additionalProperties": false }, { "type": "string", "minLength": 1 } ] }, "description": "Company industries to include or exclude, using Wiza industry values. Strings are accepted and normalized to include filters." }, "company_location": { "type": "array", "items": { "type": "object", "required": [ "v", "b" ], "properties": { "b": { "enum": [ "city", "state", "country" ], "type": "string", "description": "Location type." }, "s": { "enum": [ "i", "e" ], "type": "string", "description": "Use \"i\" to include or \"e\" to exclude. Defaults to include when omitted." }, "v": { "type": "string", "minLength": 1, "description": "Location name. City format: \"city, state, country\"; state format: \"state, country\"; country format: \"country\"." } }, "additionalProperties": false }, "description": "Company locations to include or exclude." }, "last_funding_max": { "type": "string" }, "last_funding_min": { "type": "string" }, "year_founded_end": { "type": "string" }, "year_founded_start": { "type": "string" }, "company_annual_growth": { "enum": [ "0-5%", "5-10%", "10-20%", "20-50%", "50-100%", "100%+" ], "type": "string" } }, "description": "Wiza prospect search filters. Additional Wiza-documented filter fields are accepted and forwarded.", "additionalProperties": {} }, "max_wait_ms": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Maximum time to poll Wiza before returning a timeout if the upstream job is still queued/running. Defaults to 25000." }, "wait_for_result": { "type": "boolean", "const": true, "description": "Poll Wiza status endpoints before returning. Metered Wiza routes require this to stay true so billing can settle from final credit usage." }, "poll_interval_ms": { "type": "integer", "maximum": 10000, "minimum": 500, "description": "Delay between Wiza status polls. Defaults to 2000." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" }, { "gaps": [ "Missing request body schema", "Missing response body schema" ], "pages": [ 1 ], "sourceId": "sds_oz0X-8Rc-z4Qiu-Hjg44A", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_yO2RK_MvCvbyvI9iZO95p" } ], "x-zeroclick-services": [ "wiza-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credits (credits, service wiza-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "wiza-credits", "meter": "credits", "unit": "credits", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "credits", "unit": "credits", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/wiza/prospect-lists/continue": { "post": { "summary": "Continue a Wiza prospect list search to fetch additional matching profiles. Capped at 30 additional profiles per call; payment escrow is sized from max_profiles when provided and final settlement comes from Wiza list api_credits.total.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "data": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stats": { "type": "object", "properties": { "people": { "type": "number" }, "credits": { "type": "object", "properties": { "api_credits": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "number" }, "email_credits": { "type": "number" }, "phone_credits": { "type": "number" }, "scrape_credits": { "type": "number" }, "company_credits": { "type": "number" } }, "additionalProperties": {} }, { "type": "null" } ] } }, "additionalProperties": {} } }, "additionalProperties": {} }, "status": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report_type": { "type": "string" }, "email_options": { "type": "object", "properties": { "accept_work": { "type": "boolean", "description": "Return professional email addresses such as tim.cook@apple.com." }, "accept_generic": { "type": "boolean", "description": "Return generic role addresses such as hello@apple.com." }, "accept_personal": { "type": "boolean", "description": "Return personal email addresses such as tcook1960@gmail.com." } }, "description": "Types of emails Wiza may return for list-style enrichment.", "additionalProperties": false }, "enrichment_level": { "type": "string" } }, "additionalProperties": {} }, "type": { "type": "string", "const": "list" }, "status": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "additionalProperties": {} }, "billing": { "type": "object", "required": [ "apiCredits", "pricePerCreditUsdcMicro", "settledUsdcMicro" ], "properties": { "apiCredits": { "type": "number", "description": "Wiza API credits found in the upstream response and used for metered settlement." }, "settledUsdcMicro": { "type": "string", "description": "Actual metered MPP settlement amount in USDC micro-units." }, "pricePerCreditUsdcMicro": { "type": "string", "description": "Configured USDC micro-units charged per Wiza API credit." } }, "additionalProperties": false } }, "additionalProperties": {} } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "wiza_post__api_v1_prospect_lists_continue", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "example": { "id": 12345, "max_profiles": 3 }, "required": [ "id" ], "properties": { "id": { "type": "integer", "maximum": 9007199254740991, "description": "ID of the prospect list to continue.", "exclusiveMinimum": 0 }, "max_wait_ms": { "type": "integer", "maximum": 60000, "minimum": 1, "description": "Maximum time to poll Wiza before returning a timeout if the upstream job is still queued/running. Defaults to 25000." }, "callback_url": { "type": "string", "format": "uri", "description": "Optional Wiza webhook URL for asynchronous completion updates." }, "max_profiles": { "type": "integer", "maximum": 30, "minimum": 1, "description": "Additional results to return. Defaults to Wiza's previous list value; capped at 30." }, "wait_for_result": { "type": "boolean", "const": true, "description": "Poll Wiza status endpoints before returning. Metered Wiza routes require this to stay true so billing can settle from final credit usage." }, "poll_interval_ms": { "type": "integer", "maximum": 10000, "minimum": 500, "description": "Delay between Wiza status polls. Defaults to 2000." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "wiza-credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credits (credits, service wiza-credits, first 10 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "wiza-credits", "meter": "credits", "unit": "credits", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 10 } ], "included": [ { "meterSlug": "credits", "unit": "credits", "freeUnits": 10, "per": "account" } ] } } }, "/api/v1/zeroman/credits": { "post": { "summary": "Insert a coin: pay to mint an arcade credit (3 lives) for a run of ZEROMAN.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "creditId", "lives", "playUrl" ], "properties": { "lives": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991, "description": "Lives granted by this credit." }, "playUrl": { "type": "string", "description": "Open this URL in a browser to play the run this credit paid for." }, "creditId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Arcade credit id — open the game as ?credit= to play the run it paid for." } }, "additionalProperties": false } } }, "description": "Successful response after payment" }, "402": { "description": "Payment required" } }, "operationId": "zeroman_post__api_v1_credits", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "name": { "type": "string", "maxLength": 24, "description": "Optional display handle shown on the leaderboard (e.g. your agent name)." } }, "additionalProperties": false } } }, "required": true }, "x-zeroclick-contract-gaps": [ "Unresolved reference: #/components/schemas/PaymentRequired" ], "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Z0gel5tQHnPe9XhmjiQcL", "authority": "official", "conflicts": [], "revisionId": "sdrn_Yc7qObvcfMTtAwcv4Anhn" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_ggA72tjsbXpqsjZHtbPUc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_L6e8lTQjXodkHMDjqVLKU" } ], "x-zeroclick-services": [ "credits" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "100000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.100000 per requests (requests, service credits, first 1 free per account)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.100000" }, "rates": [ { "service": "credits", "meter": "requests", "unit": "requests", "unitSize": 1, "priceUsd": "0.100000", "includedUnits": 1 } ], "included": [ { "meterSlug": "requests", "unit": "requests", "freeUnits": 1, "per": "account" } ] } } }, "/zeroclick/agent/quote": { "post": { "operationId": "sellerAgentQuote", "summary": "Get a free seller API quote and purchase guide", "description": "Describe your task to get the matching API contract, prices, prerequisites and next steps. This is a $0 wallet-proof lookup, not the seller's paid service. No purchase is executed. Without a wallet, use /zeroclick/agent/guide.", "servers": [ { "url": "https://agents.withzero.xyz" } ], "security": [ { "sellerAgentX402": [] }, { "sellerAgentMpp": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "goal": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Describe the task and known inputs. Do not include credentials." }, "quantity": { "description": "Number of API calls, not returned items. Omit when unknown; describe desired output in goal.", "type": "integer", "minimum": 1, "maximum": 1000000 }, "budgetUsd": { "description": "Total cash budget in USD. A quote does not authorize spending.", "type": "string", "pattern": "^(0|[1-9]\\d{0,8})(\\.\\d{1,6})?$" }, "budgetExclusive": { "type": "boolean" }, "reviewAfterCalls": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "requirements": { "type": "string", "minLength": 1, "maxLength": 300 }, "humanAvailable": { "description": "Whether a human is in the loop. False recommends anonymous auth for a new autonomous identity; omit when unknown. Executing a human's request without further interruptions does not by itself mean false.", "type": "boolean" }, "payment": { "description": "Known payment method for the eventual purchase, independent of this free lookup's wallet proof.", "type": "string", "enum": [ "x402", "mpp", "card" ] } }, "required": [ "goal" ], "additionalProperties": false }, "example": { "goal": "Find the available services, prices and purchase steps" } } } }, "responses": { "200": { "description": "Task guidance; inspect status before executing anything", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "enum": [ "quoted", "ready", "needs_input", "blocked", "unknown", "unsupported", "unavailable" ] }, "priceUsd": { "type": "string", "const": "0" }, "guide": { "type": "string", "description": "Markdown guidance containing the task result, exact contract, pricing and next steps when available. No purchase is executed." }, "guideUrl": { "type": "string", "format": "uri", "description": "Wallet-free advisor endpoint for further planning or recovery." } }, "required": [ "status", "priceUsd", "guide", "guideUrl" ], "additionalProperties": false } } } }, "402": { "description": "$0 x402 or MPP wallet proof required; sign and retry the same request. No funds are transferred." }, "503": { "description": "Advisor unavailable; use the wallet-free guide or direct storefront references" } }, "x-payment-info": { "access": "payg", "price": { "mode": "fixed", "currency": "USD", "amount": "0" }, "protocols": [ { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } }, { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "method": "tempo", "intent": "charge", "description": "Free seller advisor lookup" } ] } } } }, "x-zeroclick-navigation-footer": { "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ], "fullSpec": "https://agents.withzero.xyz/openapi.json", "services": "https://agents.withzero.xyz/services", "serviceSpecTemplate": "https://agents.withzero.xyz/services/{slug}/openapi.json", "searchTemplate": "https://agents.withzero.xyz/openapi.json?q={text}", "operationTemplate": "https://agents.withzero.xyz/openapi.json?path={path}&method={method}", "firstPage": "https://agents.withzero.xyz/openapi.json?page=1" } }