{"openapi":"3.1.0","info":{"title":"Agentik API","version":"0.1.0","summary":"Pay-per-call tools for AI agents: one API key, one prepaid balance, many providers.","description":"Three primitives: discover (free, public), inspect (free, public), run (API key, billed per call). Prices are the providers' own, without markup; a platform fee applies when a human tops up the balance. A run is billed only when the upstream responds 2xx; otherwise the reservation is refunded. Some tools create a live resource (browser session, agent run): the run stays RUNNING and is settled when the resource ends. MCP (Streamable HTTP) is served at https://api.agentik.cc/mcp with the same catalog and billing; it authorizes through OAuth 2.1 (metadata at https://api.agentik.cc/.well-known/oauth-protected-resource/mcp) or the API key. https://api.agentik.cc/mcp/public serves discover and inspect without credentials."},"servers":[{"url":"https://api.agentik.cc"}],"security":[],"tags":[{"name":"onboarding","description":"Opt-in agent setup and private credential delivery"},{"name":"console","description":"Customer application server API; short-lived, server-minted identity assertions only"},{"name":"discover","description":"Free and public"},{"name":"run","description":"Requires an API key; billed per call"},{"name":"wallet","description":"Balance, activity, top-ups"},{"name":"oauth","description":"OAuth 2.1 authorization for MCP clients; the consent page at /oauth/authorize is a human surface"}],"paths":{"/v1/console/agent-onboarding/{id}":{"get":{"tags":["console"],"summary":"Read a setup request for review; approved requests require membership","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/agent-onboarding/{id}/quote":{"post":{"tags":["console"],"summary":"Quote exact credits plus additive fee without reserving or charging money","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credit_cents":{"type":"integer","minimum":0,"maximum":1000000}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/agent-onboarding/{id}/approve":{"post":{"tags":["console"],"summary":"Approve the reviewed settings and atomically create an owned workspace if requested plus a scoped key; no raw credential returned","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: verified customer, keys:write on an existing workspace. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_hash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"workspace_id":{"anyOf":[{"type":"string","pattern":"^ws_[a-f0-9]{32}$"},{"type":"null"}]},"workspace_name":{"type":"string","minLength":1,"maxLength":80},"policy":{"type":"object","properties":{"daily_cap_usd":{"default":null,"anyOf":[{"type":"number","exclusiveMinimum":0,"maximum":1000000},{"type":"null"}]},"allowed_tools":{"default":null,"anyOf":[{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","maxLength":120}},{"type":"null"}]}},"required":["daily_cap_usd","allowed_tools"],"additionalProperties":false},"credit_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"wait_for_funding":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/agent-onboarding/{id}/deny":{"post":{"tags":["console"],"summary":"Deny a pending setup request","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/agent-onboarding/{id}/oauth-finish":{"post":{"tags":["console"],"summary":"Return a short-lived PKCE-bound authorization code to the previously validated client redirect","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: approving customer, keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/agent-onboarding/{id}/funding":{"post":{"tags":["console"],"summary":"Reserve or resume the exact linked top-up and hosted Stripe Checkout; requires the reviewed total","security":[{"consoleAssertion":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"total_cents":{"type":"integer","minimum":1}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/agent-connections":{"get":{"tags":["console"],"summary":"Read real setup, verification, funding and revocation states for this workspace","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces":{"get":{"tags":["console"],"summary":"List current memberships","security":[{"consoleAssertion":[]}],"parameters":[],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"tags":["console"],"summary":"Create an additional zero-credit workspace as its owner; maximum 25 owned workspaces","security":[{"consoleAssertion":[]}],"parameters":[],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Resource created; store any returned secret or private link securely","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/bootstrap":{"post":{"tags":["console"],"summary":"Create one personal workspace, without issuing credit","security":[{"consoleAssertion":[]}],"parameters":[],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/snapshot":{"get":{"tags":["console"],"summary":"Balances, usage, key metadata, alerts and preferences","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","schema":{"type":"integer","enum":[7,30,90],"default":30}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/runs":{"get":{"tags":["console"],"summary":"Filtered run receipts with keyset pagination; no input or output is stored","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","schema":{"type":"integer","enum":[7,30,90],"default":30}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"q","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"tool","in":"query","schema":{"type":"string"}},{"name":"key","in":"query","schema":{"type":"string"}},{"name":"phase","in":"query","schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/runs/{runId}":{"get":{"tags":["console"],"summary":"Read one workspace-scoped run receipt without executing or settling it","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"runId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/keys":{"post":{"tags":["console"],"summary":"Issue an API key; the secret is returned once","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Resource created; store any returned secret or private link securely","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/keys/{keyId}":{"patch":{"tags":["console"],"summary":"Change caps, networks, expiry, tool policy or pause state","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}},"delete":{"tags":["console"],"summary":"Revoke a key","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/keys/{keyId}/usage":{"get":{"tags":["console"],"summary":"Read a key's usage summary and recent network activity","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/members":{"get":{"tags":["console"],"summary":"Members and invitations visible to the current role","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/invitations":{"post":{"tags":["console"],"summary":"Create a single-use invitation valid for 72 hours; reports email_delivery queued or not_configured; existing members or pending invitations return 409","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: members:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"enum":["admin","developer","viewer","billing"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Resource created; store any returned secret or private link securely","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/invitations/{inviteId}":{"delete":{"tags":["console"],"summary":"Revoke a pending invitation","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"inviteId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: members:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/invitations":{"post":{"tags":["console"],"summary":"Create one private link and, when configured, one queued email for an explicit workspace selection; require members:write on every target, preserve existing memberships and roll back on any pending-invitation conflict","security":[{"consoleAssertion":[]}],"parameters":[],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspace_ids":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","pattern":"^ws_[a-f0-9]{32}$"}},"email":{"type":"string","format":"email"},"role":{"enum":["admin","developer","viewer","billing"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Resource created; store any returned secret or private link securely","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/invitations/accept":{"post":{"tags":["console"],"summary":"Accept live invitations in a private link as their verified recipient; returns confirmed workspaces and unavailable_count, without restoring revoked or consumed targets","security":[{"consoleAssertion":[]}],"parameters":[],"description":"Required authority: customer. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","maxLength":6499,"pattern":"^[a-f0-9]{64}([.][a-f0-9]{64})*$"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/members/{userId}":{"patch":{"tags":["console"],"summary":"Change a role; preserve at least one owner","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: members:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"enum":["owner","admin","developer","viewer","billing"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}},"delete":{"tags":["console"],"summary":"Revoke membership; preserve at least one owner","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: members:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/settings":{"patch":{"tags":["console"],"summary":"Workspace name, low-balance threshold and alert delivery settings","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: settings:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/ledger":{"get":{"tags":["console"],"summary":"Paginated credit ledger and payment availability; no invented invoice documents","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"before","in":"query","schema":{"type":"string"},"description":"Use the next_cursor from the previous page."}],"description":"Required authority: billing:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing":{"get":{"tags":["console"],"summary":"Payment availability, top-up presets, history and stored recharge settings","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/quote":{"post":{"tags":["console"],"summary":"Quote the requested credits, added platform fee and total payment","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credit_cents":{"type":"integer","minimum":500,"maximum":1000000}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/topups":{"post":{"tags":["console"],"summary":"Reserve an immutable, idempotent credit purchase","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credit_cents":{"type":"integer","minimum":500,"maximum":1000000},"idempotency_key":{"type":"string","format":"uuid"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/topups/{topupId}":{"get":{"tags":["console"],"summary":"Read this workspace's authoritative payment status","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"topupId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/topups/{topupId}/checkout":{"post":{"tags":["console"],"summary":"Create or resume hosted Stripe Checkout","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"topupId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/setup":{"post":{"tags":["console"],"summary":"Save a test card through Stripe hosted setup","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"type":"string","format":"uuid"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/setup/{setupId}":{"get":{"tags":["console"],"summary":"Read this workspace's card setup confirmation","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"setupId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/auto-recharge":{"patch":{"tags":["console"],"summary":"Explicitly configure or disable automatic test recharge","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"threshold_usd":{"type":"number"},"amount_usd":{"type":"number"},"daily_limit_usd":{"type":"number"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/billing/auto-recharge/check":{"post":{"tags":["console"],"summary":"Evaluate the threshold and reconcile a pending test payment","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: billing:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/usage-export":{"get":{"tags":["console"],"summary":"Export up to 10,000 receipts for a 7, 30 or 90 day UTC range","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","schema":{"type":"integer","enum":[7,30,90],"default":30}}],"description":"Required authority: billing:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/audit":{"get":{"tags":["console"],"summary":"Latest 100 membership and configuration audit records","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: audit:read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/grants":{"get":{"tags":["console"],"summary":"List OAuth grants and inherited key labels and current states (active, paused, expired, revoked or unavailable)","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/grants/{grantId}":{"delete":{"tags":["console"],"summary":"Revoke an OAuth grant","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"grantId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: keys:write. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/notifications/read":{"post":{"tags":["console"],"summary":"Mark notifications read for this member","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/favorites":{"post":{"tags":["console"],"summary":"Save or remove a personal tool favorite","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tool_id":{"type":"string"},"favorite":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/estimate":{"post":{"tags":["console"],"summary":"Validate input and compute a deterministic reservation without executing the tool","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tool_id":{"type":"string"},"input":{"type":"object"},"volume":{"type":"integer","minimum":1,"maximum":1000000}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/conversations":{"get":{"tags":["console"],"summary":"List this member's active support conversations","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"tags":["console"],"summary":"Create a conversation; limit 30 per user and workspace per day","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":100}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/conversations/{conversationId}":{"get":{"tags":["console"],"summary":"Read an owned, unexpired conversation binding","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}},"delete":{"tags":["console"],"summary":"Remove conversation access immediately","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: read. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/conversations/{conversationId}/bind":{"post":{"tags":["console"],"summary":"Eve only: immutably bind the verified runtime session before model execution","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: assistant. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/console/workspaces/{workspaceId}/conversations/{conversationId}/admit":{"post":{"tags":["console"],"summary":"Eve only: check exact session ownership and atomically charge the message quota","security":[{"consoleAssertion":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"description":"Required authority: assistant. Current database membership is checked on every request. A workspace ID never grants access. Assistant assertions cannot mutate keys, membership or finances. Responses are private and never cached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":["string","null"]},"charge":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or expired server assertion","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permission","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Resource unavailable to this caller","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"State conflict, quota or ownership invariant","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate or support message limit exceeded","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agent-onboarding":{"post":{"tags":["onboarding"],"summary":"Create an expiring setup draft; no user, workspace, key or credit is created","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"client_name":{"type":"string","minLength":1,"maxLength":80},"workspace_name":{"default":"My workspace","type":"string","minLength":1,"maxLength":80},"requested_policy":{"default":{"daily_cap_usd":null,"allowed_tools":null},"type":"object","properties":{"daily_cap_usd":{"default":null,"anyOf":[{"type":"number","exclusiveMinimum":0,"maximum":1000000},{"type":"null"}]},"allowed_tools":{"default":null,"anyOf":[{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","maxLength":120}},{"type":"null"}]}},"required":["daily_cap_usd","allowed_tools"],"additionalProperties":false},"credit_cents":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"public_key":{"type":"object","properties":{"kty":{"type":"string","const":"RSA"},"n":{"type":"string","pattern":"^[A-Za-z0-9_-]{342}$"},"e":{"type":"string","const":"AQAB"}},"required":["kty","n","e"],"additionalProperties":false},"code_challenge":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"status_token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43,128}$"},"idempotency_key":{"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)$"}},"required":["client_name","workspace_name","requested_policy","credit_cents","public_key","code_challenge","status_token","idempotency_key"],"additionalProperties":false}}}},"responses":{"201":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agent-onboarding/{id}":{"get":{"tags":["onboarding"],"summary":"Read draft state using the private status capability; no account data or credential","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[{"onboardingStatusToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^onb_[a-f0-9]{32}$"}}],"responses":{"200":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agent-onboarding/{id}/credential":{"post":{"tags":["onboarding"],"summary":"Retrieve retryable RSA-OAEP SHA-256 ciphertext using the status capability and verifier","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[{"onboardingStatusToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^onb_[a-f0-9]{32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code_verifier":{"type":"string","pattern":"^[A-Za-z0-9_-]{43,128}$"}},"required":["code_verifier"],"additionalProperties":false}}}},"responses":{"200":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agent-onboarding/{id}/verify":{"post":{"tags":["onboarding"],"summary":"Prove possession after durable local storage; clear delivery ciphertext; no provider execution","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[{"apiKey":[]},{"oauth":["run"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^onb_[a-f0-9]{32}$"}}],"responses":{"200":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agent-onboarding/{id}/readiness":{"get":{"tags":["onboarding"],"summary":"Read connection and linked-payment readiness; ready does not guarantee funds for a particular task","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[{"apiKey":[]},{"oauth":["run"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^onb_[a-f0-9]{32}$"}}],"responses":{"200":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/.well-known/toolrouter-configuration":{"get":{"tags":["onboarding"],"summary":"Discover enabled onboarding capability and installation guide","description":"Onboarding is opt-in via TOOLROUTER_AGENT_ONBOARDING=1. Approval links identify a request and never sign in their recipient. Only a verified account may approve access. This custom encrypted-key bootstrap is not an OAuth device grant. No secrets belong in prompts or logs. Pending drafts expire after 15 minutes; encrypted delivery expires 5 minutes after approval. Poll at most once every 5 seconds and respect Retry-After. Pausing/revoking a key or removing the approving owner/admin blocks use immediately.","security":[],"responses":{"200":{"description":"Confirmed server state; credential delivery returns encrypted_key, algorithm, workspace_id and key_id only","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Invalid execution credential","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Access blocked","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Disabled, missing or unauthorized request","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"Pending authorization, conflicting retry or expired delivery","content":{"application/json":{"schema":{"type":"object"}}}},"429":{"description":"Rate limit; retry after the supplied delay","content":{"application/json":{"schema":{"type":"object"}}}},"503":{"description":"Temporarily unavailable; retry the same idempotent request","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/connect.md":{"get":{"tags":["discover"],"summary":"Public MCP installation guide for agents and humans","responses":{"200":{"description":"Markdown setup guide for this API environment","content":{"text/markdown":{"schema":{"type":"string"}}}},"503":{"description":"Guide deployment configuration is unavailable","content":{"text/markdown":{"schema":{"type":"string"}}}}}}},"/ready":{"get":{"tags":["discover"],"summary":"Database schema readiness","responses":{"200":{"description":"Database is reachable and at the required schema version"},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Database not ready","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/health":{"get":{"tags":["discover"],"summary":"Service health and catalog counts","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/v1/discover":{"post":{"tags":["discover"],"summary":"Search the catalog in natural language","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":1,"maxLength":2000,"description":"What you need, e.g. 'weather forecast for a city'"},"limit":{"type":"integer","minimum":1,"maximum":20,"default":5},"sort":{"type":"string","enum":["relevance","price","latency","reliability"],"default":"relevance"},"max_price_usd":{"type":"number","exclusiveMinimum":0,"description":"Only tools whose typical call costs at most this"}}}}}},"responses":{"200":{"description":"Ranked candidates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverResponse"}}}},"400":{"description":"Missing query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/tools":{"get":{"tags":["discover"],"summary":"Full catalog","responses":{"200":{"description":"All tools with status and price","content":{"application/json":{"schema":{"type":"object","properties":{"tools":{"type":"array","items":{"$ref":"#/components/schemas/Tool"}}}}}}}}}},"/v1/tools/{provider}/{tool}":{"get":{"tags":["discover"],"summary":"Inspect one tool (input schema, price, license, status)","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"tool","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tool spec","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tool"}}}},"404":{"description":"Unknown tool","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/run":{"post":{"tags":["run"],"summary":"Execute a tool and pay per call","security":[{"apiKey":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string"},"description":"Replays the same run instead of paying twice"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunRequest"}}}},"responses":{"200":{"description":"Run outcome (COMPLETED, FAILED and refunded, or RUNNING with deferred settlement)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunResult"}}}},"400":{"description":"INVALID_REQUEST or INVALID_INPUT (errors list the schema violations)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"INSUFFICIENT_CREDITS. Payments are disabled; payments_enabled is false and no top-up link is issued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientCreditsResponse"}}}},"403":{"description":"LIFETIME_CAP_EXCEEDED (optional lifetime cap), BUDGET_CAP_EXCEEDED (optional daily cap), TOOL_NOT_ALLOWED (key policy) or TOOL_CAP_EXCEEDED (daily cap for this tool on this key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"TOOL_NOT_FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"TOOL_NOT_ACTIVE, IDEMPOTENCY_CONFLICT or BILLING_SUSPENDED (provider consumption requires operator verification; no new call is dispatched)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"RATE_LIMITED (scope key or provider, retry_after_ms), PROVIDER_CAPACITY or FREE_TIER_EXHAUSTED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/runs/{id}":{"get":{"tags":["run"],"summary":"Status and final price of a run; settles deferred runs on demand","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Run view","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"RUN_NOT_FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/keys/me":{"get":{"tags":["wallet"],"summary":"Status of the calling API key: caps, spend today and last hour, allowed tools, networks seen","security":[{"apiKey":[]}],"responses":{"200":{"description":"Key status","content":{"application/json":{"schema":{"type":"object","properties":{"key_id":{"type":"string"},"label":{"type":"string","nullable":true},"daily_cap_usd":{"type":"number","nullable":true},"hourly_cap_usd":{"type":"number","nullable":true},"lifetime_cap_usd":{"type":"number","nullable":true},"spent_lifetime_usd":{"type":"number"},"remaining_lifetime_usd":{"type":"number","nullable":true},"spent_today_usd":{"type":"number"},"remaining_today_usd":{"type":"number","nullable":true},"spent_last_hour_usd":{"type":"number"},"allowed_tools":{"type":"array","items":{"type":"string"},"nullable":true},"allowed_cidrs":{"type":"array","items":{"type":"string"},"nullable":true},"expires_at":{"type":"string","nullable":true},"runs_7d":{"type":"integer"},"balance_usd":{"type":"number"}}}}}},"401":{"description":"Unauthorized, KEY_EXPIRED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"KEY_PAUSED, IP_NOT_ALLOWED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/wallet/balance":{"get":{"tags":["wallet"],"summary":"Balance, free tier and auto-recharge settings","security":[{"apiKey":[]}],"responses":{"200":{"description":"Wallet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletBalance"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/wallet/activities":{"get":{"tags":["wallet"],"summary":"Last ledger entries (top-ups, holds, refunds)","security":[{"apiKey":[]}],"responses":{"200":{"description":"Activities","content":{"application/json":{"schema":{"type":"object","properties":{"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/topups":{"post":{"tags":["wallet"],"summary":"Ask for a top-up link to hand to a human","description":"Never charges anything by itself: it creates a pending request whose page a human completes.","security":[{"apiKey":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"amount_usd":{"type":"number","description":"Credits requested in USD. The platform fee is added to the amount charged.","minimum":5,"default":10}}}}}},"responses":{"200":{"description":"Top-up request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopupInfo"}}}},"400":{"description":"Invalid amount","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/topups/{id}":{"get":{"tags":["wallet"],"summary":"Status of a top-up request","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Top-up request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopupStatus"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/mcp":{"post":{"tags":["run"],"summary":"MCP Streamable HTTP endpoint (spec 2026-07-28, 2025 clients supported)","description":"Tools: discover_tools, inspect_tool, run_tool, get_run. Requires a bearer: an OAuth 2.1 access token (hosted clients authorize through the metadata in WWW-Authenticate; a human approves once) or the API key 'Authorization: Bearer trk_...'.","security":[{"apiKey":[]},{"oauth":["run"]}],"responses":{"200":{"description":"JSON-RPC response"},"401":{"description":"No valid bearer; WWW-Authenticate carries resource_metadata (RFC 9728)"}}}},"/mcp/public":{"post":{"tags":["discover"],"summary":"Public MCP endpoint: discover_tools and inspect_tool without credentials","description":"Same server, no bearer needed; run_tool and get_run answer UNAUTHORIZED here and point to /mcp.","security":[],"responses":{"200":{"description":"JSON-RPC response"}}}},"/.well-known/oauth-protected-resource/mcp":{"get":{"tags":["oauth"],"summary":"Protected resource metadata for /mcp (RFC 9728)","description":"Where MCP clients learn which authorization server protects /mcp. Also served at /.well-known/oauth-protected-resource.","security":[],"responses":{"200":{"description":"Resource metadata","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string"},"authorization_servers":{"type":"array","items":{"type":"string"}},"scopes_supported":{"type":"array","items":{"type":"string"}}}}}}}}}},"/.well-known/oauth-protected-resource":{"get":{"tags":["oauth"],"summary":"Protected resource metadata (root form)","security":[],"responses":{"200":{"description":"Resource metadata"}}}},"/.well-known/oauth-authorization-server":{"get":{"tags":["oauth"],"summary":"Authorization server metadata (RFC 8414)","description":"Endpoints, PKCE S256, grant types, dynamic registration and client ID metadata document support. Also served at /.well-known/oauth-authorization-server/mcp.","security":[],"responses":{"200":{"description":"Authorization server metadata"}}}},"/.well-known/oauth-authorization-server/mcp":{"get":{"tags":["oauth"],"summary":"Authorization server metadata (path form)","security":[],"responses":{"200":{"description":"Authorization server metadata"}}}},"/oauth/register":{"post":{"tags":["oauth"],"summary":"Dynamic client registration (RFC 7591)","description":"Open, rate limited per address. Public clients (token_endpoint_auth_method none) get no secret; confidential ones get a client_secret returned once. Alternatively, use an https URL as client_id pointing at a client metadata document.","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["redirect_uris"],"properties":{"client_name":{"type":"string"},"redirect_uris":{"type":"array","items":{"type":"string"}},"token_endpoint_auth_method":{"type":"string","enum":["none","client_secret_post","client_secret_basic"]},"grant_types":{"type":"array","items":{"type":"string","enum":["authorization_code","refresh_token"]}},"client_uri":{"type":"string"},"logo_uri":{"type":"string"},"scope":{"type":"string"}}}}}},"responses":{"201":{"description":"Client registered"},"400":{"description":"invalid_client_metadata or invalid_redirect_uri"},"429":{"description":"Too many registrations from this address"}}}},"/oauth/token":{"post":{"tags":["oauth"],"summary":"Token endpoint: authorization_code (PKCE) and refresh_token (rotation)","description":"Form-encoded. A reused refresh token or a replayed code revokes the whole authorization. Access tokens live one hour, refresh tokens thirty days.","security":[],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["grant_type","client_id"],"properties":{"grant_type":{"type":"string","enum":["authorization_code","refresh_token"]},"client_id":{"type":"string"},"client_secret":{"type":"string"},"code":{"type":"string"},"redirect_uri":{"type":"string"},"code_verifier":{"type":"string"},"refresh_token":{"type":"string"},"resource":{"type":"string"},"scope":{"type":"string"}}}}}},"responses":{"200":{"description":"access_token, token_type Bearer, expires_in, refresh_token, scope"},"400":{"description":"invalid_grant, invalid_request, invalid_scope or unsupported_grant_type"},"401":{"description":"invalid_client"}}}},"/oauth/revoke":{"post":{"tags":["oauth"],"summary":"Token revocation (RFC 7009)","description":"Revokes the authorization behind an access or refresh token. Always 200.","security":[],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["token","client_id"],"properties":{"token":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}}},"responses":{"200":{"description":"Revoked or unknown"},"401":{"description":"invalid_client"}}}}},"components":{"securitySchemes":{"onboardingStatusToken":{"type":"http","scheme":"bearer","description":"Client-generated status_token from the draft request. Confers no account or execution authority."},"consoleAssertion":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HS256 assertion issued by the authenticated customer BFF, maximum 60 seconds, issuer toolrouter-console, audience toolrouter-client-api. Never expose the signing key or assertion to a browser."},"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"trk_...","description":"Workspace API key"},"oauth":{"type":"oauth2","description":"OAuth for MCP clients: PKCE S256, dynamic client registration or client ID metadata documents, refresh token rotation. With agent onboarding enabled, a verified account approves a dedicated execution key; otherwise the legacy authorization page accepts an existing workspace key. Tokens inherit the key policy.","flows":{"authorizationCode":{"authorizationUrl":"https://api.agentik.cc/oauth/authorize","tokenUrl":"https://api.agentik.cc/oauth/token","refreshUrl":"https://api.agentik.cc/oauth/token","scopes":{"run":"Discover, inspect and run tools, paid from the workspace balance within the key's caps"}}}}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}},"Health":{"type":"object","properties":{"ok":{"type":"boolean"},"tools":{"type":"object","properties":{"total":{"type":"integer"},"active":{"type":"integer"},"listed":{"type":"integer"},"disabled":{"type":"integer"}}}}},"Pricing":{"oneOf":[{"type":"object","required":["model","amountUsd"],"properties":{"model":{"const":"per_call"},"amountUsd":{"type":"number"},"multipliers":{"type":"array","items":{"type":"object"}}}},{"type":"object","required":["model","amountUsd","unitsPath","maxUnits"],"properties":{"model":{"const":"per_unit"},"amountUsd":{"type":"number"},"unitsPath":{"type":"string"},"maxUnits":{"type":"number"}}},{"type":"object","required":["model","amountUsd","maxMinutes"],"properties":{"model":{"const":"per_minute"},"amountUsd":{"type":"number"},"maxMinutes":{"type":"number"}}},{"type":"object","required":["model","costPath","maxUsdDefault","maxUsdCap"],"properties":{"model":{"const":"reported"},"costPath":{"type":"string"},"maxUsdDefault":{"type":"number"},"maxUsdCap":{"type":"number"}}}]},"Tool":{"type":"object","required":["id","provider","name","description","category","tags","access","pricing","inputSchema","status","available","auth_required"],"properties":{"id":{"type":"string","examples":["open-meteo/forecast"]},"provider":{"type":"string"},"operator_only":{"type":"boolean","description":"Provider-account maintenance operation; execution restricted to the configured operator workspace."},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"access":{"type":"string","enum":["open","platform_key","byok","partner"]},"pricing":{"$ref":"#/components/schemas/Pricing"},"license":{"type":"string"},"attribution":{"type":"string"},"docsUrl":{"type":"string"},"inputSchema":{"type":"object","description":"JSON Schema (draft 7) of the run input"},"status":{"type":"string","enum":["active","listed","disabled"]},"available":{"type":"boolean"},"auth_required":{"type":"string","enum":["none","platform","byok","partner"]},"settlement":{"type":"string","enum":["deferred"],"description":"Present when the final price is known only when the upstream resource ends"},"upstream":{"type":"string","enum":["http","mcp"],"description":"Whether the tool is served by an HTTP API or a third-party MCP server"}}},"DiscoverResponse":{"type":"object","properties":{"query":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"tool_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"$ref":"#/components/schemas/Pricing"},"price_estimate_usd":{"type":"number","description":"Typical cost of one call, comparable across pricing models"},"status":{"type":"string"},"available":{"type":"boolean"},"score":{"type":"number"},"reliability_7d":{"type":"number","description":"Share of successful runs over the last 7 days, when runs exist"},"p50_ms":{"type":"integer","description":"Median latency over the last 7 days, when runs exist"},"runs_7d":{"type":"integer"},"why":{"type":"array","items":{"type":"string"},"description":"Why this result ranks where it does"},"unavailable_reason":{"type":"string"}},"additionalProperties":true}}}},"RunRequest":{"type":"object","required":["tool_id"],"properties":{"tool_id":{"type":"string","examples":["serper/search"]},"input":{"type":"object","description":"Must match the tool's inputSchema (see components Input_*)"}}},"RunResult":{"type":"object","required":["run_id","tool_id","status","price_quoted_usd","price_billed_usd","duration_ms","balance_usd","output"],"properties":{"run_id":{"type":"string"},"tool_id":{"type":"string"},"status":{"type":"string","enum":["COMPLETED","FAILED","RUNNING"]},"http_status":{"type":["integer","null"]},"price_quoted_usd":{"type":"number"},"price_billed_usd":{"type":"number"},"billed_units":{"type":"number"},"duration_ms":{"type":"integer"},"balance_usd":{"type":"number"},"output":{"description":"Upstream response, shaped by the tool spec; null on failure"},"output_truncated":{"type":"boolean"},"error":{"type":"string"},"replayed":{"type":"boolean","description":"True when an Idempotency-Key replayed a previous run"},"settlement":{"type":"object","description":"Deferred settlement: the reservation is settled when the upstream resource ends","properties":{"pending":{"type":"boolean"},"upstream_id":{"type":"string"},"reserved_usd":{"type":"number"},"expires_at":{"type":"string"},"how":{"type":"string"}}}}},"RunView":{"type":"object","properties":{"execution_phase":{"type":"string","enum":["reserved","dispatching","pending","reconciliation_required","finalized"],"description":"Reconciliation retains the reservation until an operator verifies the outcome."},"run_id":{"type":"string"},"tool_id":{"type":"string"},"status":{"type":"string","enum":["COMPLETED","FAILED","RUNNING"]},"http_status":{"type":["integer","null"]},"price_quoted_usd":{"type":"number"},"price_billed_usd":{"type":"number"},"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"created_at":{"type":"string"},"upstream_id":{"type":"string"},"settlement_pending":{"type":"boolean"},"expires_at":{"type":"string"}}},"InsufficientCreditsResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"const":"INSUFFICIENT_CREDITS"},"message":{"type":"string"},"balance_usd":{"type":"number"},"price_usd":{"type":"number"},"payments_enabled":{"type":"boolean"},"topup":{"$ref":"#/components/schemas/TopupInfo"}}}}},"TopupInfo":{"type":"object","properties":{"topup_url":{"type":"string","description":"Page a human opens to pay; never callable by an agent"},"request_id":{"type":"string"},"amount_usd":{"type":"number"},"fee_usd":{"type":"number"},"credit_usd":{"type":"number"},"presets_usd":{"type":"array","items":{"type":"number"}}}},"TopupStatus":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"amount_usd":{"type":"number"},"credit_usd":{"type":"number"}},"additionalProperties":true},"WalletBalance":{"type":"object","properties":{"workspace_id":{"type":"string"},"balance_usd":{"type":"number"},"lifetime_topup_usd":{"type":"number"},"auto_recharge":{"type":"object","additionalProperties":true},"free_tier":{"type":"object","properties":{"used_today":{"type":"integer"},"limit_per_day":{"type":"integer"}}}}},"Activity":{"type":"object","properties":{"type":{"type":"string","enum":["topup","promo","hold","refund"]},"amount_usd":{"type":"number"},"run_id":{"type":["string","null"]},"created_at":{"type":"string"}}},"Input_open_meteo_geocode":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Place name, e.g. 'Paris'"},"count":{"type":"integer","minimum":1,"maximum":10,"default":3}},"required":["name"],"additionalProperties":false},"Input_open_meteo_forecast":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180}},"required":["latitude","longitude"],"additionalProperties":false},"Input_frankfurter_latest_rates":{"type":"object","properties":{"base":{"type":"string","minLength":3,"maxLength":3,"default":"EUR"},"symbols":{"type":"string","description":"Comma-separated currency codes, e.g. 'USD,GBP'"}},"additionalProperties":false},"Input_defillama_protocol_tvl":{"type":"object","properties":{"protocol":{"type":"string","minLength":1,"description":"Protocol slug, e.g. 'aave'"}},"required":["protocol"],"additionalProperties":false},"Input_wikipedia_page_summary":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Article title, e.g. 'Alan Turing'"}},"required":["title"],"additionalProperties":false},"Input_wikipedia_search":{"type":"object","properties":{"query":{"type":"string","minLength":1},"limit":{"type":"integer","minimum":1,"maximum":20,"default":5}},"required":["query"],"additionalProperties":false},"Input_hackernews_search":{"type":"object","properties":{"query":{"type":"string","minLength":1},"tags":{"type":"string","description":"e.g. 'story', 'comment', 'front_page'","default":"story"},"hits":{"type":"integer","minimum":1,"maximum":50,"default":10}},"required":["query"],"additionalProperties":false},"Input_hackernews_item":{"type":"object","properties":{"id":{"type":"integer","minimum":1}},"required":["id"],"additionalProperties":false},"Input_sec_edgar_company_filings":{"type":"object","properties":{"cik":{"type":"string","pattern":"^[0-9]{10}$","description":"10-digit CIK, zero-padded (Apple = 0000320193)"}},"required":["cik"],"additionalProperties":false},"Input_npm_package_latest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Package name, scoped allowed (e.g. '@hono/node-server')"}},"required":["name"],"additionalProperties":false},"Input_pypi_package":{"type":"object","properties":{"name":{"type":"string","minLength":1}},"required":["name"],"additionalProperties":false},"Input_gleif_lei_record":{"type":"object","properties":{"lei":{"type":"string","pattern":"^[A-Z0-9]{20}$"}},"required":["lei"],"additionalProperties":false},"Input_open_meteo_air_quality":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180}},"required":["latitude","longitude"],"additionalProperties":false},"Input_open_meteo_historical_weather":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"start_date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"YYYY-MM-DD"},"end_date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"YYYY-MM-DD, keep ranges short (one row per day)"},"daily":{"type":"string","maxLength":300,"pattern":"^[a-z0-9_]+(,[a-z0-9_]+)*$","description":"Comma-separated daily variables (Open-Meteo names)","default":"temperature_2m_max,temperature_2m_min,precipitation_sum,wind_speed_10m_max"}},"required":["latitude","longitude","start_date","end_date"],"additionalProperties":false},"Input_nominatim_geocode":{"type":"object","properties":{"q":{"type":"string","minLength":2,"maxLength":300,"description":"Free-form query, e.g. '10 Downing Street, London'"},"limit":{"type":"integer","minimum":1,"maximum":10,"default":3},"countrycodes":{"type":"string","pattern":"^[a-z]{2}(,[a-z]{2})*$","description":"Restrict to ISO 3166-1 alpha-2 codes, e.g. 'fr,be'"},"language":{"type":"string","minLength":2,"maxLength":10,"description":"Preferred language for names, e.g. 'en' or 'fr'","default":"en"}},"required":["q"],"additionalProperties":false},"Input_nominatim_reverse_geocode":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"zoom":{"type":"integer","minimum":3,"maximum":18,"default":18,"description":"Detail level: 18 = building, 10 = city, 3 = country"},"language":{"type":"string","minLength":2,"maxLength":10,"default":"en"}},"required":["latitude","longitude"],"additionalProperties":false},"Input_openalex_search_works":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":300},"per_page":{"type":"integer","minimum":1,"maximum":10,"default":5},"page":{"type":"integer","minimum":1,"maximum":20,"default":1},"filter":{"type":"string","maxLength":200,"description":"OpenAlex filter string, e.g. 'publication_year:2024,is_oa:true'"},"sort":{"type":"string","enum":["relevance_score:desc","cited_by_count:desc","publication_date:desc"],"default":"relevance_score:desc"}},"required":["query"],"additionalProperties":false},"Input_crossref_search_works":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":300},"rows":{"type":"integer","minimum":1,"maximum":20,"default":5},"filter":{"type":"string","maxLength":200,"description":"Crossref filter, e.g. 'from-pub-date:2024,type:journal-article'"},"sort":{"type":"string","enum":["relevance","published","is-referenced-by-count","created"],"default":"relevance"}},"required":["query"],"additionalProperties":false},"Input_github_repo":{"type":"object","properties":{"owner":{"type":"string","pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$","description":"User or organization, e.g. 'honojs'"},"repo":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,100}$","description":"Repository name, e.g. 'hono'"}},"required":["owner","repo"],"additionalProperties":false},"Input_github_search_repositories":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":256,"description":"GitHub search query with qualifiers"},"sort":{"type":"string","enum":["stars","forks","help-wanted-issues","updated"],"description":"Default: best match"},"order":{"type":"string","enum":["asc","desc"],"default":"desc"},"per_page":{"type":"integer","minimum":1,"maximum":10,"default":5},"page":{"type":"integer","minimum":1,"maximum":10,"default":1}},"required":["q"],"additionalProperties":false},"Input_usgs_earthquakes":{"type":"object","properties":{"starttime":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"YYYY-MM-DD (UTC), default: 30 days ago"},"endtime":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"YYYY-MM-DD (UTC), default: now"},"minmagnitude":{"type":"number","minimum":0,"maximum":10,"default":4.5},"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"orderby":{"type":"string","enum":["time","time-asc","magnitude","magnitude-asc"],"default":"time"},"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Center of a circular search (with longitude and maxradiuskm)"},"longitude":{"type":"number","minimum":-180,"maximum":180},"maxradiuskm":{"type":"number","minimum":1,"maximum":20001,"description":"Radius in km around latitude/longitude"}},"additionalProperties":false},"Input_world_bank_indicator":{"type":"object","properties":{"country":{"type":"string","pattern":"^(all|[A-Za-z]{2,3}(;[A-Za-z]{2,3}){0,9})$","description":"ISO2 or ISO3 code(s) separated by ';', e.g. 'FR' or 'FR;DE;US', or 'all'"},"indicator":{"type":"string","pattern":"^[A-Za-z0-9._]{3,40}$","description":"Indicator code, e.g. 'NY.GDP.MKTP.CD'"},"mrv":{"type":"integer","minimum":1,"maximum":60,"description":"Most recent N values per country"},"date":{"type":"string","pattern":"^[0-9]{4}(:[0-9]{4})?$","description":"Year or range, e.g. '2020' or '2015:2024'"},"per_page":{"type":"integer","minimum":1,"maximum":500,"default":100}},"required":["country","indicator"],"additionalProperties":false},"Input_recherche_entreprises_search":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":200,"description":"Company name, SIREN, SIRET or keywords"},"page":{"type":"integer","minimum":1,"maximum":10,"default":1},"per_page":{"type":"integer","minimum":1,"maximum":10,"default":5},"code_postal":{"type":"string","pattern":"^[0-9]{5}$","description":"Head office postcode filter"},"activite_principale":{"type":"string","pattern":"^[0-9]{2}\\.[0-9]{2}[A-Z]$","description":"NAF code filter, e.g. '62.01Z'"},"etat_administratif":{"type":"string","enum":["A","F"],"description":"A = active, F = closed"}},"required":["q"],"additionalProperties":false},"Input_api_adresse_geocode":{"type":"object","properties":{"q":{"type":"string","minLength":3,"maxLength":200,"description":"Address text, e.g. '8 boulevard du Port, Cergy'"},"limit":{"type":"integer","minimum":1,"maximum":20,"default":5},"postcode":{"type":"string","pattern":"^[0-9]{5}$"},"type":{"type":"string","enum":["housenumber","street","locality","municipality"]}},"required":["q"],"additionalProperties":false},"Input_api_adresse_reverse_geocode":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"limit":{"type":"integer","minimum":1,"maximum":5,"default":1},"type":{"type":"string","enum":["housenumber","street","locality","municipality"]}},"required":["latitude","longitude"],"additionalProperties":false},"Input_open_library_search":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":200,"description":"Free text, or fielded like 'title:dune author:herbert'"},"limit":{"type":"integer","minimum":1,"maximum":20,"default":5},"page":{"type":"integer","minimum":1,"maximum":20,"default":1}},"required":["q"],"additionalProperties":false},"Input_duckduckgo_instant_answer":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":300,"description":"Topic, entity or question, e.g. 'Alan Turing'"}},"required":["q"],"additionalProperties":false},"Input_wayback_availability":{"type":"object","properties":{"url":{"type":"string","minLength":4,"maxLength":2000,"description":"URL or domain, e.g. 'example.com'"},"timestamp":{"type":"string","pattern":"^[0-9]{4,14}$","description":"Preferred date, YYYYMMDD[hhmmss]; nearest snapshot is returned"}},"required":["url"],"additionalProperties":false},"Input_coingecko_simple_price":{"type":"object","properties":{"ids":{"type":"string","pattern":"^[a-z0-9-]+(,[a-z0-9-]+){0,19}$","description":"Comma-separated CoinGecko coin ids, e.g. 'bitcoin,ethereum'"},"vs_currencies":{"type":"string","pattern":"^[a-z]{2,5}(,[a-z]{2,5}){0,9}$","default":"usd","description":"Comma-separated, e.g. 'usd,eur,btc'"},"include_24hr_change":{"type":"boolean","default":true},"include_market_cap":{"type":"boolean","default":false}},"required":["ids"],"additionalProperties":false},"Input_open_food_facts_product":{"type":"object","properties":{"barcode":{"type":"string","pattern":"^[0-9]{8,14}$","description":"EAN-8, EAN-13 or UPC barcode"}},"required":["barcode"],"additionalProperties":false},"Input_serper_search":{"type":"object","properties":{"q":{"type":"string","minLength":1,"description":"Search query"},"gl":{"type":"string","minLength":2,"maxLength":2,"description":"Country code, e.g. 'fr'","default":"us"},"hl":{"type":"string","minLength":2,"maxLength":5,"description":"Language, e.g. 'fr'","default":"en"},"num":{"type":"integer","minimum":1,"maximum":100,"default":10},"page":{"type":"integer","minimum":1,"maximum":10,"default":1}},"required":["q"],"additionalProperties":false},"Input_serper_news":{"type":"object","properties":{"q":{"type":"string","minLength":1},"gl":{"type":"string","minLength":2,"maxLength":2,"default":"us"},"hl":{"type":"string","minLength":2,"maxLength":5,"default":"en"},"num":{"type":"integer","minimum":1,"maximum":100,"default":10}},"required":["q"],"additionalProperties":false},"Input_tavily_search":{"type":"object","properties":{"query":{"type":"string","minLength":1},"search_depth":{"type":"string","enum":["basic","advanced"],"default":"basic"},"max_results":{"type":"integer","minimum":1,"maximum":20,"default":5},"include_answer":{"type":"boolean","default":false},"topic":{"type":"string","enum":["general","news","finance"],"default":"general"}},"required":["query"],"additionalProperties":false},"Input_firecrawl_scrape":{"type":"object","properties":{"url":{"type":"string","minLength":8,"description":"Public https URL to scrape"},"onlyMainContent":{"type":"boolean","default":true}},"required":["url"],"additionalProperties":false},"Input_browserbase_create_session":{"type":"object","properties":{"timeout":{"type":"integer","minimum":60,"maximum":900,"default":300,"description":"Session timeout in seconds (max 15 minutes). The reservation covers this duration."}},"additionalProperties":false},"Input_browserbase_get_session":{"type":"object","properties":{"session_id":{"type":"string","minLength":8,"description":"Session id returned by browserbase/create-session"}},"required":["session_id"],"additionalProperties":false},"Input_browserbase_release_session":{"type":"object","properties":{"session_id":{"type":"string","minLength":8},"project_id":{"type":"string","minLength":8,"description":"projectId returned by browserbase/create-session"}},"required":["session_id","project_id"],"additionalProperties":false},"Input_browser_use_run_task":{"type":"object","properties":{"task":{"type":"string","minLength":3,"maxLength":4000,"description":"What the browser agent should do"},"max_cost_usd":{"type":"number","minimum":0.01,"maximum":5,"default":0.25,"description":"Spending cap for this run, reserved from your balance and enforced by the upstream"}},"required":["task"],"additionalProperties":false},"Input_browser_use_get_run":{"type":"object","properties":{"run_id":{"type":"string","minLength":8,"description":"Run id returned by browser-use/run-task"}},"required":["run_id"],"additionalProperties":false},"Input_browser_use_cancel_run":{"type":"object","properties":{"run_id":{"type":"string","minLength":8}},"required":["run_id"],"additionalProperties":false},"Input_tavily_mcp_extract":{"type":"object","properties":{"urls":{"description":"List of URLs to extract content from","items":{"type":"string"},"type":"array","maxItems":5},"extract_depth":{"default":"basic","description":"Use 'advanced' for LinkedIn, protected sites, or tables/embedded content","enum":["basic","advanced"],"type":"string"},"include_images":{"default":false,"description":"Include images from pages","type":"boolean"},"format":{"default":"markdown","description":"Output format","enum":["markdown","text"],"type":"string"},"include_favicon":{"default":false,"description":"Include favicon URLs","type":"boolean"},"query":{"default":"","description":"Query to rerank content chunks by relevance","type":"string"}},"required":["urls"],"additionalProperties":false},"Input_fal_nano_banana_2":{"type":"object","properties":{"output_format":{"title":"Output Format","type":"string","enum":["jpeg","png","webp"],"default":"png","description":"The format of the generated image."},"limit_generations":{"title":"Limit Generations","type":"boolean","default":true,"description":"Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate and ignore any intermediate images generated by the model. This may affect generation quality."},"resolution":{"title":"Resolution","type":"string","enum":["0.5K","1K","2K","4K"],"default":"1K","description":"The resolution of the image to generate."},"aspect_ratio":{"type":"string","enum":["auto","21:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16","4:1","1:4","8:1","1:8"],"title":"Aspect Ratio","default":"auto","description":"The aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8. Use \"auto\" to let the model decide based on the prompt."},"enable_web_search":{"title":"Enable Web Search","type":"boolean","default":false,"description":"Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image."},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"thinking_level":{"type":"string","enum":["minimal","high"],"title":"Thinking Level","description":"When set, enables model thinking with the given level ('minimal' or 'high') and includes thoughts in the generation. Omit to disable."},"num_images":{"title":"Number of Images","type":"integer","maximum":4,"minimum":1,"default":1,"description":"The number of images to generate."},"safety_tolerance":{"title":"Safety Tolerance","type":"string","enum":["1","2","3","4","5","6"],"default":"4","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict."},"system_prompt":{"maxLength":50000,"type":"string","title":"System Prompt","default":"","description":"Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers)."},"prompt":{"maxLength":50000,"type":"string","minLength":3,"description":"The text prompt to generate an image from.","title":"Prompt"}},"required":["prompt"],"additionalProperties":false},"Input_fal_nano_banana_2_edit":{"type":"object","properties":{"resolution":{"title":"Resolution","type":"string","enum":["0.5K","1K","2K","4K"],"default":"1K","description":"The resolution of the image to generate."},"aspect_ratio":{"type":"string","enum":["auto","21:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16","4:1","1:4","8:1","1:8"],"title":"Aspect Ratio","default":"auto","description":"The aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8."},"num_images":{"title":"Number of Images","type":"integer","maximum":4,"minimum":1,"default":1,"description":"The number of images to generate."},"enable_web_search":{"title":"Enable Web Search","type":"boolean","default":false,"description":"Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image."},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"system_prompt":{"maxLength":50000,"type":"string","title":"System Prompt","default":"","description":"Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers)."},"pdf_url":{"type":"string","title":"PDF URL","description":"Optional PDF document to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB)."},"limit_generations":{"title":"Limit Generations","type":"boolean","default":true,"description":"Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate and ignore any intermediate images generated by the model. This may affect generation quality."},"image_urls":{"title":"Image URLs","type":"array","description":"The URLs of the images to use for image-to-image generation or image editing. Optional when at least one of `video_url`, `audio_url`, or `pdf_url` is provided.","items":{"type":"string"}},"output_format":{"title":"Output Format","type":"string","enum":["jpeg","png","webp"],"default":"png","description":"The format of the generated image."},"thinking_level":{"type":"string","enum":["minimal","high"],"title":"Thinking Level","description":"When set, enables model thinking with the given level ('minimal' or 'high') and includes thoughts in the generation. Omit to disable."},"video_url":{"type":"string","title":"Video URL","description":"Optional video to use as input context. Accepts an http(s)/data URL to a video file (downloaded and sent inline, max 15MB) or a YouTube URL (passed through to the model without downloading)."},"audio_url":{"type":"string","title":"Audio URL","description":"Optional audio file to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB)."},"safety_tolerance":{"title":"Safety Tolerance","type":"string","enum":["1","2","3","4","5","6"],"default":"4","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict."},"prompt":{"maxLength":50000,"type":"string","minLength":3,"description":"The prompt for image editing.","title":"Prompt"}},"required":["prompt"],"additionalProperties":false},"Input_fal_nano_banana_pro":{"type":"object","properties":{"prompt":{"description":"The text prompt to generate an image from.","maxLength":50000,"type":"string","minLength":3,"title":"Prompt"},"seed":{"type":"integer","description":"The seed for the random number generator.","title":"Seed"},"enable_web_search":{"description":"Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.","default":false,"type":"boolean","title":"Enable Web Search"},"system_prompt":{"description":"Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers).","maxLength":50000,"default":"","type":"string","title":"System Prompt"},"output_format":{"description":"The format of the generated image.","default":"png","type":"string","enum":["jpeg","png","webp"],"title":"Output Format"},"limit_generations":{"description":"Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.","default":true,"type":"boolean","title":"Limit Generations"},"num_images":{"maximum":4,"description":"The number of images to generate.","default":1,"type":"integer","minimum":1,"title":"Number of Images"},"resolution":{"description":"The resolution of the image to generate.","default":"1K","type":"string","enum":["1K","2K","4K"],"title":"Resolution"},"safety_tolerance":{"description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"],"title":"Safety Tolerance"},"aspect_ratio":{"type":"string","enum":["auto","21:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16"],"description":"The aspect ratio of the generated image.","default":"1:1","title":"Aspect Ratio"}},"required":["prompt"],"additionalProperties":false},"Input_fal_nano_banana_pro_edit":{"type":"object","properties":{"prompt":{"description":"The prompt for image editing.","maxLength":50000,"type":"string","minLength":3,"title":"Prompt"},"seed":{"type":"integer","description":"The seed for the random number generator.","title":"Seed"},"enable_web_search":{"description":"Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.","default":false,"type":"boolean","title":"Enable Web Search"},"system_prompt":{"description":"Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers).","maxLength":50000,"default":"","type":"string","title":"System Prompt"},"output_format":{"description":"The format of the generated image.","default":"png","type":"string","enum":["jpeg","png","webp"],"title":"Output Format"},"limit_generations":{"description":"Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.","default":true,"type":"boolean","title":"Limit Generations"},"image_urls":{"description":"The URLs of the images to use for image-to-image generation or image editing.","items":{"type":"string"},"type":"array","title":"Image URLs"},"num_images":{"maximum":4,"description":"The number of images to generate.","default":1,"type":"integer","minimum":1,"title":"Number of Images"},"resolution":{"description":"The resolution of the image to generate.","default":"1K","type":"string","enum":["1K","2K","4K"],"title":"Resolution"},"safety_tolerance":{"description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"],"title":"Safety Tolerance"},"aspect_ratio":{"type":"string","enum":["auto","21:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16"],"description":"The aspect ratio of the generated image.","default":"auto","title":"Aspect Ratio"}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_gpt_image_2":{"type":"object","properties":{"num_images":{"title":"Number of Images","maximum":4,"default":1,"type":"integer","description":"Number of images to generate","minimum":1},"prompt":{"title":"Prompt","minLength":2,"type":"string","description":"The prompt for image generation","maxLength":32000},"output_format":{"title":"Output Format","enum":["jpeg","png","webp"],"type":"string","description":"Output format for the images","default":"png"},"background":{"title":"Background","enum":["auto","transparent","opaque"],"type":"string","description":"Background for the generated image","default":"auto"},"quality":{"title":"Quality","enum":["low","medium","high"],"type":"string","description":"Quality for the generated image. Use 'auto' to let the model pick the best quality for the prompt.","default":"high"},"image_size":{"enum":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024","square_hd","1024x1024","1024x1536","1536x1024","1920x1080","1080x1920","2560x1440","1440x2560","3840x2160","2160x3840"],"type":"string","title":"Image Size","default":"landscape_4_3","description":"The size of the generated image. Supports preset names, explicit {width, height}, or 'auto' to let the model pick the best size. Concrete sizes must have both dimensions as multiples of 16, max edge 3840px, aspect ratio <= 3:1, total pixels between 655,360 and 8,294,400."}},"required":["prompt"],"additionalProperties":false},"Input_fal_gpt_image_2_edit":{"type":"object","properties":{"mask_url":{"type":"string","title":"Mask URL","description":"The URL of the mask image to use for the generation. This indicates what part of the image to edit."},"num_images":{"title":"Number of Images","maximum":4,"default":1,"type":"integer","description":"Number of images to generate","minimum":1},"image_urls":{"title":"Image URLs","maxItems":16,"items":{"type":"string"},"type":"array","description":"The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed."},"prompt":{"title":"Prompt","minLength":2,"type":"string","description":"The prompt for image generation","maxLength":32000},"background":{"title":"Background","enum":["auto","transparent","opaque"],"type":"string","description":"Background for the generated image","default":"auto"},"quality":{"title":"Quality","enum":["low","medium","high"],"type":"string","description":"Quality for the generated image. Use 'auto' to let the model pick the best quality for the prompt.","default":"high"},"output_format":{"title":"Output Format","enum":["jpeg","png","webp"],"type":"string","description":"Output format for the images","default":"png"},"image_size":{"enum":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024","square_hd","1024x1024","1024x1536","1536x1024","1920x1080","1080x1920","2560x1440","1440x2560","3840x2160","2160x3840"],"type":"string","title":"Image Size","description":"The size of the generated image. Use 'auto' to infer from input images.","default":"landscape_4_3"}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_gpt_image_1_5":{"type":"object","properties":{"num_images":{"type":"integer","default":1,"minimum":1,"title":"Number of Images","description":"Number of images to generate","maximum":4},"output_format":{"type":"string","default":"png","description":"Output format for the images","enum":["jpeg","png","webp"],"title":"Output Format"},"image_size":{"type":"string","default":"1024x1024","description":"Aspect ratio for the generated image","enum":["1024x1024","1536x1024","1024x1536"],"title":"Image Size"},"quality":{"type":"string","default":"high","description":"Quality for the generated image","enum":["low","medium","high"],"title":"Quality"},"background":{"type":"string","default":"auto","description":"Background for the generated image","enum":["auto","transparent","opaque"],"title":"Background"},"prompt":{"type":"string","maxLength":32000,"minLength":2,"description":"The prompt for image generation","title":"Prompt"}},"required":["prompt"],"additionalProperties":false},"Input_fal_gpt_image_1_5_edit":{"type":"object","properties":{"image_size":{"type":"string","default":"auto","description":"Aspect ratio for the generated image","enum":["auto","1024x1024","1536x1024","1024x1536"],"title":"Image Size"},"quality":{"type":"string","default":"high","description":"Quality for the generated image","enum":["low","medium","high"],"title":"Quality"},"mask_image_url":{"type":"string","description":"The URL of the mask image to use for the generation. This indicates what part of the image to edit.","title":"Mask Image URL"},"num_images":{"type":"integer","default":1,"minimum":1,"title":"Number of Images","description":"Number of images to generate","maximum":4},"input_fidelity":{"type":"string","default":"high","description":"Input fidelity for the generated image","enum":["low","high"],"title":"Input Fidelity"},"prompt":{"type":"string","maxLength":32000,"minLength":2,"description":"The prompt for image generation","title":"Prompt"},"background":{"type":"string","default":"auto","description":"Background for the generated image","enum":["auto","transparent","opaque"],"title":"Background"},"image_urls":{"type":"array","items":{"type":"string"},"description":"The URLs of the images to use as a reference for the generation.","title":"Image URLs"},"output_format":{"type":"string","default":"png","description":"Output format for the images","enum":["jpeg","png","webp"],"title":"Output Format"}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_seedream_5_pro":{"type":"object","properties":{"enable_safety_checker":{"default":true,"type":"boolean","title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked."},"prompt":{"type":"string","title":"Prompt","description":"The text prompt used to generate the image."},"image_size":{"type":"string","enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto_1K","auto_2K"],"description":"The size of the generated image. Total pixels must be between 1024x1024 and 2048x2048, with aspect ratio between 1/16 and 16.","x-fal":{"min_area":1048576,"max_area":4194304,"max_aspect_ratio":16,"min_aspect_ratio":0.0625},"title":"Image Size","default":"auto_2K"},"output_format":{"type":"string","default":"jpeg","enum":["jpeg","png"],"title":"Output Format","description":"The file format of the generated image."},"num_images":{"description":"Number of separate model generations to run with the prompt.","type":"integer","minimum":1,"maximum":6,"title":"Num Images","default":1}},"required":["prompt"],"additionalProperties":false},"Input_fal_seedream_5_pro_edit":{"type":"object","properties":{"enable_safety_checker":{"default":true,"type":"boolean","title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked."},"prompt":{"type":"string","title":"Prompt","description":"The text prompt used to edit the image."},"image_urls":{"description":"List of URLs of input reference images. Up to 10 images are supported; if more are sent, only the last 10 are used.","type":"array","items":{"type":"string"},"title":"Image URLs"},"image_size":{"type":"string","enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto_1K","auto_2K"],"description":"The size of the generated image. Total pixels must be between 1024x1024 and 2048x2048, with aspect ratio between 1/16 and 16.","x-fal":{"min_area":1048576,"max_area":4194304,"max_aspect_ratio":16,"min_aspect_ratio":0.0625},"title":"Image Size","default":"auto_2K"},"output_format":{"type":"string","default":"jpeg","enum":["jpeg","png"],"title":"Output Format","description":"The file format of the generated image."},"num_images":{"description":"Number of separate model generations to run with the prompt.","type":"integer","minimum":1,"maximum":6,"title":"Num Images","default":1}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_flux_2_pro":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt","description":"The prompt to generate an image from."},"enable_safety_checker":{"type":"boolean","default":true,"title":"Enable Safety Checker","description":"Whether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked."},"seed":{"type":"integer","title":"Seed","description":"The seed to use for the generation."},"image_size":{"type":"string","enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1280x720","720x1280","1536x1024","1024x1536","1536x1536","1920x1440","1440x1920","2560x1440","1440x2560"],"description":"The size of the generated image.","default":"landscape_4_3","x-fal":{"max_height":2560,"max_width":2560,"min_height":256,"min_width":256,"multiple_of":16,"max_area":4194304},"title":"Image Size"},"output_format":{"description":"The format of the generated image.","type":"string","default":"jpeg","title":"Output Format","enum":["jpeg","png"]},"safety_tolerance":{"description":"The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive.","default":"2","type":"string","title":"Safety Tolerance","enum":["1","2","3","4","5"]}},"required":["prompt"],"additionalProperties":false},"Input_fal_flux_2_max":{"type":"object","properties":{"output_format":{"default":"jpeg","title":"Output Format","enum":["jpeg","png"],"description":"The format of the generated image.","type":"string"},"safety_tolerance":{"default":"2","title":"Safety Tolerance","enum":["1","2","3","4","5"],"description":"The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive.","type":"string"},"seed":{"type":"integer","title":"Seed","description":"The seed to use for the generation."},"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1280x720","720x1280","1536x1024","1024x1536","1536x1536","1920x1440","1440x1920","2560x1440","1440x2560"],"type":"string","default":"landscape_4_3","x-fal":{"max_width":2560,"max_area":4194304,"min_height":256,"multiple_of":16,"min_width":256,"max_height":2560},"title":"Image Size","description":"The size of the generated image."},"enable_safety_checker":{"default":true,"title":"Enable Safety Checker","description":"Whether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked.","type":"boolean"},"prompt":{"title":"Prompt","description":"The prompt to generate an image from.","type":"string"}},"required":["prompt"],"additionalProperties":false},"Input_fal_flux_2_flash":{"type":"object","properties":{"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1536x1024","1024x1536","1536x1536","1920x1440","1440x1920","2048x1152","1152x2048","2048x2048"],"type":"string","title":"Image Size","default":"landscape_4_3","description":"The size of the image to generate. The width and height must be between 512 and 2048 pixels."},"prompt":{"description":"The prompt to generate an image from.","title":"Prompt","type":"string"},"output_format":{"enum":["jpeg","png","webp"],"title":"Output Format","default":"png","description":"The format of the generated image.","type":"string"},"enable_prompt_expansion":{"title":"Enable Prompt Expansion","default":false,"description":"If set to true, the prompt will be expanded for better results.","type":"boolean"},"seed":{"type":"integer","title":"Seed","description":"The seed to use for the generation. If not provided, a random seed will be used."},"guidance_scale":{"maximum":20,"default":2.5,"title":"Guidance Scale","type":"number","minimum":0,"description":"Guidance Scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you."},"num_images":{"maximum":4,"default":1,"title":"Number of Images","type":"integer","minimum":1,"description":"The number of images to generate."},"enable_safety_checker":{"title":"Enable Safety Checker","default":true,"description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images.","type":"boolean"}},"required":["prompt"],"additionalProperties":false},"Input_fal_flux_2_pro_edit":{"type":"object","properties":{"seed":{"type":"integer","title":"Seed","description":"The seed to use for the generation."},"enable_safety_checker":{"type":"boolean","default":true,"title":"Enable Safety Checker","description":"Whether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked."},"image_urls":{"description":"List of URLs of input images for editing","type":"array","title":"Image URLs","items":{"type":"string"}},"image_size":{"type":"string","enum":["auto","square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"default":"auto","title":"Image Size","description":"The size of the generated image. If `auto`, the size will be determined by the model."},"prompt":{"type":"string","title":"Prompt","description":"The prompt to generate an image from."},"output_format":{"description":"The format of the generated image.","type":"string","default":"jpeg","title":"Output Format","enum":["jpeg","png"]},"safety_tolerance":{"description":"The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive.","default":"2","type":"string","title":"Safety Tolerance","enum":["1","2","3","4","5"]}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_flux_2_max_edit":{"type":"object","properties":{"image_size":{"enum":["auto","square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string","default":"auto","title":"Image Size","description":"The size of the generated image. If `auto`, the size will be determined by the model."},"prompt":{"title":"Prompt","description":"The prompt to generate an image from.","type":"string"},"image_urls":{"type":"array","title":"Image URLs","description":"List of URLs of input images for editing","items":{"type":"string"}},"safety_tolerance":{"default":"2","title":"Safety Tolerance","enum":["1","2","3","4","5"],"description":"The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive.","type":"string"},"output_format":{"default":"jpeg","title":"Output Format","enum":["jpeg","png"],"description":"The format of the generated image.","type":"string"},"enable_safety_checker":{"default":true,"title":"Enable Safety Checker","description":"Whether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked.","type":"boolean"},"seed":{"type":"integer","title":"Seed","description":"The seed to use for the generation."},"max_megapixels":{"type":"number","minimum":1,"maximum":40,"default":6,"description":"Upper bound of the processed megapixels, input images and output together, in megapixels (default 6, max 40). The reservation is this bound at the unit price; after the call the megapixels fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_flux_2_pro_outpaint":{"type":"object","properties":{"enable_safety_checker":{"type":"boolean","default":true,"title":"Enable Safety Checker","description":"Whether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked."},"mode":{"description":"Quality/speed trade-off for outpainting. `high` (default) delivers the highest-fidelity results; `fast` is significantly faster and extends most scenes well but may produce lower fidelity.","type":"string","default":"high","title":"Mode","enum":["high","fast"]},"expand_bottom":{"default":0,"maximum":2048,"minimum":0,"type":"integer","title":"Expand Bottom","description":"Pixels to expand at the bottom of the image."},"expand_top":{"default":0,"maximum":2048,"minimum":0,"type":"integer","title":"Expand Top","description":"Pixels to expand at the top of the image."},"expand_right":{"default":0,"maximum":2048,"minimum":0,"type":"integer","title":"Expand Right","description":"Pixels to expand on the right of the image."},"output_format":{"description":"The format of the generated image.","type":"string","default":"jpeg","title":"Output Format","enum":["jpeg","png"]},"image_url":{"type":"string","title":"Image URL","description":"The image URL to expand using outpainting."},"expand_left":{"default":0,"maximum":2048,"minimum":0,"type":"integer","title":"Expand Left","description":"Pixels to expand on the left of the image."},"auto_crop":{"type":"boolean","default":false,"title":"Auto Crop","description":"Whether to automatically crop the reference image when the expanded canvas does not fully contain it."},"max_megapixels":{"type":"number","minimum":1,"maximum":40,"default":6,"description":"Upper bound of the megapixels of input and output together, in megapixels (default 6, max 40). The reservation is this bound at the unit price; after the call the megapixels fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["image_url"],"additionalProperties":false},"Input_fal_ideogram_v3":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt"},"style":{"type":"string","enum":["AUTO","GENERAL","REALISTIC","DESIGN"],"description":"The style type to generate with. Cannot be used with style_codes.","title":"Style"},"image_urls":{"type":"array","items":{"type":"string"},"description":"A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format","title":"Image Urls"},"color_palette":{"properties":{"members":{"anyOf":[{"type":"array","items":{"required":["rgb"],"properties":{"color_weight":{"anyOf":[{"maximum":1,"type":"number","minimum":0.05},{"type":"null"}],"description":"The weight of the color in the color palette","default":0.5,"title":"Color Weight"},"rgb":{"properties":{"r":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Red color value","title":"R"},"g":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Green color value","title":"G"},"b":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Blue color value","title":"B"}},"type":"object","x-fal-order-properties":["r","g","b"],"title":"RGBColor"}},"type":"object","x-fal-order-properties":["rgb","color_weight"],"title":"ColorPaletteMember"}},{"type":"null"}],"description":"A list of color palette members that define the color palette","title":"Members"},"name":{"anyOf":[{"type":"string","enum":["EMBER","FRESH","JUNGLE","MAGIC","MELON","MOSAIC","PASTEL","ULTRAMARINE"]},{"type":"null"}],"description":"A color palette preset value","title":"Name"}},"type":"object","x-fal-order-properties":["members","name"],"title":"ColorPalette","description":"A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)"},"expand_prompt":{"type":"boolean","description":"Determine if MagicPrompt should be used in generating the request or not.","default":true,"title":"Expand Prompt"},"negative_prompt":{"type":"string","description":"Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt.","default":"","title":"Negative Prompt"},"image_size":{"type":"string","enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"description":"The resolution of the generated image","default":"square_hd","title":"Image Size"},"rendering_speed":{"type":"string","enum":["TURBO","BALANCED","QUALITY"],"default":"BALANCED","description":"The rendering speed to use.","title":"Rendering Speed"},"style_codes":{"type":"array","items":{"type":"string"},"description":"A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style","title":"Style Codes"},"seed":{"type":"integer","description":"Seed for the random number generator","title":"Seed"},"num_images":{"maximum":8,"type":"integer","minimum":1,"default":1,"description":"Number of images to generate.","title":"Num Images"},"style_preset":{"type":"string","enum":["80S_ILLUSTRATION","90S_NOSTALGIA","ABSTRACT_ORGANIC","ANALOG_NOSTALGIA","ART_BRUT","ART_DECO","ART_POSTER","AURA","AVANT_GARDE","BAUHAUS","BLUEPRINT","BLURRY_MOTION","BRIGHT_ART","C4D_CARTOON","CHILDRENS_BOOK","COLLAGE","COLORING_BOOK_I","COLORING_BOOK_II","CUBISM","DARK_AURA","DOODLE","DOUBLE_EXPOSURE","DRAMATIC_CINEMA","EDITORIAL","EMOTIONAL_MINIMAL","ETHEREAL_PARTY","EXPIRED_FILM","FLAT_ART","FLAT_VECTOR","FOREST_REVERIE","GEO_MINIMALIST","GLASS_PRISM","GOLDEN_HOUR","GRAFFITI_I","GRAFFITI_II","HALFTONE_PRINT","HIGH_CONTRAST","HIPPIE_ERA","ICONIC","JAPANDI_FUSION","JAZZY","LONG_EXPOSURE","MAGAZINE_EDITORIAL","MINIMAL_ILLUSTRATION","MIXED_MEDIA","MONOCHROME","NIGHTLIFE","OIL_PAINTING","OLD_CARTOONS","PAINT_GESTURE","POP_ART","RETRO_ETCHING","RIVIERA_POP","SPOTLIGHT_80S","STYLIZED_RED","SURREAL_COLLAGE","TRAVEL_POSTER","VINTAGE_GEO","VINTAGE_POSTER","WATERCOLOR","WEIRD","WOODBLOCK_PRINT"],"description":"Style preset for generation. The chosen style preset will guide the generation.","title":"Style Preset"}},"required":["prompt"],"additionalProperties":false},"Input_fal_ideogram_v3_replace_background":{"type":"object","properties":{"prompt":{"type":"string","description":"Cyber punk city with neon lights and skyscrappers","title":"Prompt"},"style":{"type":"string","enum":["AUTO","GENERAL","REALISTIC","DESIGN"],"description":"The style type to generate with. Cannot be used with style_codes.","title":"Style"},"image_url":{"type":"string","description":"The image URL whose background needs to be replaced","title":"Image URL"},"color_palette":{"properties":{"members":{"anyOf":[{"type":"array","items":{"required":["rgb"],"properties":{"color_weight":{"anyOf":[{"maximum":1,"type":"number","minimum":0.05},{"type":"null"}],"description":"The weight of the color in the color palette","default":0.5,"title":"Color Weight"},"rgb":{"properties":{"r":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Red color value","title":"R"},"g":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Green color value","title":"G"},"b":{"maximum":255,"type":"integer","minimum":0,"default":0,"description":"Blue color value","title":"B"}},"type":"object","x-fal-order-properties":["r","g","b"],"title":"RGBColor"}},"type":"object","x-fal-order-properties":["rgb","color_weight"],"title":"ColorPaletteMember"}},{"type":"null"}],"description":"A list of color palette members that define the color palette","title":"Members"},"name":{"anyOf":[{"type":"string","enum":["EMBER","FRESH","JUNGLE","MAGIC","MELON","MOSAIC","PASTEL","ULTRAMARINE"]},{"type":"null"}],"description":"A color palette preset value","title":"Name"}},"type":"object","x-fal-order-properties":["members","name"],"title":"ColorPalette","description":"A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)"},"expand_prompt":{"type":"boolean","description":"Determine if MagicPrompt should be used in generating the request or not.","default":true,"title":"Expand Prompt"},"image_urls":{"type":"array","items":{"type":"string"},"description":"A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format","title":"Image Urls"},"rendering_speed":{"type":"string","enum":["TURBO","BALANCED","QUALITY"],"default":"BALANCED","description":"The rendering speed to use.","title":"Rendering Speed"},"style_codes":{"type":"array","items":{"type":"string"},"description":"A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style","title":"Style Codes"},"seed":{"type":"integer","description":"Seed for the random number generator","title":"Seed"},"num_images":{"maximum":8,"type":"integer","minimum":1,"default":1,"description":"Number of images to generate.","title":"Num Images"},"style_preset":{"type":"string","enum":["80S_ILLUSTRATION","90S_NOSTALGIA","ABSTRACT_ORGANIC","ANALOG_NOSTALGIA","ART_BRUT","ART_DECO","ART_POSTER","AURA","AVANT_GARDE","BAUHAUS","BLUEPRINT","BLURRY_MOTION","BRIGHT_ART","C4D_CARTOON","CHILDRENS_BOOK","COLLAGE","COLORING_BOOK_I","COLORING_BOOK_II","CUBISM","DARK_AURA","DOODLE","DOUBLE_EXPOSURE","DRAMATIC_CINEMA","EDITORIAL","EMOTIONAL_MINIMAL","ETHEREAL_PARTY","EXPIRED_FILM","FLAT_ART","FLAT_VECTOR","FOREST_REVERIE","GEO_MINIMALIST","GLASS_PRISM","GOLDEN_HOUR","GRAFFITI_I","GRAFFITI_II","HALFTONE_PRINT","HIGH_CONTRAST","HIPPIE_ERA","ICONIC","JAPANDI_FUSION","JAZZY","LONG_EXPOSURE","MAGAZINE_EDITORIAL","MINIMAL_ILLUSTRATION","MIXED_MEDIA","MONOCHROME","NIGHTLIFE","OIL_PAINTING","OLD_CARTOONS","PAINT_GESTURE","POP_ART","RETRO_ETCHING","RIVIERA_POP","SPOTLIGHT_80S","STYLIZED_RED","SURREAL_COLLAGE","TRAVEL_POSTER","VINTAGE_GEO","VINTAGE_POSTER","WATERCOLOR","WEIRD","WOODBLOCK_PRINT"],"description":"Style preset for generation. The chosen style preset will guide the generation.","title":"Style Preset"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_recraft_v4_1_pro":{"type":"object","properties":{"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string","title":"Image Size","default":"square_hd"},"prompt":{"title":"Prompt","type":"string","minLength":1,"maxLength":10000},"colors":{"title":"Colors","items":{"properties":{"r":{"title":"R","description":"Red color value","type":"integer","default":0,"minimum":0,"maximum":255},"g":{"title":"G","description":"Green color value","type":"integer","default":0,"minimum":0,"maximum":255},"b":{"title":"B","description":"Blue color value","type":"integer","default":0,"minimum":0,"maximum":255}},"title":"RGBColor","type":"object","x-fal-order-properties":["r","g","b"]},"description":"An array of preferable colors","type":"array","default":[]},"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.","type":"boolean","default":true},"background_color":{"properties":{"r":{"title":"R","description":"Red color value","type":"integer","default":0,"minimum":0,"maximum":255},"g":{"title":"G","description":"Green color value","type":"integer","default":0,"minimum":0,"maximum":255},"b":{"title":"B","description":"Blue color value","type":"integer","default":0,"minimum":0,"maximum":255}},"title":"RGBColor","type":"object","x-fal-order-properties":["r","g","b"],"description":"The preferable background color of the generated images."}},"required":["prompt"],"additionalProperties":false},"Input_fal_recraft_v4_1_pro_vector":{"type":"object","properties":{"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string","title":"Image Size","default":"square_hd"},"prompt":{"title":"Prompt","type":"string","minLength":1,"maxLength":10000},"colors":{"title":"Colors","items":{"properties":{"r":{"title":"R","description":"Red color value","type":"integer","default":0,"minimum":0,"maximum":255},"g":{"title":"G","description":"Green color value","type":"integer","default":0,"minimum":0,"maximum":255},"b":{"title":"B","description":"Blue color value","type":"integer","default":0,"minimum":0,"maximum":255}},"title":"RGBColor","type":"object","x-fal-order-properties":["r","g","b"]},"description":"An array of preferable colors","type":"array","default":[]},"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.","type":"boolean","default":true},"background_color":{"properties":{"r":{"title":"R","description":"Red color value","type":"integer","default":0,"minimum":0,"maximum":255},"g":{"title":"G","description":"Green color value","type":"integer","default":0,"minimum":0,"maximum":255},"b":{"title":"B","description":"Blue color value","type":"integer","default":0,"minimum":0,"maximum":255}},"title":"RGBColor","type":"object","x-fal-order-properties":["r","g","b"],"description":"The preferable background color of the generated images."}},"required":["prompt"],"additionalProperties":false},"Input_fal_recraft_vectorize":{"type":"object","properties":{"image_url":{"title":"Image Url","description":"The URL of the image to be vectorized. Must be in PNG, JPG or WEBP format, less than 5 MB in size, have resolution less than 16 MP and max dimension less than 4096 pixels, min dimension more than 256 pixels.","_fal_ui_field":"image","type":"string"}},"required":["image_url"],"additionalProperties":false},"Input_fal_reve_2_1":{"type":"object","properties":{"num_images":{"description":"Number of images to generate","minimum":1,"default":1,"maximum":4,"type":"integer","title":"Number of Images"},"aspect_ratio":{"description":"The desired aspect ratio of the generated image. With `auto`, the model picks an appropriate aspect ratio for the request.","enum":["4:1","3:1","21:9","2:1","17:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16","1:2","1:3","1:4","auto"],"title":"Aspect Ratio","default":"auto","type":"string"},"prompt":{"description":"The text description of the desired image.","maxLength":4000,"title":"Prompt","type":"string","minLength":1},"output_format":{"description":"Output format for the generated image.","enum":["png","jpeg","webp"],"title":"Output Format","default":"png","type":"string"}},"required":["prompt"],"additionalProperties":false},"Input_fal_reve_2_1_edit":{"type":"object","properties":{"num_images":{"description":"Number of images to generate","minimum":1,"default":1,"maximum":4,"type":"integer","title":"Number of Images"},"image_url":{"description":"URL of the reference image to edit. Must be publicly accessible or base64 data URI. Supports PNG, JPEG, WebP, AVIF, and HEIF formats.","_fal_ui_field":"image","min_height":128,"min_width":128,"max_width":4096,"max_file_size":10485760,"type":"string","max_height":4096,"title":"Reference Image URL"},"prompt":{"description":"The text description of how to edit the provided image. You can refer to the reference image with `<frame>0</frame>`.","maxLength":4000,"title":"Prompt","type":"string","minLength":1},"aspect_ratio":{"description":"The desired aspect ratio of the generated image. With `auto`, the model picks an appropriate aspect ratio for the request.","enum":["4:1","3:1","21:9","2:1","17:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16","1:2","1:3","1:4","auto"],"title":"Aspect Ratio","default":"auto","type":"string"},"output_format":{"description":"Output format for the generated image.","enum":["png","jpeg","webp"],"title":"Output Format","default":"png","type":"string"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_qwen_image_3":{"type":"object","properties":{"num_images":{"title":"Num Images","default":1,"maximum":6,"type":"integer","description":"The number of images to generate.","minimum":1},"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string","title":"Image Size","default":"square_hd","description":"The size of the generated image. Total number of pixels must be between 512x512 and 2048x2048."},"enable_prompt_expansion":{"title":"Enable Prompt Expansion","default":true,"description":"Enable automatic LLM prompt rewriting for better results.","type":"boolean"},"seed":{"type":"integer","title":"Seed","description":"Random seed for reproducibility (0-2147483647)."},"prompt":{"title":"Prompt","minLength":1,"maxLength":5000,"description":"Text prompt describing the desired image. Supports Chinese and English. Max 5000 characters.","type":"string"},"negative_prompt":{"maxLength":500,"type":"string","title":"Negative Prompt","default":"","description":"Content to avoid in the generated image. Max 500 characters."},"output_format":{"title":"Output Format","enum":["jpeg","png","webp"],"type":"string","description":"The format of the generated image.","default":"png"},"enable_safety_checker":{"title":"Enable Safety Checker","type":"boolean","description":"Enable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked.","default":true}},"required":["prompt"],"additionalProperties":false},"Input_fal_qwen_image_3_edit":{"type":"object","properties":{"num_images":{"title":"Num Images","default":1,"maximum":6,"type":"integer","description":"The number of images to generate.","minimum":1},"image_size":{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string","title":"Image Size","description":"The size of the generated image. If not provided, the model determines the resolution automatically. Total number of pixels must be between 512x512 and 2048x2048."},"enable_prompt_expansion":{"title":"Enable Prompt Expansion","default":true,"description":"Enable automatic LLM prompt rewriting for better results.","type":"boolean"},"seed":{"type":"integer","title":"Seed","description":"Random seed for reproducibility (0-2147483647)."},"prompt":{"title":"Prompt","minLength":1,"maxLength":5000,"description":"Text prompt describing the desired edit. Supports Chinese and English. Max 5000 characters.","type":"string"},"image_urls":{"title":"Image Urls","items":{"type":"string"},"type":"array","description":"Reference images for editing (1-3 images required). Order matters: reference as 'image 1', 'image 2', 'image 3' in prompt. Resolution: 384-2048px each dimension. Max size: 10MB each. Formats: JPEG, JPG, PNG (no alpha), WEBP."},"negative_prompt":{"maxLength":500,"type":"string","title":"Negative Prompt","default":"","description":"Content to avoid in the generated image. Max 500 characters."},"output_format":{"title":"Output Format","enum":["jpeg","png","webp"],"type":"string","description":"The format of the generated image.","default":"png"},"enable_safety_checker":{"title":"Enable Safety Checker","type":"boolean","description":"Enable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked.","default":true}},"required":["prompt","image_urls"],"additionalProperties":false},"Input_fal_grok_imagine_image_2":{"type":"object","properties":{"aspect_ratio":{"description":"Aspect ratio of the generated image.","default":"1:1","type":"string","enum":["2:1","20:9","19.5:9","16:9","4:3","3:2","1:1","2:3","3:4","9:16","9:19.5","9:20","1:2"],"title":"Aspect Ratio"},"resolution":{"description":"Resolution of the generated image. `1k` for standard resolution, `2k` for high resolution.","default":"1k","type":"string","enum":["1k","2k"],"title":"Resolution"},"num_images":{"maximum":4,"description":"Number of images to generate.","default":1,"type":"integer","minimum":1,"title":"Number of Images"},"quality":{"description":"Quality level of the generated image.","default":"medium","type":"string","enum":["low","medium"],"title":"Quality"},"output_format":{"description":"The format of the generated image.","default":"jpeg","type":"string","enum":["jpeg","png","webp"],"title":"Output Format"},"prompt":{"description":"Text description of the desired image.","maxLength":8000,"type":"string","title":"Prompt"}},"required":["prompt"],"additionalProperties":false},"Input_fal_grok_imagine_image_2_edit":{"type":"object","properties":{"prompt":{"description":"Text description of the desired image.","maxLength":8000,"type":"string","title":"Prompt"},"image_urls":{"items":{"type":"string"},"description":"List of URLs of the images to edit. A maximum of 3 images are supported.","type":"array","title":"Image URLs"},"num_images":{"maximum":4,"description":"Number of images to generate.","default":1,"type":"integer","minimum":1,"title":"Number of Images"},"quality":{"description":"Quality level of the edited image.","default":"medium","type":"string","enum":["low","medium"],"title":"Quality"},"output_format":{"description":"The format of the generated image.","default":"jpeg","type":"string","enum":["jpeg","png","webp"],"title":"Output Format"},"resolution":{"description":"Resolution of the generated image. `1k` for standard resolution, `2k` for high resolution.","default":"1k","type":"string","enum":["1k","2k"],"title":"Resolution"},"aspect_ratio":{"description":"Aspect ratio of the edited image. When set to `auto` (the default), the output preserves the aspect ratio of the first input image.","default":"auto","type":"string","enum":["auto","2:1","20:9","19.5:9","16:9","4:3","3:2","1:1","2:3","3:4","9:16","9:19.5","9:20","1:2"],"title":"Aspect Ratio"}},"required":["prompt"],"additionalProperties":false},"Input_fal_luma_uni_1_max":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt","description":"Text prompt describing the image to generate.","minLength":1,"maxLength":6000},"reference_image_urls":{"type":"array","items":{"type":"string"},"maxItems":9,"title":"Reference Image Urls","description":"Optional list of reference image URLs used to guide the generation."},"output_format":{"type":"string","enum":["png","jpeg"],"title":"Output Format","description":"Encoding format of the generated image."},"aspect_ratio":{"type":"string","enum":["3:1","2:1","16:9","3:2","1:1","2:3","9:16","1:2","1:3"],"title":"Aspect Ratio","description":"Aspect ratio of the generated image."},"style":{"type":"string","title":"Style","default":"auto","enum":["auto","manga"],"description":"Visual style of the generated image."},"enable_web_search":{"type":"boolean","title":"Enable Web Search","default":false,"description":"When true, the model may consult the web for references."}},"required":["prompt"],"additionalProperties":false},"Input_fal_luma_uni_1_max_edit":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt","description":"Text prompt describing the edit to apply.","minLength":1,"maxLength":6000},"reference_image_urls":{"type":"array","items":{"type":"string"},"maxItems":8,"title":"Reference Image Urls","description":"Optional list of reference image URLs used to guide the edit."},"image_url":{"type":"string","title":"Image Url","description":"URL of the source image to edit."},"output_format":{"type":"string","enum":["png","jpeg"],"title":"Output Format","description":"Encoding format of the edited image."},"style":{"type":"string","title":"Style","default":"auto","enum":["auto","manga"],"description":"Visual style of the edited image."}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_hunyuan_image_3":{"type":"object","properties":{"enable_prompt_expansion":{"description":"If set to true, the prompt will be expanded through the model's internal recaptioning step.","type":"boolean","default":true,"title":"Enable Prompt Expansion"},"enable_safety_checker":{"description":"If set to true, the safety checker will be enabled.","type":"boolean","default":true,"title":"Enable Safety Checker"},"num_images":{"description":"The number of images to generate.","type":"integer","default":1,"minimum":1,"maximum":4,"title":"Num Images"},"prompt":{"description":"The text prompt to generate an image from.","type":"string","title":"Prompt"},"output_format":{"description":"The format of the generated image.","type":"string","default":"png","enum":["jpeg","png"],"title":"Output Format"},"image_size":{"type":"string","enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"description":"The desired size of the generated image. If auto, image size will be determined by the model.","title":"Image Size","default":"square_hd"},"seed":{"type":"integer","description":"Random seed for reproducible results. If None, a random seed is used.","title":"Seed"},"guidance_scale":{"exclusiveMinimum":1,"type":"number","default":3.5,"maximum":20,"description":"Controls how much the model adheres to the prompt. Higher values mean stricter adherence.","title":"Guidance Scale"}},"required":["prompt"],"additionalProperties":false},"Input_fal_birefnet_v2":{"type":"object","properties":{"refine_foreground":{"description":"Whether to refine the foreground using the estimated mask","title":"Refine Foreground","type":"boolean","default":true},"image_url":{"description":"URL of the image to remove background from","type":"string","title":"Image Url","_fal_ui_field":"image"},"output_mask":{"description":"Whether to output the mask used to remove the background","title":"Output Mask","type":"boolean","default":false},"output_format":{"description":"The format of the output image","enum":["webp","png","gif"],"type":"string","title":"Output Format","default":"png"},"mask_only":{"description":"Whether to return only the segmentation mask without applying it to the image. When set to `True`, only the mask will be returned and foreground refinement will be skipped. Useful for reducing computation and data transfer when only the mask is needed.","title":"Mask Only","type":"boolean","default":false},"model":{"description":"\n            Model to use for background removal.\n            The 'General Use (Light)' model is the original model used in the BiRefNet repository.\n            The 'General Use (Light 2K)' model is the original model used in the BiRefNet repository but trained with 2K images.\n            The 'General Use (Heavy)' model is a slower but more accurate model.\n            The 'Matting' model is a model trained specifically for matting images.\n            The 'Portrait' model is a model trained specifically for portrait images.\n            The 'General Use (Dynamic)' model supports dynamic resolutions from 256x256 to 2304x2304.\n            The 'General Use (Light)' model is recommended for most use cases.\n\n            The corresponding models are as follows:\n            - 'General Use (Light)': BiRefNet\n            - 'General Use (Light 2K)': BiRefNet_lite-2K\n            - 'General Use (Heavy)': BiRefNet_lite\n            - 'Matting': BiRefNet-matting\n            - 'Portrait': BiRefNet-portrait\n            - 'General Use (Dynamic)': BiRefNet_dynamic\n        ","enum":["General Use (Light)","General Use (Light 2K)","General Use (Heavy)","Matting","Portrait","General Use (Dynamic)"],"type":"string","title":"Model","default":"General Use (Light)"},"operating_resolution":{"description":"The resolution to operate on. The higher the resolution, the more accurate the output will be for high res input images. The '2304x2304' option is only available for the 'General Use (Dynamic)' model.","enum":["1024x1024","2048x2048","2304x2304"],"type":"string","title":"Operating Resolution","default":"1024x1024"}},"required":["image_url"],"additionalProperties":false},"Input_fal_bria_background_remove":{"type":"object","properties":{"image_url":{"type":"string","title":"Image Url","description":"Input Image to erase from"}},"required":["image_url"],"additionalProperties":false},"Input_fal_topaz_upscale_precision":{"type":"object","properties":{"model":{"description":"Precision upscaling model. Standard V2 fits most photos; High Fidelity V3/V2 preserve detail in professional shots; Low Resolution V2 recovers compressed sources; CGI targets art and rendered graphics; Text Refine keeps text and shapes crisp.","type":"string","default":"Standard V2","title":"Model","enum":["Standard V2","High Fidelity V3","High Fidelity V2","Low Resolution V2","CGI","Text Refine"]},"fix_compression":{"maximum":1,"type":"number","minimum":0,"description":"Compression artifact removal level (0.0-1.0). Not supported by the CGI model.","title":"Fix Compression"},"strength":{"maximum":1,"type":"number","minimum":0.01,"description":"Enhancement strength (0.01-1.0). Applies to Text Refine model only.","title":"Strength"},"sharpen":{"maximum":1,"type":"number","minimum":0,"description":"Sharpening level (0.0-1.0). Default varies by model.","title":"Sharpen"},"denoise":{"maximum":1,"type":"number","minimum":0,"description":"Denoising level (0.0-1.0). Default varies by model.","title":"Denoise"},"face_enhancement_creativity":{"description":"Creativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled.","maximum":1,"default":0,"minimum":0,"type":"number","title":"Face Enhancement Creativity"},"output_format":{"description":"Output format of the upscaled image.","type":"string","default":"jpeg","enum":["jpeg","png"],"title":"Output Format"},"upscale_factor":{"description":"Factor to upscale the image by (e.g. 2.0 doubles width and height)","maximum":4,"default":2,"minimum":1,"title":"Upscale Factor","type":"number"},"face_enhancement_strength":{"description":"Strength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled.","maximum":1,"default":0.8,"minimum":0,"type":"number","title":"Face Enhancement Strength"},"subject_detection":{"description":"Subject detection mode for the image enhancement.","type":"string","default":"All","enum":["All","Foreground","Background"],"title":"Subject Detection"},"face_enhancement":{"description":"Whether to apply face enhancement to the image.","type":"boolean","default":true,"title":"Face Enhancement"},"crop_to_fill":{"type":"boolean","default":false,"title":"Crop To Fill"},"image_url":{"description":"Url of the image to be upscaled","type":"string","minLength":1,"title":"Image Url"},"max_megapixels":{"type":"number","minimum":1,"maximum":240,"default":24,"description":"Upper bound of the output megapixels, in megapixels (default 24, max 240). The reservation is this bound at the unit price; after the call the megapixels fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["image_url"],"additionalProperties":false},"Input_fal_clarity_upscaler":{"type":"object","properties":{"guidance_scale":{"title":"Guidance scale (CFG)","description":"\n            The CFG (Classifier Free Guidance) scale is a measure of how close you want\n            the model to stick to your prompt when looking for a related image to show you.\n        ","minimum":0,"default":4,"type":"number","maximum":20},"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to false, the safety checker will be disabled.","default":true,"type":"boolean"},"negative_prompt":{"description":"The negative prompt to use. Use it to address details that you don't want in the image.","title":"Negative Prompt","default":"(worst quality, low quality, normal quality:2)","type":"string"},"image_url":{"description":"The URL of the image to upscale.","title":"Image Url","type":"string"},"upscale_factor":{"title":"Upscale Factor","description":"The upscale factor","minimum":1,"default":2,"type":"number","maximum":4},"creativity":{"title":"Creativity","description":"\n            The creativity of the model. The higher the creativity, the more the model will deviate from the prompt.\n            Refers to the denoise strength of the sampling.\n        ","minimum":0,"default":0.35,"type":"number","maximum":1},"prompt":{"description":"The prompt to use for generating the image. Be as descriptive as possible for best results.","title":"Prompt","default":"masterpiece, best quality, highres","type":"string"},"seed":{"minimum":0,"type":"integer","title":"Seed","description":"\n            The same seed and the same prompt given to the same version of Stable Diffusion\n            will output the same image every time.\n        "},"resemblance":{"title":"Resemblance","description":"\n            The resemblance of the upscaled image to the original image. The higher the resemblance, the more the model will try to keep the original image.\n            Refers to the strength of the ControlNet.\n        ","minimum":0,"default":0.6,"type":"number","maximum":1},"num_inference_steps":{"title":"Num Inference Steps","description":"The number of inference steps to perform.","minimum":4,"default":18,"type":"integer","maximum":50}},"required":["image_url"],"additionalProperties":false},"Input_fal_seedance_2_5_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"The aspect ratio of the generated video. Use 16:9 for landscape, 9:16 for portrait/vertical, 1:1 for square, 21:9 for ultrawide cinematic, or auto to let the model decide.","type":"string","title":"Aspect Ratio","enum":["auto","21:9","16:9","4:3","1:1","3:4","9:16"],"default":"auto"},"duration":{"description":"Duration of the video in seconds. Supports 4 to 30 seconds, or auto to let the model decide based on the prompt.","type":"string","title":"Duration","enum":["4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30"],"default":"5"},"bitrate_mode":{"description":"Output bitrate mode. 'high' requests a higher-quality, larger-file encode from the model; 'standard' uses the default bitrate.","type":"string","title":"Bitrate Mode","enum":["standard","high"],"default":"standard"},"prompt":{"type":"string","title":"Prompt","description":"The text prompt used to generate the video"},"generate_audio":{"description":"Whether to generate synchronized audio for the video, including sound effects, ambient sounds, and lip-synced speech. The cost of video generation is the same regardless of whether audio is generated or not.","type":"boolean","title":"Generate Audio","default":true},"end_user_id":{"type":"string","title":"End User Id","description":"The unique user ID of the end user."},"resolution":{"description":"Video resolution - 480p for faster generation, 720p for balance, 1080p for high quality.","type":"string","title":"Resolution","enum":["480p","720p","1080p"],"default":"720p"}},"required":["prompt"],"additionalProperties":false},"Input_fal_seedance_2_5_image_to_video":{"type":"object","properties":{"end_image_url":{"type":"string","title":"End Image Url","description":"The URL of the image to use as the last frame of the video. When provided, the generated video will transition from the starting image to this ending image. Supported formats: JPEG, PNG, WebP. Max 30 MB."},"prompt":{"type":"string","title":"Prompt","description":"The text prompt describing the desired motion and action for the video."},"duration":{"description":"Duration of the video in seconds. Supports 4 to 30 seconds, or auto to let the model decide based on the prompt.","type":"string","title":"Duration","enum":["4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30"],"default":"5"},"end_user_id":{"type":"string","title":"End User Id","description":"The unique user ID of the end user."},"aspect_ratio":{"default":"auto","type":"string","description":"The aspect ratio of the generated video. Always \"auto\" for image-to-video","title":"Aspect Ratio","const":"auto","enum":["auto","21:9","16:9","4:3","1:1","3:4","9:16"]},"bitrate_mode":{"description":"Output bitrate mode. 'high' requests a higher-quality, larger-file encode from the model; 'standard' uses the default bitrate.","type":"string","title":"Bitrate Mode","enum":["standard","high"],"default":"standard"},"generate_audio":{"description":"Whether to generate synchronized audio for the video, including sound effects, ambient sounds, and lip-synced speech. The cost of video generation is the same regardless of whether audio is generated or not.","type":"boolean","title":"Generate Audio","default":true},"image_url":{"type":"string","title":"Image Url","description":"The URL of the starting frame image to animate. Supported formats: JPEG, PNG, WebP. Max 30 MB."},"resolution":{"description":"Video resolution - 480p for faster generation, 720p for balance, 1080p for high quality.","type":"string","title":"Resolution","enum":["480p","720p","1080p"],"default":"720p"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_seedance_2_5_reference_to_video":{"type":"object","properties":{"audio_urls":{"type":"array","items":{"type":"string","_fal_ui_field":"audio"},"title":"Audio Urls","description":"Reference audio to guide video generation. Refer to them in the prompt as @Audio1, @Audio2, etc. Supported formats: MP3, WAV. Up to 10 files. Each file must be 1.8 to 30.2 seconds and no larger than 15 MB; combined duration must not exceed 30.2 seconds. At least one reference image or video is required."},"duration":{"description":"Duration of the video in seconds. Supports 4 to 30 seconds, or auto to let the model decide based on the prompt.","type":"string","title":"Duration","enum":["4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30"],"default":"5"},"prompt":{"type":"string","title":"Prompt","description":"The text prompt used to generate the video."},"end_user_id":{"type":"string","title":"End User Id","description":"The unique user ID of the end user."},"aspect_ratio":{"description":"The aspect ratio of the generated video. Use 16:9 for landscape, 9:16 for portrait/vertical, 1:1 for square, 21:9 for ultrawide cinematic, or auto to let the model decide.","type":"string","title":"Aspect Ratio","enum":["auto","21:9","16:9","4:3","1:1","3:4","9:16"],"default":"auto"},"video_urls":{"type":"array","items":{"type":"string","_fal_ui_field":"video"},"title":"Video Urls","description":"Reference videos to guide video generation. Refer to them in the prompt as @Video1, @Video2, etc. Supported formats: MP4, MOV. Up to 10 videos. Each video must be 1.8 to 30.2 seconds and no larger than 200 MB; combined duration must not exceed 30.2 seconds. Dimensions must be 300 to 6,000 pixels per side, aspect ratio 0.4 to 2.5, and frame rate 24 to 60 FPS."},"bitrate_mode":{"description":"Output bitrate mode. 'high' requests a higher-quality, larger-file encode from the model; 'standard' uses the default bitrate.","type":"string","title":"Bitrate Mode","enum":["standard","high"],"default":"standard"},"generate_audio":{"description":"Whether to generate synchronized audio for the video, including sound effects, ambient sounds, and lip-synced speech. The cost of video generation is the same regardless of whether audio is generated or not.","type":"boolean","title":"Generate Audio","default":true},"resolution":{"description":"Video resolution - 480p for faster generation, 720p for balance, 1080p for high quality.","type":"string","title":"Resolution","enum":["480p","720p","1080p"],"default":"720p"},"image_urls":{"type":"array","items":{"type":"string"},"title":"Image Urls","description":"Reference images to guide video generation. Refer to them in the prompt as @Image1, @Image2, etc. Supported formats: JPG, PNG, WebP, BMP, TIFF, GIF, HEIC, HEIF. Max 30 MB per image. Up to 30 images. Total files across all modalities must not exceed 50."}},"required":["prompt"],"additionalProperties":false},"Input_fal_kling_o3_pro_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"Aspect ratio of the generated video.","default":"16:9","type":"string","enum":["16:9","9:16","1:1"],"title":"Aspect Ratio"},"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Required unless multi_prompt is provided.","title":"Prompt"},"duration":{"description":"Video duration in seconds (3-15s).","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation.","title":"Multi Prompt"},"generate_audio":{"description":"Whether to generate native audio for the video.","default":false,"type":"boolean","title":"Generate Audio"},"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"}},"additionalProperties":false},"Input_fal_kling_o3_pro_image_to_video":{"type":"object","properties":{"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"},"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Either prompt or multi_prompt must be provided, but not both.","title":"Prompt"},"duration":{"description":"Video duration in seconds (3-15s).","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation.","title":"Multi Prompt"},"generate_audio":{"description":"Whether to generate native audio for the video.","default":false,"type":"boolean","title":"Generate Audio"},"end_image_url":{"ui":{"field":"image"},"x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string","_fal_ui_field":"image","description":"URL of the end frame image (optional).","title":"End Image Url"},"image_url":{"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","title":"Image Url","description":"URL of the start frame image.","x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"type":"string","_fal_ui_field":"image"}},"required":["image_url"],"additionalProperties":false},"Input_fal_kling_o3_4k_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"Aspect ratio of the generated video.","default":"16:9","type":"string","enum":["16:9","9:16","1:1"],"title":"Aspect Ratio"},"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Required unless multi_prompt is provided.","title":"Prompt"},"duration":{"description":"Video duration in seconds (3-15s).","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation.","title":"Multi Prompt"},"generate_audio":{"description":"Whether to generate native audio for the video.","default":false,"type":"boolean","title":"Generate Audio"},"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"}},"additionalProperties":false},"Input_fal_kling_o3_4k_image_to_video":{"type":"object","properties":{"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"},"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Either prompt or multi_prompt must be provided, but not both.","title":"Prompt"},"duration":{"description":"Video duration in seconds (3-15s).","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation.","title":"Multi Prompt"},"generate_audio":{"description":"Whether to generate native audio for the video.","default":false,"type":"boolean","title":"Generate Audio"},"end_image_url":{"ui":{"field":"image"},"x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string","_fal_ui_field":"image","description":"URL of the end frame image (optional).","title":"End Image Url"},"image_url":{"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","title":"Image Url","description":"URL of the start frame image.","x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"type":"string","_fal_ui_field":"image"}},"required":["image_url"],"additionalProperties":false},"Input_fal_kling_v3_pro_text_to_video":{"type":"object","properties":{"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"},"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Either prompt or multi_prompt must be provided, but not both.","title":"Prompt"},"generate_audio":{"description":"Whether to generate native audio for the video. Supports Chinese and English voice output. Other languages are automatically translated to English. For English speech, use lowercase letters; for acronyms or proper nouns, use uppercase.","default":true,"type":"boolean","title":"Generate Audio"},"cfg_scale":{"maximum":1,"description":"\n            The CFG (Classifier Free Guidance) scale is a measure of how close you want\n            the model to stick to your prompt.\n        ","default":0.5,"type":"number","minimum":0,"title":"Cfg Scale"},"duration":{"description":"The duration of the generated video in seconds","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation. If provided, overrides the single prompt and divides the video into multiple shots with specified prompts and durations.","title":"Multi Prompt"},"negative_prompt":{"maxLength":2500,"default":"blur, distort, and low quality","type":"string","title":"Negative Prompt"},"aspect_ratio":{"description":"The aspect ratio of the generated video frame","default":"16:9","type":"string","enum":["16:9","9:16","1:1"],"title":"Aspect Ratio"}},"additionalProperties":false},"Input_fal_kling_v3_pro_image_to_video":{"type":"object","properties":{"prompt":{"maxLength":2500,"type":"string","description":"Text prompt for video generation. Either prompt or multi_prompt must be provided, but not both.","title":"Prompt"},"elements":{"items":{"properties":{"video_url":{"anyOf":[{"ui":{"field":"video"},"x-fal":{"min_width":720,"min_fps":24,"max_duration":10.05,"max_height":2160,"max_fps":60,"min_height":720,"max_file_size":209715200,"min_duration":3,"max_width":2160,"timeout":30},"limit_description":"Max file size: 200.0MB, Min width: 720px, Min height: 720px, Max width: 2160px, Max height: 2160px, Min duration: 3.0s, Max duration: 10.05s, Min FPS: 24.0, Max FPS: 60.0, Timeout: 30.0s","type":"string"},{"type":"null"}],"description":"The video URL of the element. A request can only have one element with a video.","title":"Video Url"},"frontal_image_url":{"anyOf":[{"ui":{"field":"image"},"x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string"},{"type":"null"}],"description":"The frontal image of the element (main view).","title":"Frontal Image Url"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The voice ID for this element. The voice will be binded to the element and references to this element will use the binded voice. Get voice IDs from the following endpoint: https://fal.ai/models/fal-ai/kling-video/create-voice","title":"Voice Id"},"reference_image_urls":{"anyOf":[{"items":{"ui":{"field":"image"},"x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string","_fal_ui_field":"image"},"type":"array"},{"type":"null"}],"description":"Additional reference images from different angles. 1-3 images supported. At least one image is required.","title":"Reference Image Urls"}},"x-fal-order-properties":["frontal_image_url","reference_image_urls","video_url","voice_id"],"type":"object","title":"KlingV3ComboElementInput"},"type":"array","description":"Elements (characters/objects) to include in the video. Each example can either be an image set (frontal + reference images) or a video. Reference in prompt as @Element1, @Element2, etc.","title":"Elements"},"start_image_url":{"description":"URL of the image to be used for the video","limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string","x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"title":"Start Image Url"},"end_image_url":{"ui":{"field":"image"},"x-fal":{"max_aspect_ratio":2.5,"min_width":300,"min_height":300,"max_file_size":10485760,"min_aspect_ratio":0.4,"timeout":20},"limit_description":"Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s","type":"string","description":"URL of the image to be used for the end of the video","title":"End Image Url"},"generate_audio":{"description":"Whether to generate native audio for the video. Supports Chinese and English voice output. Other languages are automatically translated to English. For English speech, use lowercase letters; for acronyms or proper nouns, use uppercase.","default":true,"type":"boolean","title":"Generate Audio"},"cfg_scale":{"maximum":1,"description":"\n            The CFG (Classifier Free Guidance) scale is a measure of how close you want\n            the model to stick to your prompt.\n        ","default":0.5,"type":"number","minimum":0,"title":"Cfg Scale"},"duration":{"description":"The duration of the generated video in seconds","default":"5","type":"string","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"multi_prompt":{"items":{"properties":{"duration":{"description":"The duration of this shot in seconds","default":"5","type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],"title":"Duration"},"prompt":{"description":"The prompt for this shot.","type":"string","title":"Prompt"}},"x-fal-order-properties":["prompt","duration"],"required":["prompt"],"type":"object","title":"KlingV3MultiPromptElement"},"type":"array","description":"List of prompts for multi-shot video generation. If provided, divides the video into multiple shots.","title":"Multi Prompt"},"negative_prompt":{"maxLength":2500,"default":"blur, distort, and low quality","type":"string","title":"Negative Prompt"},"shot_type":{"description":"The type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure.","default":"customize","type":"string","enum":["customize","intelligent"],"title":"Shot Type"}},"required":["start_image_url"],"additionalProperties":false},"Input_fal_veo_3_1_text_to_video":{"type":"object","properties":{"duration":{"title":"Duration","description":"The duration of the generated video.","default":"8s","enum":["4s","6s","8s"],"type":"string"},"aspect_ratio":{"title":"Aspect Ratio","description":"Aspect ratio of the generated video","default":"16:9","enum":["16:9","9:16"],"type":"string"},"auto_fix":{"title":"Auto Fix","description":"Whether to automatically attempt to fix prompts that fail content policy or other validation checks by rewriting them.","default":true,"type":"boolean"},"negative_prompt":{"type":"string","title":"Negative Prompt","description":"A negative prompt to guide the video generation."},"prompt":{"description":"The text prompt describing the video you want to generate","maxLength":20000,"title":"Prompt","type":"string"},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"safety_tolerance":{"title":"Safety Tolerance","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"]},"resolution":{"title":"Resolution","description":"The resolution of the generated video.","default":"720p","enum":["720p","1080p","4k"],"type":"string"},"generate_audio":{"title":"Generate Audio","description":"Whether to generate audio for the video.","default":true,"type":"boolean"}},"required":["prompt"],"additionalProperties":false},"Input_fal_veo_3_1_fast_text_to_video":{"type":"object","properties":{"duration":{"title":"Duration","description":"The duration of the generated video.","default":"8s","enum":["4s","6s","8s"],"type":"string"},"aspect_ratio":{"title":"Aspect Ratio","description":"Aspect ratio of the generated video","default":"16:9","enum":["16:9","9:16"],"type":"string"},"auto_fix":{"title":"Auto Fix","description":"Whether to automatically attempt to fix prompts that fail content policy or other validation checks by rewriting them.","default":true,"type":"boolean"},"negative_prompt":{"type":"string","title":"Negative Prompt","description":"A negative prompt to guide the video generation."},"prompt":{"description":"The text prompt describing the video you want to generate","maxLength":20000,"title":"Prompt","type":"string"},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"safety_tolerance":{"title":"Safety Tolerance","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"]},"resolution":{"title":"Resolution","description":"The resolution of the generated video.","default":"720p","enum":["720p","1080p","4k"],"type":"string"},"generate_audio":{"title":"Generate Audio","description":"Whether to generate audio for the video.","default":true,"type":"boolean"}},"required":["prompt"],"additionalProperties":false},"Input_fal_veo_3_1_image_to_video":{"type":"object","properties":{"duration":{"title":"Duration","description":"The duration of the generated video.","default":"8s","enum":["4s","6s","8s"],"type":"string"},"aspect_ratio":{"title":"Aspect Ratio","description":"The aspect ratio of the generated video. Only 16:9 and 9:16 are supported.","default":"auto","type":"string","enum":["auto","16:9","9:16"]},"auto_fix":{"title":"Auto Fix","description":"Whether to automatically attempt to fix prompts that fail content policy or other validation checks by rewriting them.","default":false,"type":"boolean"},"negative_prompt":{"type":"string","title":"Negative Prompt","description":"A negative prompt to guide the video generation."},"image_url":{"description":"URL of the input image to animate. Should be 720p or higher resolution in 16:9 or 9:16 aspect ratio. If the image is not in 16:9 or 9:16 aspect ratio, it will be cropped to fit.","title":"Image URL","type":"string"},"prompt":{"description":"The text prompt describing the video you want to generate","maxLength":20000,"title":"Prompt","type":"string"},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"safety_tolerance":{"title":"Safety Tolerance","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"]},"resolution":{"title":"Resolution","description":"The resolution of the generated video.","default":"720p","enum":["720p","1080p","4k"],"type":"string"},"generate_audio":{"title":"Generate Audio","description":"Whether to generate audio for the video.","default":true,"type":"boolean"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_veo_3_1_fast_image_to_video":{"type":"object","properties":{"duration":{"title":"Duration","description":"The duration of the generated video.","default":"8s","enum":["4s","6s","8s"],"type":"string"},"aspect_ratio":{"title":"Aspect Ratio","description":"The aspect ratio of the generated video. Only 16:9 and 9:16 are supported.","default":"auto","type":"string","enum":["auto","16:9","9:16"]},"auto_fix":{"title":"Auto Fix","description":"Whether to automatically attempt to fix prompts that fail content policy or other validation checks by rewriting them.","default":false,"type":"boolean"},"negative_prompt":{"type":"string","title":"Negative Prompt","description":"A negative prompt to guide the video generation."},"image_url":{"description":"URL of the input image to animate. Should be 720p or higher resolution in 16:9 or 9:16 aspect ratio. If the image is not in 16:9 or 9:16 aspect ratio, it will be cropped to fit.","title":"Image URL","type":"string"},"prompt":{"description":"The text prompt describing the video you want to generate","maxLength":20000,"title":"Prompt","type":"string"},"seed":{"type":"integer","title":"Seed","description":"The seed for the random number generator."},"safety_tolerance":{"title":"Safety Tolerance","description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","default":"4","type":"string","enum":["1","2","3","4","5","6"]},"resolution":{"title":"Resolution","description":"The resolution of the generated video.","default":"720p","enum":["720p","1080p","4k"],"type":"string"},"generate_audio":{"title":"Generate Audio","description":"Whether to generate audio for the video.","default":true,"type":"boolean"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_gemini_omni_flash_text_to_video":{"type":"object","properties":{"duration":{"type":"integer","default":8,"minimum":3,"description":"The duration of the generated video, in seconds.","maximum":10,"title":"Duration"},"resolution":{"type":"string","default":"720p","description":"The resolution of the generated video.","enum":["360p","720p","1080p","4k"],"title":"Resolution"},"prompt":{"type":"string","description":"The text prompt describing the video you want to generate.","maxLength":20000,"title":"Prompt"},"aspect_ratio":{"type":"string","default":"16:9","description":"The aspect ratio of the generated video.","enum":["16:9","9:16"],"title":"Aspect Ratio"}},"required":["prompt"],"additionalProperties":false},"Input_fal_gemini_omni_flash_image_to_video":{"type":"object","properties":{"duration":{"type":"integer","default":8,"minimum":3,"description":"The duration of the generated video, in seconds.","maximum":10,"title":"Duration"},"end_image_url":{"type":"string","description":"Optional URL of the end frame. When provided, the model interpolates between the two images in their listed order.","title":"End Image URL"},"image_url":{"type":"string","description":"URL of the first frame to animate.","title":"Image URL"},"resolution":{"type":"string","default":"720p","description":"The resolution of the generated video.","enum":["360p","720p","1080p","4k"],"title":"Resolution"},"prompt":{"type":"string","description":"The text prompt describing how the first image should be animated or interpolated into the optional end image.","maxLength":20000,"title":"Prompt"},"aspect_ratio":{"type":"string","default":"16:9","description":"The aspect ratio of the generated video.","enum":["16:9","9:16"],"title":"Aspect Ratio"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_gemini_omni_flash_video_edit":{"type":"object","properties":{"video_url":{"type":"string","description":"URL of the video to edit.","title":"Video URL"},"resolution":{"type":"string","default":"720p","description":"The resolution of the edited video.","enum":["360p","720p","1080p","4k"],"title":"Resolution"},"prompt":{"type":"string","description":"A simple instruction describing the edit.","maxLength":20000,"title":"Prompt"},"max_seconds":{"type":"number","minimum":1,"maximum":120,"default":10,"description":"Upper bound of the output video length, which follows the input video, in seconds (default 10, max 120). The reservation is this bound at the unit price; after the call the seconds fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["prompt","video_url"],"additionalProperties":false},"Input_fal_minimax_h3_max_text_to_video":{"type":"object","properties":{"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled.","default":true,"type":"boolean"},"duration":{"title":"Duration","description":"The duration of the video in seconds.","minimum":5,"default":5,"type":"integer","maximum":15},"aspect_ratio":{"title":"Aspect Ratio","description":"The aspect ratio of the generated video.","default":"16:9","enum":["21:9","16:9","4:3","1:1","3:4","9:16"],"type":"string"},"prompt_expansion_mode":{"description":"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.","title":"Prompt Expansion Mode","default":"balanced","type":"string","enum":["balanced","quality"]},"prompt":{"description":"Text prompt for video generation","maxLength":50000,"title":"Prompt","type":"string","minLength":1},"seed":{"type":"integer","title":"Seed","description":"Random seed. A random seed is selected when omitted."},"resolution":{"title":"Resolution","description":"The native generation resolution of the video.","default":"768P","enum":["480P","768P"],"type":"string"}},"required":["prompt","prompt_expansion_mode"],"additionalProperties":false},"Input_fal_minimax_h3_max_image_to_video":{"type":"object","properties":{"end_image_url":{"type":"string","title":"End Image URL","description":"Optional URL of the image to use as the last frame, for first-to-last keyframe generation."},"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled.","default":true,"type":"boolean"},"duration":{"title":"Duration","description":"The duration of the video in seconds.","minimum":5,"default":5,"type":"integer","maximum":15},"image_url":{"type":"string","description":"Optional URL of the image to use as the first frame. When provided, the output aspect ratio follows this image. When omitted, the request is handled as text-to-video (16:9 by default).","title":"Image URL"},"prompt_expansion_mode":{"description":"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.","title":"Prompt Expansion Mode","default":"balanced","type":"string","enum":["balanced","quality"]},"prompt":{"description":"Text prompt for video generation","maxLength":50000,"title":"Prompt","type":"string","minLength":1},"seed":{"type":"integer","title":"Seed","description":"Random seed. A random seed is selected when omitted."},"resolution":{"title":"Resolution","description":"The native generation resolution of the video.","default":"768P","enum":["480P","768P"],"type":"string"}},"required":["prompt","prompt_expansion_mode"],"additionalProperties":false},"Input_fal_minimax_h3_max_turbo_text_to_video":{"type":"object","properties":{"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled.","default":true,"type":"boolean"},"duration":{"title":"Duration","description":"The duration of the video in seconds.","minimum":5,"default":5,"type":"integer","maximum":15},"aspect_ratio":{"title":"Aspect Ratio","description":"The aspect ratio of the generated video.","default":"16:9","enum":["21:9","16:9","4:3","1:1","3:4","9:16"],"type":"string"},"prompt_expansion_mode":{"description":"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.","title":"Prompt Expansion Mode","default":"balanced","type":"string","enum":["balanced","quality"]},"prompt":{"description":"Text prompt for video generation","maxLength":50000,"title":"Prompt","type":"string","minLength":1},"seed":{"type":"integer","title":"Seed","description":"Random seed. A random seed is selected when omitted."},"resolution":{"title":"Resolution","description":"The native generation resolution of the video.","default":"768P","enum":["480P","768P"],"type":"string"}},"required":["prompt","prompt_expansion_mode"],"additionalProperties":false},"Input_fal_minimax_h3_max_turbo_image_to_video":{"type":"object","properties":{"end_image_url":{"type":"string","title":"End Image URL","description":"Optional URL of the image to use as the last frame, for first-to-last keyframe generation."},"enable_safety_checker":{"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled.","default":true,"type":"boolean"},"duration":{"title":"Duration","description":"The duration of the video in seconds.","minimum":5,"default":5,"type":"integer","maximum":15},"image_url":{"type":"string","description":"Optional URL of the image to use as the first frame. When provided, the output aspect ratio follows this image. When omitted, the request is handled as text-to-video (16:9 by default).","title":"Image URL"},"prompt_expansion_mode":{"description":"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.","title":"Prompt Expansion Mode","default":"balanced","type":"string","enum":["balanced","quality"]},"prompt":{"description":"Text prompt for video generation","maxLength":50000,"title":"Prompt","type":"string","minLength":1},"seed":{"type":"integer","title":"Seed","description":"Random seed. A random seed is selected when omitted."},"resolution":{"title":"Resolution","description":"The native generation resolution of the video.","default":"768P","enum":["480P","768P"],"type":"string"}},"required":["prompt","prompt_expansion_mode"],"additionalProperties":false},"Input_fal_wan_2_6_image_to_video":{"type":"object","properties":{"prompt":{"description":"The text prompt describing the desired video motion. Max 1500 characters.","title":"Prompt","type":"string","minLength":1},"enable_safety_checker":{"description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.","title":"Enable Safety Checker","type":"boolean","default":true},"image_url":{"title":"Image URL","type":"string","description":"URL of the image to use as the first frame. Must be publicly accessible or base64 data URI. Image dimensions must be between 240 and 7680."},"enable_prompt_expansion":{"default":true,"title":"Enable Prompt Expansion","type":"boolean","description":"Whether to enable prompt rewriting using LLM."},"audio_url":{"ui":{"field":"audio"},"type":"string","title":"Audio Url","description":"\nURL of the audio to use as the background music. Must be publicly accessible.\nLimit handling: If the audio duration exceeds the duration value (5, 10, or 15 seconds),\nthe audio is truncated to the first N seconds, and the rest is discarded. If\nthe audio is shorter than the video, the remaining part of the video will be silent.\nFor example, if the audio is 3 seconds long and the video duration is 5 seconds, the\nfirst 3 seconds of the output video will have sound, and the last 2 seconds will be silent.\n- Format: WAV, MP3.\n- Duration: 3 to 30 s.\n- File size: Up to 15 MB.\n"},"seed":{"type":"integer","title":"Seed","description":"Random seed for reproducibility. If None, a random seed is chosen."},"duration":{"default":"5","title":"Duration","description":"Duration of the generated video in seconds. Choose between 5, 10 or 15 seconds.","type":"string","enum":["5","10","15"]},"multi_shots":{"default":false,"title":"Multi Shots","type":"boolean","description":"When true, enables intelligent multi-shot segmentation. Only active when enable_prompt_expansion is True. Set to false for single-shot generation."},"resolution":{"description":"Video resolution. Valid values: 720p, 1080p","title":"Resolution","default":"1080p","type":"string","enum":["720p","1080p"]},"negative_prompt":{"type":"string","title":"Negative Prompt","default":"","description":"Negative prompt to describe content to avoid. Max 500 characters."}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_ltx_2_5_pro_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"The aspect ratio of the generated video","type":"string","title":"Aspect Ratio","enum":["16:9","9:16"],"default":"16:9"},"duration":{"description":"The duration of the generated video in seconds, up to 10 seconds. Set to 'auto' to let the model choose the duration automatically.","title":"Duration","enum":[6,8,10],"type":"integer","default":6},"prompt":{"description":"The prompt to use for the generated video","type":"string","maxLength":5000,"minLength":1,"title":"Prompt"},"generate_audio":{"description":"Whether to generate audio for the generated video","type":"boolean","title":"Generate Audio","default":true},"fps":{"description":"The frames per second of the generated video.","type":"integer","title":"Frames per Second","enum":[24,25,50],"default":25},"resolution":{"description":"The resolution of the generated video.","type":"string","title":"Resolution","enum":["720p","1080p"],"default":"1080p"},"camera_motion":{"type":"string","enum":["dolly_in","dolly_out","dolly_left","dolly_right","jib_up","jib_down","static","focus_shift"],"title":"Camera Motion","description":"Optional camera motion applied to the generated video."}},"required":["prompt"],"additionalProperties":false},"Input_fal_ltx_2_5_pro_image_to_video":{"type":"object","properties":{"fps":{"description":"The frames per second of the generated video.","type":"integer","title":"Frames per Second","enum":[24,25,50],"default":25},"end_image_url":{"type":"string","title":"End Image URL","description":"The URL of the end image to use for the generated video. When provided, generates a transition video between start and end frames."},"prompt":{"description":"The prompt to use for the generated video","type":"string","maxLength":5000,"minLength":1,"title":"Prompt"},"duration":{"description":"The duration of the generated video in seconds, up to 10 seconds. Set to 'auto' to let the model choose the duration automatically.","title":"Duration","enum":[6,8,10],"type":"integer","default":6},"aspect_ratio":{"description":"The aspect ratio of the generated video. If 'auto', the aspect ratio will be determined automatically based on the input image.","type":"string","title":"Aspect Ratio","enum":["auto","16:9","9:16"],"default":"auto"},"generate_audio":{"description":"Whether to generate audio for the generated video","type":"boolean","title":"Generate Audio","default":true},"image_url":{"description":"The URL of the start image to use for the generated video.","type":"string","title":"Start Image URL"},"resolution":{"description":"The resolution of the generated video.","type":"string","title":"Resolution","enum":["720p","1080p"],"default":"1080p"},"camera_motion":{"type":"string","enum":["dolly_in","dolly_out","dolly_left","dolly_right","jib_up","jib_down","static","focus_shift"],"title":"Camera Motion","description":"Optional camera motion applied to the generated video."}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_luma_ray_3_2_text_to_video":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt","description":"Text prompt describing the video to generate.","minLength":1,"maxLength":6000},"resolution":{"type":"string","title":"Resolution","default":"540p","enum":["540p","720p","1080p"],"description":"Resolution of the generated video. Higher resolutions cost more."},"duration":{"type":"string","title":"Duration","default":"5s","enum":["5s","10s"],"description":"Duration of the generated video."},"aspect_ratio":{"type":"string","title":"Aspect Ratio","default":"16:9","enum":["3:4","4:3","1:1","9:16","16:9","21:9"],"description":"Aspect ratio of the generated video."},"exr_export":{"type":"boolean","title":"Exr Export","default":false,"description":"Also export an EXR file alongside the MP4. Requires hdr=true and HDR access."},"loop":{"type":"boolean","title":"Loop","default":false,"description":"Generate a seamless loop. Only valid for 5s, standard-dynamic-range generations without an end frame."}},"required":["prompt"],"additionalProperties":false},"Input_fal_luma_ray_3_2_image_to_video":{"type":"object","properties":{"prompt":{"type":"string","title":"Prompt","description":"Text prompt describing the motion/scene to generate.","minLength":1,"maxLength":6000},"resolution":{"type":"string","title":"Resolution","default":"540p","enum":["540p","720p","1080p"],"description":"Resolution of the generated video. Higher resolutions cost more."},"exr_export":{"type":"boolean","title":"Exr Export","default":false,"description":"Also export an EXR file alongside the MP4. Requires hdr=true and HDR access."},"loop":{"type":"boolean","title":"Loop","default":false,"description":"Generate a seamless loop. Only valid for standard-dynamic-range generations without an end frame or keyframes."},"keyframes":{"type":"array","minItems":1,"items":{"type":"string"},"maxItems":64,"title":"Keyframes","description":"Multi-keyframe image-to-video guide frames: 1-64 image URLs pinned at the positions given by keyframe_indexes. Mutually exclusive with image_url, end_image_url, and loop; unlocks 10s and HDR. Provide keyframes and keyframe_indexes together (same length)."},"duration":{"type":"string","title":"Duration","default":"5s","enum":["5s","10s"],"description":"Duration of the generated video. 10s requires multi-keyframe input (keyframes / keyframe_indexes); it is not supported with a single image_url / end_image_url anchor."},"aspect_ratio":{"type":"string","title":"Aspect Ratio","default":"16:9","enum":["3:4","4:3","1:1","9:16","16:9","21:9"],"description":"Aspect ratio of the generated video."},"image_url":{"type":"string","minLength":1,"title":"Image Url","description":"URL of the image used as the first frame of the video. Provide either image_url (optionally with end_image_url) or keyframes — the two anchoring modes are mutually exclusive."},"keyframe_indexes":{"type":"array","minItems":1,"items":{"type":"integer"},"maxItems":64,"title":"Keyframe Indexes","description":"Output-frame positions (duration x 24fps: 5s -> 0-120, 10s -> 0-240) where each keyframes[i] is anchored. Non-negative, unique, and the same length as keyframes."},"end_image_url":{"type":"string","title":"End Image Url","description":"Optional URL of an image used as the last frame. When set, the model interpolates between image_url and end_image_url. Cannot be combined with keyframes."}},"required":["prompt"],"additionalProperties":false},"Input_fal_pixverse_5_6_text_to_video":{"type":"object","properties":{"generate_audio_switch":{"title":"Generate Audio Switch","type":"boolean","default":false,"description":"Enable audio generation (BGM, SFX, dialogue)"},"prompt":{"title":"Prompt","type":"string","description":"Text prompt for the video generation. Limited to 2048 UTF-8 encoded bytes. Because the limit counts bytes rather than characters, emoji and non-Latin or accented characters (which use multiple bytes each) can push a visually short prompt over the cap."},"thinking_type":{"enum":["enabled","disabled","auto"],"type":"string","title":"Thinking Type","description":"Prompt optimization mode: 'enabled' to optimize, 'disabled' to turn off, 'auto' for model decision"},"seed":{"type":"integer","title":"Seed","description":"\n            The same seed and the same prompt given to the same version of the model\n            will output the same video every time.\n        "},"duration":{"title":"Duration","enum":["5","8","10"],"default":"5","description":"The duration of the generated video in seconds. 1080p videos are limited to 5 or 8 seconds","type":"string"},"negative_prompt":{"title":"Negative Prompt","default":"","description":"Negative prompt to be used for the generation. Limited to 2048 UTF-8 encoded bytes. Because the limit counts bytes rather than characters, emoji and non-Latin or accented characters (which use multiple bytes each) can push a visually short prompt over the cap.","type":"string"},"resolution":{"title":"Resolution","enum":["360p","540p","720p","1080p"],"default":"720p","description":"The resolution of the generated video","type":"string"},"style":{"enum":["anime","3d_animation","clay","comic","cyberpunk"],"type":"string","title":"Style","description":"The style of the generated video"},"aspect_ratio":{"title":"Aspect Ratio","enum":["16:9","4:3","1:1","3:4","9:16"],"default":"16:9","description":"The aspect ratio of the generated video","type":"string"}},"required":["prompt"],"additionalProperties":false},"Input_fal_pixverse_5_6_image_to_video":{"type":"object","properties":{"generate_audio_switch":{"title":"Generate Audio Switch","type":"boolean","default":false,"description":"Enable audio generation (BGM, SFX, dialogue)"},"prompt":{"title":"Prompt","type":"string","description":"Text prompt for the video generation. Limited to 2048 UTF-8 encoded bytes. Because the limit counts bytes rather than characters, emoji and non-Latin or accented characters (which use multiple bytes each) can push a visually short prompt over the cap."},"thinking_type":{"enum":["enabled","disabled","auto"],"type":"string","title":"Thinking Type","description":"Prompt optimization mode: 'enabled' to optimize, 'disabled' to turn off, 'auto' for model decision"},"image_url":{"title":"Image Url","type":"string","description":"URL of the image to use as the first frame"},"seed":{"type":"integer","title":"Seed","description":"\n            The same seed and the same prompt given to the same version of the model\n            will output the same video every time.\n        "},"negative_prompt":{"title":"Negative Prompt","default":"","description":"Negative prompt to be used for the generation. Limited to 2048 UTF-8 encoded bytes. Because the limit counts bytes rather than characters, emoji and non-Latin or accented characters (which use multiple bytes each) can push a visually short prompt over the cap.","type":"string"},"duration":{"title":"Duration","enum":["5","8","10"],"default":"5","description":"The duration of the generated video in seconds. 1080p videos are limited to 5 or 8 seconds","type":"string"},"resolution":{"title":"Resolution","enum":["360p","540p","720p","1080p"],"default":"720p","description":"The resolution of the generated video","type":"string"},"style":{"enum":["anime","3d_animation","clay","comic","cyberpunk"],"type":"string","title":"Style","description":"The style of the generated video"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_grok_imagine_video_1_5_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"Aspect ratio of the generated video.","default":"16:9","type":"string","enum":["16:9","4:3","3:2","1:1","2:3","3:4","9:16"],"title":"Aspect Ratio"},"duration":{"maximum":15,"description":"Video duration in seconds.","default":6,"type":"integer","minimum":1,"title":"Duration"},"resolution":{"description":"Resolution of the output video.","default":"720p","type":"string","enum":["480p","720p","1080p"],"title":"Resolution"},"prompt":{"description":"Text description of the desired video.","maxLength":4096,"type":"string","title":"Prompt"}},"required":["prompt"],"additionalProperties":false},"Input_fal_grok_imagine_video_1_5_image_to_video":{"type":"object","properties":{"image_url":{"description":"URL of the input image for video generation.","type":"string","title":"Image URL"},"duration":{"maximum":15,"description":"Video duration in seconds.","default":6,"type":"integer","minimum":1,"title":"Duration"},"resolution":{"description":"Resolution of the output video.","default":"720p","type":"string","enum":["480p","720p","1080p"],"title":"Resolution"},"prompt":{"description":"Text description of desired changes or motion in the video.","maxLength":4096,"type":"string","title":"Prompt"}},"required":["prompt","image_url"],"additionalProperties":false},"Input_fal_vidu_q3_text_to_video":{"type":"object","properties":{"aspect_ratio":{"description":"The aspect ratio of the output video","type":"string","enum":["16:9","9:16","4:3","3:4","1:1"],"title":"Aspect Ratio","default":"16:9"},"duration":{"description":"Duration of the video in seconds","type":"integer","minimum":1,"maximum":16,"title":"Duration","default":5},"prompt":{"description":"Text prompt for video generation, max 2000 characters","type":"string","maxLength":2000,"title":"Prompt"},"audio":{"description":"Whether to use direct audio-video generation. When true, outputs video with sound.","type":"boolean","title":"Audio","default":true},"resolution":{"description":"Output video resolution","type":"string","enum":["360p","540p","720p","1080p"],"title":"Resolution","default":"720p"},"seed":{"type":"integer","title":"Seed","description":"Random seed for reproducibility. If None, a random seed is chosen."}},"required":["prompt"],"additionalProperties":false},"Input_fal_vidu_q3_image_to_video":{"type":"object","properties":{"image_url":{"description":"URL or base64 image to use as the starting frame","type":"string","title":"Image Url"},"duration":{"description":"Duration of the video in seconds (1-16 for Q3 models)","type":"integer","minimum":1,"maximum":16,"title":"Duration","default":5},"prompt":{"default":"","maxLength":2000,"description":"Text prompt for video generation, max 2000 characters","type":"string","title":"Prompt"},"end_image_url":{"type":"string","title":"End Image Url","description":"URL of the image to use as the ending frame. When provided, generates a transition video between start and end frames."},"audio":{"description":"Whether to use direct audio-video generation. When true, outputs video with sound (including dialogue and sound effects).","type":"boolean","title":"Audio","default":true},"resolution":{"description":"Output video resolution. Note: 360p is not available when end_image_url is provided.","type":"string","enum":["360p","540p","720p","1080p"],"title":"Resolution","default":"720p"},"seed":{"type":"integer","title":"Seed","description":"Random seed for reproducibility. If None, a random seed is chosen."}},"required":["image_url"],"additionalProperties":false},"Input_fal_sync_lipsync_v3":{"type":"object","properties":{"video_url":{"type":"string","description":"URL of the input video","title":"Video Url"},"options":{"properties":{"active_speaker_detection":{"anyOf":[{"properties":{"frame_number":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Frame index for manual speaker selection coordinates.","title":"Frame Number"},"bounding_boxes_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL to a JSON file containing per-frame bounding boxes.","title":"Bounding Boxes Url"},"auto_detect":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether to automatically detect and apply generation to the active speaker.","title":"Auto Detect"},"face_image":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base64 encoded face image for manual speaker selection.","title":"Face Image"},"bounding_boxes":{"anyOf":[{"type":"array","items":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}]}},{"type":"null"}],"description":"Per-frame bounding boxes [x1, y1, x2, y2] for the detected face.","title":"Bounding Boxes"},"use_v2":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Deprecated Sync.so option for active speaker detection v2.","title":"Use V2"},"v3":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether to use Sync.so's active speaker detection v3.","title":"V3"},"coordinates":{"anyOf":[{"type":"array","items":{"type":"integer"},"maxItems":2,"minItems":2},{"type":"null"}],"description":"Reference point [x, y] on the speaker's face in frame_number.","title":"Coordinates"}},"type":"object","x-fal-order-properties":["auto_detect","v3","use_v2","frame_number","coordinates","bounding_boxes","bounding_boxes_url","face_image"],"title":"Sync3ActiveSpeakerDetection"},{"type":"null"}],"description":"Active speaker detection configuration for videos with multiple people."},"prompt":{"anyOf":[{"type":"string","enum":["happy","sad","angry","disgusted","surprised","neutral"]},{"type":"null"}],"description":"Emotion prompt for generation. This is a Sync.so option primarily used by react-1.","title":"Prompt"},"occlusion_detection_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether to detect occlusion during generation. Sync.so handles this automatically for sync-3, so this option is ignored by sync-3.","title":"Occlusion Detection Enabled"},"temperature":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}],"description":"Controls how expressive lipsync can be; 0 is least expressive, 1 is most expressive. Sync.so handles this natively for sync-3, so this option is ignored by sync-3.","title":"Temperature"},"model_mode":{"anyOf":[{"type":"string","enum":["lips","face","head","lipsync","emotion","talking_head"]},{"type":"null"}],"description":"Edit region for the model. This is a Sync.so option primarily used by react-1.","title":"Model Mode"},"sync_mode":{"anyOf":[{"type":"string","enum":["cut_off","loop","bounce","silence","remap"]},{"type":"null"}],"description":"Defines how to handle duration mismatches between video and audio inputs. Overrides the top-level sync_mode when provided.","title":"Sync Mode"}},"type":"object","x-fal-order-properties":["sync_mode","model_mode","prompt","temperature","active_speaker_detection","occlusion_detection_enabled"],"title":"Sync3GenerationOptions","description":"Additional Sync.so generation options. If options.sync_mode is set, it overrides the top-level sync_mode field."},"audio_url":{"type":"string","description":"URL of the input audio","title":"Audio Url"},"max_minutes":{"type":"number","minimum":0.05,"maximum":10,"default":1,"description":"Upper bound of the output video length, which follows the input, in minutes (default 1, max 10). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["video_url","audio_url"],"additionalProperties":false},"Input_fal_veed_lipsync_v2":{"type":"object","properties":{"audio_url":{"minLength":1,"maxLength":2083,"title":"Audio Url","description":"New audio track to articulate","format":"uri","type":"string"},"video_url":{"minLength":1,"maxLength":2083,"title":"Video Url","description":"Source video to lipsync","format":"uri","type":"string"},"max_seconds":{"type":"number","minimum":1,"maximum":600,"default":60,"description":"Upper bound of the output video length, which follows the input, in seconds (default 60, max 600). The reservation is this bound at the unit price; after the call the seconds fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["video_url","audio_url"],"additionalProperties":false},"Input_fal_omnihuman_1_5":{"type":"object","properties":{"resolution":{"enum":["720p","1080p"],"title":"Resolution","description":"The resolution of the generated video. Defaults to 1080p. 720p generation is faster and higher in quality. 1080p generation is limited to 30s audio and 720p generation is limited to 60s audio.","type":"string","default":"1080p"},"audio_url":{"title":"Audio Url","description":"The URL of the audio file to generate the video. Audio must be under 30s long for 1080p generation and under 60s long for 720p generation.","type":"string"},"mask_url":{"type":"string","title":"Mask Url","description":"The URL of the mask image to apply to the image. Only the person in the white area of the mask will speak."},"image_url":{"title":"Image Url","description":"The URL of the image used to generate the video","type":"string"},"prompt":{"type":"string","title":"Prompt","description":"The text prompt used to guide the video generation."},"turbo_mode":{"title":"Turbo Mode","description":"Generate a video at a faster rate with a slight quality trade-off.","type":"boolean","default":false},"max_seconds":{"type":"number","minimum":1,"maximum":600,"default":30,"description":"Upper bound of the output video length, which follows the audio, in seconds (default 30, max 600). The reservation is this bound at the unit price; after the call the seconds fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["image_url","audio_url"],"additionalProperties":false},"Input_fal_status":{"type":"object","properties":{"model":{"type":"string","enum":["bytedance/seedance-2.5","fal-ai/kling-video","fal-ai/veo3.1","google/gemini-omni-flash","minimax/h3-max","minimax/h3-max-turbo","wan/v2.6","lightricks/ltx-2.5","luma/agent","fal-ai/pixverse","xai/grok-imagine-video","fal-ai/vidu","fal-ai/sync-lipsync","veed/lipsync","fal-ai/bytedance","fal-ai/elevenlabs"],"description":"The fal app root given in the generation tool's description (owner/app, e.g. minimax/h3-max-turbo)"},"request_id":{"type":"string","minLength":8,"description":"request_id returned by the generation tool"}},"required":["model","request_id"],"additionalProperties":false},"Input_fal_result":{"type":"object","properties":{"model":{"type":"string","enum":["bytedance/seedance-2.5","fal-ai/kling-video","fal-ai/veo3.1","google/gemini-omni-flash","minimax/h3-max","minimax/h3-max-turbo","wan/v2.6","lightricks/ltx-2.5","luma/agent","fal-ai/pixverse","xai/grok-imagine-video","fal-ai/vidu","fal-ai/sync-lipsync","veed/lipsync","fal-ai/bytedance","fal-ai/elevenlabs"],"description":"The fal app root given in the generation tool's description (owner/app, e.g. minimax/h3-max-turbo)"},"request_id":{"type":"string","minLength":8,"description":"request_id returned by the generation tool"}},"required":["model","request_id"],"additionalProperties":false},"Input_fal_elevenlabs_tts_multilingual_v2":{"type":"object","properties":{"timestamps":{"type":"boolean","description":"Whether to return timestamps for each word in the generated speech","title":"Timestamps","default":false},"similarity_boost":{"type":"number","minimum":0,"maximum":1,"description":"Similarity boost (0-1)","title":"Similarity Boost","default":0.75},"voice":{"type":"string","description":"The voice to use for speech generation","title":"Voice","default":"Rachel"},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.","title":"Previous Text"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Voice stability (0-1)","title":"Stability","default":0.5},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speech speed (0.7-1.2). Values below 1.0 slow down the speech, above 1.0 speed it up. Extreme values may affect quality.","title":"Speed","default":1},"style":{"type":"number","minimum":0,"maximum":1,"description":"Style exaggeration (0-1)","title":"Style","default":0},"apply_text_normalization":{"type":"string","default":"auto","description":"This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped.","title":"Apply Text Normalization","enum":["auto","on","off"]},"text":{"type":"string","description":"The text to convert to speech","minLength":1,"title":"Text"},"language_code":{"type":"string","description":"Language code (ISO 639-1) used to enforce a language for the model. An error will be returned if language code is not supported by the model.","title":"Language Code"},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.","title":"Next Text"}},"required":["text"],"additionalProperties":false},"Input_fal_elevenlabs_tts_v3":{"type":"object","properties":{"apply_text_normalization":{"type":"string","default":"auto","description":"This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped.","title":"Apply Text Normalization","enum":["auto","on","off"]},"timestamps":{"type":"boolean","description":"Whether to return timestamps for each word in the generated speech","title":"Timestamps","default":false},"text":{"type":"string","title":"Text","description":"The text to convert to speech","minLength":1,"maxLength":5000},"language_code":{"type":"string","description":"Language code (ISO 639-1) used to enforce a language for the model.","title":"Language Code"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Voice stability (0-1)","title":"Stability","default":0.5},"voice":{"type":"string","description":"The voice to use for speech generation","title":"Voice","default":"Rachel"}},"required":["text"],"additionalProperties":false},"Input_fal_elevenlabs_tts_turbo_v2_5":{"type":"object","properties":{"timestamps":{"type":"boolean","description":"Whether to return timestamps for each word in the generated speech","title":"Timestamps","default":false},"similarity_boost":{"type":"number","minimum":0,"maximum":1,"description":"Similarity boost (0-1)","title":"Similarity Boost","default":0.75},"voice":{"type":"string","description":"The voice to use for speech generation","title":"Voice","default":"Rachel"},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.","title":"Previous Text"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Voice stability (0-1)","title":"Stability","default":0.5},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speech speed (0.7-1.2). Values below 1.0 slow down the speech, above 1.0 speed it up. Extreme values may affect quality.","title":"Speed","default":1},"style":{"type":"number","minimum":0,"maximum":1,"description":"Style exaggeration (0-1)","title":"Style","default":0},"apply_text_normalization":{"type":"string","default":"auto","description":"This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped.","title":"Apply Text Normalization","enum":["auto","on","off"]},"text":{"type":"string","description":"The text to convert to speech","minLength":1,"title":"Text"},"language_code":{"type":"string","description":"Language code (ISO 639-1) used to enforce a language for the model. An error will be returned if language code is not supported by the model.","title":"Language Code"},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.","title":"Next Text"}},"required":["text"],"additionalProperties":false},"Input_fal_elevenlabs_text_to_dialogue_v3":{"type":"object","properties":{"use_speaker_boost":{"type":"boolean","description":"This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.","title":"Use Speaker Boost"},"language_code":{"type":"string","description":"Language code (ISO 639-1) used to enforce a language for the model. An error will be returned if language code is not supported by the model.","title":"Language Code"},"seed":{"type":"integer","description":"Random seed for reproducibility.","title":"Seed"},"pronunciation_dictionary_locators":{"type":"array","items":{"type":"object","x-fal-order-properties":["pronunciation_dictionary_id","version_id"],"title":"PronunciationDictionaryLocator","properties":{"pronunciation_dictionary_id":{"description":"The ID of the pronunciation dictionary.","title":"Pronunciation Dictionary Id","anyOf":[{"type":"string"},{"type":"null"}]},"version_id":{"description":"The ID of the version of the pronunciation dictionary. If not provided, the latest version will be used.","title":"Version Id","anyOf":[{"type":"string"},{"type":"null"}]}}},"description":"A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request","title":"Pronunciation Dictionary Locators","default":[]},"stability":{"type":"number","maximum":1,"minimum":0,"description":"Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion. Must be one of 0.0, 0.5, 1.0, else it will be rounded to the nearest value.","title":"Stability"},"inputs":{"type":"array","description":"A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.","title":"Inputs","items":{"type":"object","x-fal-order-properties":["text","voice"],"required":["text","voice"],"title":"DialogueBlock","properties":{"text":{"type":"string","description":"The dialogue text","title":"Text"},"voice":{"type":"string","description":"The name or the ID of the voice to be used for the generation.","title":"Voice"}}}}},"required":["inputs"],"additionalProperties":false},"Input_fal_elevenlabs_sound_effects_v2":{"type":"object","properties":{"output_format":{"type":"string","default":"mp3_44100_128","description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.","title":"Output Format","enum":["mp3_22050_32","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"]},"duration_seconds":{"type":"number","maximum":22,"minimum":0.5,"description":"Duration in seconds (0.5-22). If None, optimal duration will be determined from prompt.","title":"Duration Seconds"},"text":{"type":"string","description":"The text describing the sound effect to generate","title":"Text","maxLength":450},"prompt_influence":{"type":"number","minimum":0,"maximum":1,"description":"How closely to follow the prompt (0-1). Higher values mean less variation.","title":"Prompt Influence","default":0.3},"loop":{"type":"boolean","description":"Whether to create a sound effect that loops smoothly.","title":"Loop","default":false}},"required":["text"],"additionalProperties":false},"Input_fal_elevenlabs_music":{"type":"object","properties":{"output_format":{"type":"string","default":"mp3_44100_128","description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.","title":"Output Format","enum":["mp3_22050_32","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"]},"music_length_ms":{"type":"integer","maximum":600000,"minimum":3000,"description":"The length of the song to generate in milliseconds. Used only in conjunction with prompt. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.","title":"Music Length Ms","default":60000},"force_instrumental":{"type":"boolean","description":"If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the prompt. Can only be used with prompt.","title":"Force Instrumental","default":false},"prompt":{"type":"string","maxLength":4100,"description":"The text prompt describing the music to generate","title":"Prompt"}},"additionalProperties":false},"Input_fal_elevenlabs_speech_to_text":{"type":"object","properties":{"tag_audio_events":{"type":"boolean","description":"Tag audio events like laughter, applause, etc.","title":"Tag Audio Events","default":true},"diarize":{"type":"boolean","description":"Whether to annotate who is speaking","title":"Diarize","default":true},"language_code":{"type":"string","description":"Language code of the audio","title":"Language Code"},"audio_url":{"type":"string","description":"URL of the audio file to transcribe","title":"Audio Url"},"max_minutes":{"type":"number","minimum":0.05,"maximum":60,"default":10,"description":"Upper bound of the input audio length, in minutes (default 10, max 60). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["audio_url"],"additionalProperties":false},"Input_fal_elevenlabs_scribe_v2":{"type":"object","properties":{"tag_audio_events":{"type":"boolean","description":"Tag audio events like laughter, applause, etc.","title":"Tag Audio Events","default":true},"diarize":{"type":"boolean","description":"Whether to annotate who is speaking","title":"Diarize","default":true},"language_code":{"type":"string","description":"Language code of the audio","title":"Language Code"},"audio_url":{"type":"string","description":"URL of the audio file to transcribe","title":"Audio Url"},"keyterms":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Words or sentences to bias the model towards transcribing. Up to 100 keyterms, max 50 characters each. Adds 30% premium over base transcription price.","title":"Keyterms","default":[]},"max_minutes":{"type":"number","minimum":0.05,"maximum":60,"default":10,"description":"Upper bound of the input audio length, in minutes (default 10, max 60). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["audio_url"],"additionalProperties":false},"Input_fal_elevenlabs_audio_isolation":{"type":"object","properties":{"video_url":{"type":"string","description":"Video file to use for audio isolation. Either `audio_url` or `video_url` must be provided.","title":"Video Url"},"audio_url":{"type":"string","description":"URL of the audio file to isolate voice from","title":"Audio Url"},"max_minutes":{"type":"number","minimum":0.05,"maximum":60,"default":10,"description":"Upper bound of the input audio length, in minutes (default 10, max 60). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"additionalProperties":false},"Input_fal_elevenlabs_voice_changer":{"type":"object","properties":{"output_format":{"type":"string","default":"mp3_44100_128","description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.","title":"Output Format","enum":["mp3_22050_32","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"]},"voice":{"type":"string","description":"The voice to use for speech generation","title":"Voice","default":"Rachel"},"audio_url":{"type":"string","description":"The input audio file","title":"Audio Url"},"seed":{"type":"integer","description":"Random seed for reproducibility.","title":"Seed"},"remove_background_noise":{"type":"boolean","description":"If set, will remove the background noise from your audio input using our audio isolation model.","title":"Remove Background Noise","default":false},"max_minutes":{"type":"number","minimum":0.05,"maximum":60,"default":10,"description":"Upper bound of the input audio length, in minutes (default 10, max 60). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["audio_url"],"additionalProperties":false},"Input_fal_elevenlabs_dubbing":{"type":"object","properties":{"num_speakers":{"type":"integer","maximum":50,"minimum":1,"description":"Number of speakers in the audio. If not provided, will be auto-detected.","title":"Num Speakers"},"video_url":{"type":"string","description":"URL of the video file to dub. Either audio_url or video_url must be provided. If both are provided, video_url takes priority.","title":"Video Url"},"audio_url":{"type":"string","description":"URL of the audio file to dub. Either audio_url or video_url must be provided.","title":"Audio Url"},"source_lang":{"type":"string","description":"Source language code. If not provided, will be auto-detected.","title":"Source Lang"},"target_lang":{"type":"string","description":"Target language code for dubbing (ISO 639-1)","title":"Target Lang"},"highest_resolution":{"type":"boolean","description":"Whether to use the highest resolution for dubbing.","title":"Highest Resolution","default":true},"max_minutes":{"type":"number","minimum":1,"maximum":60,"default":5,"description":"Upper bound of the input media length, in minutes (default 5, max 60). The reservation is this bound at the unit price; after the call the minutes fal meters are billed and the rest is refunded. Declare at least the real amount: a larger input is still processed but is never billed above the reservation."}},"required":["target_lang"],"additionalProperties":false},"Input_exa_search":{"type":"object","properties":{"includeDomains":{"anyOf":[{"maxItems":1200,"type":"array","items":{"type":"string"},"description":"List of domains or domain paths to include in the search. Each entry can be a hostname (for example, `example.com`), a hostname with a path prefix (for example, `example.com/docs`), or a wildcard subdomain (for example, `*.example.com`). If specified, results will only come from the matching domains or paths. Use this parameter for domain or path filtering instead of adding a `site:` operator to the query."},{"type":"null"}]},"excludeDomains":{"anyOf":[{"maxItems":1200,"type":"array","items":{"type":"string"},"description":"List of domains or domain paths to exclude from search results. Each entry can be a hostname (for example, `example.com`), a hostname with a path prefix (for example, `example.com/docs`), or a wildcard subdomain (for example, `*.example.com`). If specified, no results will be returned from the matching domains or paths. Use this parameter for domain or path filtering instead of adding a `site:` operator to the query."},{"type":"null"}]},"startPublishedDate":{"anyOf":[{"type":"string","description":"Only links with a published date after this will be returned. Must be specified in ISO 8601 format.","format":"date-time"},{"type":"null"}]},"endPublishedDate":{"anyOf":[{"type":"string","description":"Only links with a published date before this will be returned. Must be specified in ISO 8601 format.","format":"date-time"},{"type":"null"}]},"numResults":{"anyOf":[{"type":"integer","minimum":1,"maximum":100,"description":"Number of results to return. Limits vary by search type. The maximum public limit is 100 results. Contact sales (hello@exa.ai) to discuss higher limits.","default":10},{"type":"null"}]},"moderation":{"anyOf":[{"type":"boolean","description":"Enable content moderation to filter unsafe content from search results.","default":false},{"type":"null"}]},"contents":{"anyOf":[{"type":"object","properties":{"text":{"anyOf":[{"description":"Text extraction options for each result.","oneOf":[{"type":"boolean","title":"Simple text retrieval","description":"If true, returns full page text with default settings. If false, disables text return.","default":false},{"type":"object","properties":{"maxCharacters":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000,"description":"Maximum character limit for the full page text. Useful for controlling response size and API costs. Maximum supported value is 10000."},{"type":"null"}]},"includeHtmlTags":{"anyOf":[{"type":"boolean","description":"If true, include lightweight HTML tags in returned text instead of plain markdown-style text. Use maxAgeHours: 0 when you need this applied to freshly fetched content.","default":false},{"type":"null"}]},"verbosity":{"anyOf":[{"type":"string","enum":["compact","standard","full"],"description":"Controls text rendering verbosity. compact focuses on main content, standard includes more surrounding page context, and full requests the most complete rendered text. Some pages may produce identical standard and full output. Use maxAgeHours: 0 when you need this applied to freshly fetched content.","default":"compact"},{"type":"null"}]},"includeSections":{"anyOf":[{"type":"array","items":{"type":"string","enum":["header","navigation","banner","body","sidebar","footer","metadata"]},"description":"Best-effort. Only include content classified into these semantic page sections. Section classification may be unavailable or incomplete for some pages; validate output if strict filtering is required. Use maxAgeHours: 0 when you need this applied to freshly fetched content."},{"type":"null"}]},"excludeSections":{"anyOf":[{"type":"array","items":{"type":"string","enum":["header","navigation","banner","body","sidebar","footer","metadata"]},"description":"Exclude content classified into these semantic page sections. Section classification is best-effort. Use maxAgeHours: 0 when you need this applied to freshly fetched content."},{"type":"null"}]}},"title":"Advanced text options","description":"Advanced options for controlling text extraction. Use this when you need to limit text length or include HTML structure."}]},{"type":"null"}]},"highlights":{"anyOf":[{"description":"Text snippets the LLM identifies as most relevant from each page.","oneOf":[{"type":"boolean","title":"Simple highlights retrieval","description":"If true, returns highlights with default settings. If false, disables highlights.","default":false},{"type":"object","properties":{"query":{"anyOf":[{"type":"string","description":"Custom query that guides which highlights the LLM picks."},{"type":"null"}]},"verbosity":{"anyOf":[{"type":"string","enum":["low","medium","high"],"description":"Preset highlight length: `low`, `medium`, and `high` allocate progressively larger token budgets for the returned highlights. With highlights.dynamic, the preset sets a single shared budget across the whole result set instead of a per-URL budget. Exact budgets are tuned by Exa and may change. Not compatible with maxCharacters or numSentences. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `verbosity` without it are rejected.","x-exa-lifecycle":"beta","x-exa-beta-flag":"dynamic-highlights-2026-08-28","x-mint":{"post":["Beta"]}},{"type":"null"}]},"dynamic":{"anyOf":[{"type":"boolean","description":"Enable Dynamic Highlights (research preview): considers all results together and allocates a single shared context budget across the result set instead of a per-document budget. Not compatible with maxCharacters. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `dynamic` without it are rejected.","x-exa-lifecycle":"beta","x-exa-beta-flag":"dynamic-highlights-2026-08-28","x-mint":{"post":["Beta"]}},{"type":"null"}]},"maxCharacters":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000,"description":"Maximum number of characters to return for highlights. Controls the total length of highlight text returned per URL. Maximum supported value is 10000. Not compatible with highlights.dynamic."},{"type":"null"}]},"numSentences":{"anyOf":[{"type":"integer","minimum":1,"description":"Deprecated and will be removed in a future release. Currently mapped to a character budget of about 1333 characters per sentence. Pass highlights: true for default highlights, or { query } to guide selection with your own query."},{"type":"null"}]},"highlightsPerUrl":{"anyOf":[{"type":"integer","minimum":1,"description":"Deprecated and will be removed in a future release. Currently ignored. Pass highlights: true for default highlights, or { query } to guide selection with your own query."},{"type":"null"}]}},"title":"Advanced highlights options","description":"Advanced options for steering highlight extraction. Pass highlights: true for the highest-quality default; supply this object only when you need to guide selection with your own query."}]},{"type":"null"}]},"summary":{"anyOf":[{"type":"object","properties":{"query":{"anyOf":[{"type":"string","description":"Custom query for the LLM-generated summary."},{"type":"null"}]},"schema":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"JSON schema for structured output from summary. See https://json-schema.org/overview/what-is-jsonschema for JSON Schema documentation."},{"type":"null"}]}},"description":"Summary of the webpage."},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","properties":{"links":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of URLs to return from each webpage.","default":0},{"type":"null"}]},"imageLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of images to return for each result.","default":0},{"type":"null"}]},"richImageLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of rich image links to return for each result.","default":0},{"type":"null"}]},"richLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of rich links to return for each result.","default":0},{"type":"null"}]},"codeBlocks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of code blocks to return for each result.","default":0},{"type":"null"}]}},"description":"Extra parameters to pass."},{"type":"null"}]},"livecrawlTimeout":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":90000,"description":"The timeout for livecrawling in milliseconds.","default":10000},{"type":"null"}]},"maxAgeHours":{"anyOf":[{"type":"integer","minimum":-1,"maximum":720,"description":"Maximum age of cached content in hours. Positive values use cached content if it is less than this many hours old; 0 fetches fresh content and is the supported way to apply text rendering options to newly fetched pages; -1 always uses cache; omitted uses fallback fetching when cached content is unavailable. Maximum supported value is 720 hours."},{"type":"null"}]},"subpages":{"anyOf":[{"type":"integer","minimum":0,"maximum":100,"description":"The number of subpages to crawl. The actual number crawled may be limited by system constraints.","default":0},{"type":"null"}]},"subpageTarget":{"anyOf":[{"description":"Term to find specific subpages of search results. Can be a single string or an array of strings.","oneOf":[{"type":"string","minLength":1,"maxLength":100},{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}]},{"type":"null"}]}}},{"type":"null"}]},"query":{"type":"string","minLength":1,"description":"The query string for the search."},"additionalQueries":{"anyOf":[{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string"},"description":"Additional query variations for deep-search variants. Only works with a deep-search type. When provided, these queries are used alongside the main query for broader results."},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["instant","fast","auto","deep-lite","deep","deep-reasoning"],"description":"The search mode to use. `auto` (default) is a balanced mode that optimizes for both quality and speed and is recommended for most applications. `fast` returns high-quality results with reduced latency, making it a good fit for user-facing search and interactive workflows. `instant` is optimized for minimum response time, trading some search depth for speed in real-time experiences such as chat, voice agents, and autocomplete. `deep-lite` performs lightweight research with synthesized results and a consistent 4-second latency, lower than full deep search. `deep` conducts comprehensive multi-step research with synthesis, while `deep-reasoning` adds stronger reasoning for complex analysis and decision-making tasks.","default":"auto"},{"type":"null"}]},"category":{"anyOf":[{"type":"string","enum":["company","publication","news","personal site","financial report","people"],"description":"A data category to focus on. Known categories include `company`, `publication`, `news`, `personal site`, `financial report`, and `people`. Other strings are accepted and used as category hints for search. The `people` and `company` categories have improved quality for finding people profiles and company pages. The `publication` category surfaces scholarly publications such as research papers, preprints, and journal articles, with structured metadata like authors, venue, and citations. Note: The `company` and `people` categories only support a limited set of filters. The following parameters are NOT supported for these categories: `startPublishedDate`, `endPublishedDate`, `excludeDomains`. Using unsupported parameters will result in a 400 error."},{"type":"null"}]},"userLocation":{"anyOf":[{"type":"string","description":"The two-letter ISO country code of the user, e.g. US."},{"type":"null"}]},"outputSchema":{"anyOf":[{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"description":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"object"},"description":{"type":"string"},"properties":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},"required":{"type":"array","items":{"type":"string"}},"additionalProperties":{"type":"boolean"}},"required":["type"],"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}],"description":"JSON schema for synthesized output. Supported root types are \"text\" and \"object\". When provided, the response includes an output object whose content matches this schema. Works with every search type and adds about 2 seconds of synthesis latency on top of the selected search type.","type":"object"},{"type":"null"}]},"systemPrompt":{"anyOf":[{"type":"string","description":"Additional instructions that guide generated output or agent behavior. Use this for source preferences, novelty constraints, duplication constraints, or other behavior guidance."},{"type":"null"}]}},"required":["query"],"additionalProperties":false},"Input_exa_contents":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":2048},"description":"Document IDs obtained from searches."},"urls":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":2048},"description":"URLs to crawl (backwards compatible with the `ids` parameter)."},"text":{"anyOf":[{"description":"Text extraction options for each result.","oneOf":[{"type":"boolean","title":"Simple text retrieval","description":"If true, returns full page text with default settings. If false, disables text return.","default":false},{"type":"object","properties":{"maxCharacters":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000,"description":"Maximum character limit for the full page text. Useful for controlling response size and API costs. Maximum supported value is 10000."},{"type":"null"}]},"includeHtmlTags":{"anyOf":[{"type":"boolean","description":"If true, include lightweight HTML tags in returned text instead of plain markdown-style text. Use maxAgeHours: 0 when you need this applied to freshly fetched content.","default":false},{"type":"null"}]},"verbosity":{"anyOf":[{"type":"string","enum":["compact","standard","full"],"description":"Controls text rendering verbosity. compact focuses on main content, standard includes more surrounding page context, and full requests the most complete rendered text. Some pages may produce identical standard and full output. Use maxAgeHours: 0 when you need this applied to freshly fetched content.","default":"compact"},{"type":"null"}]},"includeSections":{"anyOf":[{"type":"array","items":{"type":"string","enum":["header","navigation","banner","body","sidebar","footer","metadata"]},"description":"Best-effort. Only include content classified into these semantic page sections. Section classification may be unavailable or incomplete for some pages; validate output if strict filtering is required. Use maxAgeHours: 0 when you need this applied to freshly fetched content."},{"type":"null"}]},"excludeSections":{"anyOf":[{"type":"array","items":{"type":"string","enum":["header","navigation","banner","body","sidebar","footer","metadata"]},"description":"Exclude content classified into these semantic page sections. Section classification is best-effort. Use maxAgeHours: 0 when you need this applied to freshly fetched content."},{"type":"null"}]}},"title":"Advanced text options","description":"Advanced options for controlling text extraction. Use this when you need to limit text length or include HTML structure."}]},{"type":"null"}]},"highlights":{"anyOf":[{"description":"Text snippets the LLM identifies as most relevant from each page.","oneOf":[{"type":"boolean","title":"Simple highlights retrieval","description":"If true, returns highlights with default settings. If false, disables highlights.","default":false},{"type":"object","properties":{"query":{"anyOf":[{"type":"string","description":"Custom query that guides which highlights the LLM picks."},{"type":"null"}]},"verbosity":{"anyOf":[{"type":"string","enum":["low","medium","high"],"description":"Preset highlight length: `low`, `medium`, and `high` allocate progressively larger token budgets for the returned highlights. With highlights.dynamic, the preset sets a single shared budget across the whole result set instead of a per-URL budget. Exact budgets are tuned by Exa and may change. Not compatible with maxCharacters or numSentences. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `verbosity` without it are rejected.","x-exa-lifecycle":"beta","x-exa-beta-flag":"dynamic-highlights-2026-08-28","x-mint":{"post":["Beta"]}},{"type":"null"}]},"dynamic":{"anyOf":[{"type":"boolean","description":"Enable Dynamic Highlights (research preview): considers all results together and allocates a single shared context budget across the result set instead of a per-document budget. Not compatible with maxCharacters. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `dynamic` without it are rejected.","x-exa-lifecycle":"beta","x-exa-beta-flag":"dynamic-highlights-2026-08-28","x-mint":{"post":["Beta"]}},{"type":"null"}]},"maxCharacters":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000,"description":"Maximum number of characters to return for highlights. Controls the total length of highlight text returned per URL. Maximum supported value is 10000. Not compatible with highlights.dynamic."},{"type":"null"}]},"numSentences":{"anyOf":[{"type":"integer","minimum":1,"description":"Deprecated and will be removed in a future release. Currently mapped to a character budget of about 1333 characters per sentence. Pass highlights: true for default highlights, or { query } to guide selection with your own query."},{"type":"null"}]},"highlightsPerUrl":{"anyOf":[{"type":"integer","minimum":1,"description":"Deprecated and will be removed in a future release. Currently ignored. Pass highlights: true for default highlights, or { query } to guide selection with your own query."},{"type":"null"}]}},"title":"Advanced highlights options","description":"Advanced options for steering highlight extraction. Pass highlights: true for the highest-quality default; supply this object only when you need to guide selection with your own query."}]},{"type":"null"}]},"summary":{"anyOf":[{"type":"object","properties":{"query":{"anyOf":[{"type":"string","description":"Custom query for the LLM-generated summary."},{"type":"null"}]},"schema":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"JSON schema for structured output from summary. See https://json-schema.org/overview/what-is-jsonschema for JSON Schema documentation."},{"type":"null"}]}},"description":"Summary of the webpage."},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","properties":{"links":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of URLs to return from each webpage.","default":0},{"type":"null"}]},"imageLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of images to return for each result.","default":0},{"type":"null"}]},"richImageLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of rich image links to return for each result.","default":0},{"type":"null"}]},"richLinks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of rich links to return for each result.","default":0},{"type":"null"}]},"codeBlocks":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000,"description":"Number of code blocks to return for each result.","default":0},{"type":"null"}]}},"description":"Extra parameters to pass."},{"type":"null"}]},"livecrawlTimeout":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":90000,"description":"The timeout for livecrawling in milliseconds.","default":10000},{"type":"null"}]},"maxAgeHours":{"anyOf":[{"type":"integer","minimum":-1,"maximum":720,"description":"Maximum age of cached content in hours. Positive values use cached content if it is less than this many hours old; 0 fetches fresh content and is the supported way to apply text rendering options to newly fetched pages; -1 always uses cache; omitted uses fallback fetching when cached content is unavailable. Maximum supported value is 720 hours."},{"type":"null"}]},"subpages":{"anyOf":[{"type":"integer","minimum":0,"maximum":100,"description":"The number of subpages to crawl. The actual number crawled may be limited by system constraints.","default":0},{"type":"null"}]},"subpageTarget":{"anyOf":[{"description":"Term to find specific subpages of search results. Can be a single string or an array of strings.","oneOf":[{"type":"string","minLength":1,"maxLength":100},{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}]},{"type":"null"}]}},"additionalProperties":false},"Input_exa_answer":{"type":"object","properties":{"query":{"type":"string","minLength":1,"description":"Natural-language question or instructions for the request."},"text":{"type":"boolean","title":"Simple text retrieval","description":"If true, returns full page text with default settings. If false, disables text return.","default":false},"model":{"description":"The model used to generate the answer.","default":"exa","type":"string","enum":["exa","exa-pro","exa-research","exa-fast"]},"systemPrompt":{"type":"string","description":"Additional instructions that guide generated output or agent behavior. Use this for source preferences, novelty constraints, duplication constraints, or other behavior guidance."},"userLocation":{"anyOf":[{"type":"string","description":"The two-letter ISO country code of the user, e.g. US."},{"type":"null"}]},"outputSchema":{"type":"object","properties":{"type":{"type":"string","description":"The root schema type (typically \"object\")."},"properties":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"An object where each key is a property name and each value is a JSON Schema describing that property (with `type`, `description`, etc)."},"required":{"type":"array","items":{"type":"string"},"description":"List of required property names."},"description":{"type":"string","description":"A description of the schema."},"additionalProperties":{"type":"boolean","description":"Whether to allow properties not listed in `properties`.","default":false}},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"A [JSON Schema Draft 7](https://json-schema.org/draft-07) specification for the desired answer structure. When provided, the answer is returned as a structured object matching the schema instead of a plain string."}},"required":["query"],"additionalProperties":false},"Input_exa_agent_run":{"type":"object","properties":{"Accept":{"description":"Set to `text/event-stream` to receive server-sent events.","type":"string","enum":["application/json","text/event-stream"]},"Exa-Beta":{"description":"Comma-separated beta feature tokens for opting into experimental features.","type":"string"},"query":{"type":"string","minLength":1,"description":"Natural-language question or instructions for the request."},"systemPrompt":{"type":"string","description":"Additional instructions that guide generated output or agent behavior. Use this for source preferences, novelty constraints, duplication constraints, or other behavior guidance."},"input":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"A JSON object record."},"description":"Records the agent should process or enrich."},"exclusion":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"A JSON object record."},"description":"Records or entities the agent should avoid returning."}},"description":"Records to process and records or entities to exclude from the answer."},"outputSchema":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"Any JSON value.","oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]},"description":"JSON Schema for validated structured output in `output.structured`. Fields unsupported by evidence may be returned as `null`. Supports draft-07, 2019-09, and 2020-12 via `$schema`."},{"type":"null"}]},"effort":{"type":"string","enum":["minimal","low","medium","high","xhigh","auto","max"],"description":"Cost and reasoning effort preference for the run. `auto` lets Exa choose the appropriate effort. `max` is the highest-effort public beta tier for work where completeness and thoroughness matter more than latency or cost, including large list building, deep multi-source research, and criteria that are hard to verify.","default":"auto"},"previousRunId":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_.:-]+$","description":"Agent run ID. New run IDs are returned with the `agent_run_` prefix."},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Caller-provided metadata stored with the run."},"dataSources":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"provider":{"type":"string","enum":["fiber","financial_datasets","similarweb","baselayer","affiliate","particle","jinko","polymarket"],"description":"Identifier of an Exa Connect data provider."}},"required":["provider"]},"description":"Exa Connect data providers to enable for the run. Each entry enables all of that provider's tools."},"budget":{"type":"object","properties":{"maxCostDollars":{"type":"number","description":"Maximum amount this run can spend in US dollars. Accepts $1–$100 and applies only to `auto` and `max`; when omitted, the default cap is $5 for `auto` and $20 for `max`."}},"description":"Optional per-run spending limit for the metered `auto` and `max` efforts. Runs that finish early may cost less than the limit."}},"required":["query"],"additionalProperties":false},"Input_exa_agent_run_get":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_.:-]+$","description":"Agent run ID. New run IDs are returned with the `agent_run_` prefix."}},"required":["id"],"additionalProperties":false},"Input_exa_agent_run_events":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_.:-]+$","description":"Agent run ID. New run IDs are returned with the `agent_run_` prefix."},"limit":{"type":"integer","minimum":1,"maximum":100,"description":"Number of results per page","default":20},"cursor":{"type":"string","description":"Cursor for pagination. Use the `nextCursor` value from the previous event list response."},"Accept":{"description":"Set to `text/event-stream` to receive server-sent events.","type":"string","enum":["application/json","text/event-stream"]},"Last-Event-ID":{"description":"For SSE replay, return only events after this event ID.","type":"string"}},"required":["id"],"additionalProperties":false},"Input_exa_agent_run_stop":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_.:-]+$","description":"Agent run ID. New run IDs are returned with the `agent_run_` prefix."},"Exa-Beta":{"description":"Comma-separated beta feature tokens for opting into experimental features.","type":"string"}},"required":["id"],"additionalProperties":false},"Input_exa_agent_run_cancel":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_.:-]+$","description":"Agent run ID. New run IDs are returned with the `agent_run_` prefix."}},"required":["id"],"additionalProperties":false},"Input_exa_similarweb":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Similarweb, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Similarweb data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Similarweb\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":5,"description":"Ceiling reserved for this run, effort plus Similarweb calls (default $0.325, at most $5). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_financial_datasets":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Financial Datasets, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Financial Datasets data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Financial Datasets\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":5,"description":"Ceiling reserved for this run, effort plus Financial Datasets calls (default $0.225, at most $5). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_fiber":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Fiber.ai, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Fiber.ai data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Fiber.ai\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":20,"description":"Ceiling reserved for this run, effort plus Fiber.ai calls (default $1.025, at most $20). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_baselayer":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Baselayer, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Baselayer data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Baselayer\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":20,"description":"Ceiling reserved for this run, effort plus Baselayer calls (default $2.025, at most $20). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_affiliate":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Affiliate.com, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Affiliate.com data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Affiliate.com\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":5,"description":"Ceiling reserved for this run, effort plus Affiliate.com calls (default $0.25, at most $5). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_particle":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Particle, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Particle data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Particle\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":5,"description":"Ceiling reserved for this run, effort plus Particle calls (default $0.25, at most $5). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_jinko":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Jinko, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Jinko data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Jinko\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":5,"description":"Ceiling reserved for this run, effort plus Jinko calls (default $0.125, at most $5). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_exa_polymarket":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"What you want from Polymarket, in natural language. Be explicit about the entities (domains, tickers, company names, routes, dates) and the fields you expect."},"output_schema":{"type":"object","description":"Optional JSON Schema for the structured answer (returned in output.structured). Name each field after the Polymarket data you want, e.g. {\"type\":\"object\",\"required\":[\"domain\",\"monthlyVisits\"],\"properties\":{\"domain\":{\"type\":\"string\"},\"monthlyVisits\":{\"type\":\"number\",\"description\":\"from Polymarket\"}}}."},"effort":{"type":"string","enum":["minimal","low","medium","high"],"default":"low","description":"Exa Agent effort: minimal $0.012 (one quick lookup), low $0.025 (default), medium $0.10, high $0.50, plus partner calls."},"max_cost_usd":{"type":"number","minimum":0.012,"maximum":2,"description":"Ceiling reserved for this run, effort plus Polymarket calls (default $0.025, at most $2). The real cost Exa reports is billed, never more than this."}},"required":["query"],"additionalProperties":false},"Input_x_search_recent":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4096},"max_results":{"type":"integer","minimum":10,"maximum":100,"format":"int32","default":10},"next_token":{"type":"string","minLength":1,"description":"A base32hex-encoded pagination token."},"pagination_token":{"type":"string","minLength":1,"description":"A base32hex-encoded pagination token."},"start_time":{"type":"string","format":"date-time","description":"Must be within the last 7 days."},"end_time":{"type":"string","format":"date-time"},"since_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"until_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"sort_order":{"type":"string","enum":["recency","relevancy"]},"post.fields":{"type":"array","description":"The fields available for a Post object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article","article_title","attachments","card_uri","community_id","context_annotations","conversation_id","created_at","display_text_range","edit_controls","entities","geo","id","lang","matched_media_notes","media_metadata","non_public_metrics","note_post","note_request_suggestions","organic_metrics","paid_partnership","possibly_sensitive","promoted_metrics","public_metrics","reply_settings","scopes","source","suggested_source_links","suggested_source_links_with_counts","text","withheld"]}},"expansions":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article.cover_media","article.media_entities","attachments.media_keys","attachments.media_source_tweet","attachments.poll_ids","author_id","edit_history_post_ids","entities.mentions.username","geo.place_id","in_reply_to_user_id","referenced_posts","username"]},"description":"A comma separated list of fields to expand."},"user.fields":{"type":"array","description":"The fields available for a User object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["confirmed_email","connection_status","created_at","description","entities","id","is_identity_verified","location","name","parody","profile_banner_url","profile_image_url","protected","public_metrics","receives_your_dm","subscriber_count","subscribes_to_you","subscription","subscription_type","url","username","verified","verified_followers_count","verified_type","withheld"]}},"media.fields":{"type":"array","description":"The fields available for a Media object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["alt_text","duration_ms","height","media_key","non_public_metrics","organic_metrics","preview_image_url","promoted_metrics","public_metrics","type","url","variants","width"]}},"poll.fields":{"type":"array","description":"The fields available for a Poll object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["duration_minutes","end_datetime","id","options","voting_status"]}},"place.fields":{"type":"array","description":"The fields available for a Place object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["contained_within","country","country_code","full_name","geo","id","name","place_type"]}}},"required":["query"],"additionalProperties":false},"Input_x_search_all":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4096},"start_time":{"type":"string","format":"date-time"},"end_time":{"type":"string","format":"date-time"},"since_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"until_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"max_results":{"type":"integer","minimum":10,"maximum":500,"format":"int32","default":10},"next_token":{"type":"string","minLength":1,"description":"A base32hex-encoded pagination token."},"pagination_token":{"type":"string","minLength":1,"description":"A base32hex-encoded pagination token."},"sort_order":{"type":"string","enum":["recency","relevancy"]},"post.fields":{"type":"array","description":"The fields available for a Post object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article","article_title","attachments","card_uri","community_id","context_annotations","conversation_id","created_at","display_text_range","edit_controls","entities","geo","id","lang","matched_media_notes","media_metadata","non_public_metrics","note_post","note_request_suggestions","organic_metrics","paid_partnership","possibly_sensitive","promoted_metrics","public_metrics","reply_settings","scopes","source","suggested_source_links","suggested_source_links_with_counts","text","withheld"]}},"expansions":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article.cover_media","article.media_entities","attachments.media_keys","attachments.media_source_tweet","attachments.poll_ids","author_id","edit_history_post_ids","entities.mentions.username","geo.place_id","in_reply_to_user_id","referenced_posts","username"]},"description":"A comma separated list of fields to expand."},"user.fields":{"type":"array","description":"The fields available for a User object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["confirmed_email","connection_status","created_at","description","entities","id","is_identity_verified","location","name","parody","profile_banner_url","profile_image_url","protected","public_metrics","receives_your_dm","subscriber_count","subscribes_to_you","subscription","subscription_type","url","username","verified","verified_followers_count","verified_type","withheld"]}},"media.fields":{"type":"array","description":"The fields available for a Media object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["alt_text","duration_ms","height","media_key","non_public_metrics","organic_metrics","preview_image_url","promoted_metrics","public_metrics","type","url","variants","width"]}},"poll.fields":{"type":"array","description":"The fields available for a Poll object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["duration_minutes","end_datetime","id","options","voting_status"]}},"place.fields":{"type":"array","description":"The fields available for a Place object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["contained_within","country","country_code","full_name","geo","id","name","place_type"]}}},"required":["query"],"additionalProperties":false},"Input_x_posts_by_ids":{"type":"object","properties":{"ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","description":"Unique identifier of a Post","pattern":"^[0-9]{1,19}$"}},"post.fields":{"type":"array","description":"The fields available for a Post object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article","article_title","attachments","card_uri","community_id","context_annotations","conversation_id","created_at","display_text_range","edit_controls","entities","geo","id","lang","matched_media_notes","media_metadata","non_public_metrics","note_post","note_request_suggestions","organic_metrics","paid_partnership","possibly_sensitive","promoted_metrics","public_metrics","reply_settings","scopes","source","suggested_source_links","suggested_source_links_with_counts","text","withheld"]}},"expansions":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article.cover_media","article.media_entities","attachments.media_keys","attachments.media_source_tweet","attachments.poll_ids","author_id","edit_history_post_ids","entities.mentions.username","geo.place_id","in_reply_to_user_id","referenced_posts","username"]},"description":"A comma separated list of fields to expand."},"user.fields":{"type":"array","description":"The fields available for a User object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["confirmed_email","connection_status","created_at","description","entities","id","is_identity_verified","location","name","parody","profile_banner_url","profile_image_url","protected","public_metrics","receives_your_dm","subscriber_count","subscribes_to_you","subscription","subscription_type","url","username","verified","verified_followers_count","verified_type","withheld"]}},"media.fields":{"type":"array","description":"The fields available for a Media object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["alt_text","duration_ms","height","media_key","non_public_metrics","organic_metrics","preview_image_url","promoted_metrics","public_metrics","type","url","variants","width"]}},"poll.fields":{"type":"array","description":"The fields available for a Poll object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["duration_minutes","end_datetime","id","options","voting_status"]}},"place.fields":{"type":"array","description":"The fields available for a Place object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["contained_within","country","country_code","full_name","geo","id","name","place_type"]}}},"required":["ids"],"additionalProperties":false},"Input_x_users_by_usernames":{"type":"object","properties":{"usernames":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","pattern":"^[A-Za-z0-9_]{1,15}$"}},"user.fields":{"type":"array","description":"The fields available for a User object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["confirmed_email","connection_status","created_at","description","entities","id","is_identity_verified","location","name","parody","profile_banner_url","profile_image_url","protected","public_metrics","receives_your_dm","subscriber_count","subscribes_to_you","subscription","subscription_type","url","username","verified","verified_followers_count","verified_type","withheld"]}},"expansions":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["affiliation","most_recent_post_id","pinned_post_id"]},"description":"A comma separated list of fields to expand."},"post.fields":{"type":"array","description":"The fields available for a Post object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article","article_title","attachments","card_uri","community_id","context_annotations","conversation_id","created_at","display_text_range","edit_controls","entities","geo","id","lang","matched_media_notes","media_metadata","non_public_metrics","note_post","note_request_suggestions","organic_metrics","paid_partnership","possibly_sensitive","promoted_metrics","public_metrics","reply_settings","scopes","source","suggested_source_links","suggested_source_links_with_counts","text","withheld"]}}},"required":["usernames"],"additionalProperties":false},"Input_x_user_posts":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a User","pattern":"^[0-9]{1,19}$"},"max_results":{"type":"integer","minimum":5,"maximum":100,"format":"int32"},"pagination_token":{"type":"string","minLength":1,"description":"A base32hex-encoded pagination token."},"start_time":{"type":"string","format":"date-time","description":"Must be on or after 2010-11-06."},"end_time":{"type":"string","format":"date-time","description":"Must be on or after 2010-11-06."},"since_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"until_id":{"type":"string","pattern":"^[0-9]{1,19}$"},"exclude":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["replies","retweets"]}},"post.fields":{"type":"array","description":"The fields available for a Post object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article","article_title","attachments","card_uri","community_id","context_annotations","conversation_id","created_at","display_text_range","edit_controls","entities","geo","id","lang","matched_media_notes","media_metadata","non_public_metrics","note_post","note_request_suggestions","organic_metrics","paid_partnership","possibly_sensitive","promoted_metrics","public_metrics","reply_settings","scopes","source","suggested_source_links","suggested_source_links_with_counts","text","withheld"]}},"expansions":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["article.cover_media","article.media_entities","attachments.media_keys","attachments.media_source_tweet","attachments.poll_ids","author_id","edit_history_post_ids","entities.mentions.username","geo.place_id","in_reply_to_user_id","referenced_posts","username"]},"description":"A comma separated list of fields to expand."},"user.fields":{"type":"array","description":"The fields available for a User object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["confirmed_email","connection_status","created_at","description","entities","id","is_identity_verified","location","name","parody","profile_banner_url","profile_image_url","protected","public_metrics","receives_your_dm","subscriber_count","subscribes_to_you","subscription","subscription_type","url","username","verified","verified_followers_count","verified_type","withheld"]}},"media.fields":{"type":"array","description":"The fields available for a Media object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["alt_text","duration_ms","height","media_key","non_public_metrics","organic_metrics","preview_image_url","promoted_metrics","public_metrics","type","url","variants","width"]}},"poll.fields":{"type":"array","description":"The fields available for a Poll object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["duration_minutes","end_datetime","id","options","voting_status"]}},"place.fields":{"type":"array","description":"The fields available for a Place object.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["contained_within","country","country_code","full_name","geo","id","name","place_type"]}}},"required":["id"],"additionalProperties":false},"Input_xai_x_search":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"The question or task for Grok. Ask for citations to get post or page links."},"instructions":{"type":"string","maxLength":4000,"description":"System instructions: tone, format, language, what to focus on."},"model":{"type":"string","enum":["grok-4.3","grok-4.6"],"default":"grok-4.3","description":"grok-4.3 is cheaper and usually available; grok-4.6 is the strongest and can be at capacity."},"max_output_tokens":{"type":"integer","minimum":64,"maximum":8192,"default":1024,"description":"Cap on answer plus reasoning tokens."},"max_cost_usd":{"type":"number","minimum":0.01,"maximum":5,"description":"Optional spending cap reserved for this call (not sent to xAI). Default reservation: $0.15 for grok-4.3, $0.30 for grok-4.6, plus $0.000006 per requested output token."},"allowed_x_handles":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Only posts from these accounts (without @). Exclusive with excluded_x_handles. Name the account in the query too, or Grok may skip the search."},"excluded_x_handles":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Never posts from these accounts (without @)."},"from_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Earliest post date, YYYY-MM-DD."},"to_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Latest post date, YYYY-MM-DD."},"enable_image_understanding":{"type":"boolean","default":false,"description":"Let Grok look at images in posts (more tokens)."},"enable_video_understanding":{"type":"boolean","default":false,"description":"Let Grok watch videos in posts (more tokens)."}},"required":["query"],"additionalProperties":false},"Input_xai_web_search":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":4000,"description":"The question or task for Grok. Ask for citations to get post or page links."},"instructions":{"type":"string","maxLength":4000,"description":"System instructions: tone, format, language, what to focus on."},"model":{"type":"string","enum":["grok-4.3","grok-4.6"],"default":"grok-4.3","description":"grok-4.3 is cheaper and usually available; grok-4.6 is the strongest and can be at capacity."},"max_output_tokens":{"type":"integer","minimum":64,"maximum":8192,"default":1024,"description":"Cap on answer plus reasoning tokens."},"max_cost_usd":{"type":"number","minimum":0.01,"maximum":5,"description":"Optional spending cap reserved for this call (not sent to xAI). Default reservation: $0.15 for grok-4.3, $0.30 for grok-4.6, plus $0.000006 per requested output token."},"allowed_domains":{"type":"array","items":{"type":"string"},"maxItems":5,"description":"Only these domains (max 5). Exclusive with excluded_domains."},"excluded_domains":{"type":"array","items":{"type":"string"},"maxItems":5,"description":"Never these domains (max 5)."},"enable_image_understanding":{"type":"boolean","default":false,"description":"Let Grok look at images on pages (more tokens)."}},"required":["query"],"additionalProperties":false},"Input_dataforseo_ai_optimization_ai_keyword_data_keywords_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field UTF-8 encoding The maximum number of keywords you can specify: 1000; The maximum number of characters in a single keyword: 250; The keywords will be converted to lowercase format;learn more about rules and limitation","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the http","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_ai_optimization_chat_gpt_llm_responses":{"type":"object","properties":{"user_prompt":{"type":"string","description":"prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field","maxLength":500,"minLength":1},"model_name":{"type":"string","description":"name of the AI model required field model_nameconsists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 ","maxLength":2000,"minLength":1,"enum":["gpt-4.1-mini"],"default":"gpt-4.1-mini"},"max_output_tokens":{"type":"integer","description":"maximum number of tokens in the AI response optional field minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024; minimum value for non-reasoning models: 16; maximum value: 4096; default value: 2048 Note:","maximum":1024,"minimum":16,"default":256},"temperature":{"type":"number","description":"randomness of the AI response optional field higher values make output more diverse; lower values make output more focused; minimum value: 0 maximum value: 2 default value: 0.94 Note: not supported in reasoning models","minimum":0,"maximum":2},"top_p":{"type":"number","description":"diversity of the AI response optional field controls diversity of the response by limiting token selection; minimum value: 0 maximum value: 1 default value: 0.92Note: top_p cannot be used together with temperature in the same request","minimum":0,"maximum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["user_prompt","model_name"],"additionalProperties":false},"Input_dataforseo_ai_optimization_chat_gpt_llm_scraper":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 2000 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as ","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by m"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code; if you use this field, you don't need to specify language_code; you can receive the list of available languages of the search engine with their language_","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name; if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by ","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_ai_optimization_claude_llm_responses":{"type":"object","properties":{"user_prompt":{"type":"string","description":"prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field","maxLength":500,"minLength":1},"model_name":{"type":"string","description":"name of the AI model required field model_nameconsists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; for example, if claude-opus-4-0 is specified, the claude-opus","maxLength":2000,"minLength":1,"enum":["claude-haiku-4-5"],"default":"claude-haiku-4-5"},"max_output_tokens":{"type":"integer","description":"maximum number of tokens in the AI response optional field minimum value: 1; maximum value: 4096; default value: 2048; Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed ","minimum":16,"maximum":1024,"default":256},"temperature":{"type":"number","description":"randomness of the AI response optional field higher values make output more diverse; lower values make output more focused; minimum value: 0 maximum value: 1 default value: 0.7Note: temperature cannot be used together with top_p in the same","minimum":0,"maximum":1},"top_p":{"type":"number","description":"diversity of the AI response optional field controls diversity of the response by limiting token selection; minimum value: 0 maximum value: 1 default value: nullNote: top_p cannot be used together with temperature in the same request","minimum":0,"maximum":1},"use_reasoning":{"type":"boolean","description":"enable reasoning for the AI model optional field when enabled, the model will perform reasoning before generating a response refer to the Models endpoint for a list of models that support reasoning default value: false Note: if set to true,","const":false,"default":false},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["user_prompt","model_name"],"additionalProperties":false},"Input_dataforseo_ai_optimization_gemini_llm_responses":{"type":"object","properties":{"user_prompt":{"type":"string","description":"prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field","maxLength":500,"minLength":1},"model_name":{"type":"string","description":"name of the AI model required field model_nameconsists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; for example, if gemini-1.5-pro is specified, the gemini-1.5-p","maxLength":2000,"minLength":1,"enum":["gemini-2.5-flash-lite"],"default":"gemini-2.5-flash-lite"},"max_output_tokens":{"type":"integer","description":"maximum number of tokens in the AI response optional field minimum value: 1 maximum value: 4096; default value: 2048; Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed t","minimum":16,"maximum":1024,"default":256},"temperature":{"type":"number","description":"randomness of the AI response optional field higher values make output more diverse lower values make output more focused minimum value: 0 maximum value: 2 default value: 1.3","minimum":0,"maximum":2},"top_p":{"type":"number","description":"diversity of the AI response optional field controls diversity of the response by limiting token selection minimum value: 0 maximum value: 1 default value: 0.9","minimum":0,"maximum":1},"use_reasoning":{"type":"boolean","description":"enable reasoning for the AI model optional field when enabled, the model will perform reasoning before generating a response refer to the Models endpoint for a list of models that support reasoning default value: false Note: if set to true,","const":false,"default":false},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["user_prompt","model_name"],"additionalProperties":false},"Input_dataforseo_ai_optimization_gemini_llm_scraper":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 2000 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as ","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code; if you use this field, you don't need to specify language_code; you can receive the list of available languages of the search engine with their language_","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name; if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code_by ","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_ai_optimization_llm_mentions_historical":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"date_from":{"type":"string","description":"start date of the time range optional field minimal value 2025-08-01 date format \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"end date of the time range optional field Note value specified in date_from cannot exceed the value in date_to date format \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_multi_target_metrics":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"target":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"key":{"type":"string","description":"key for grouping the results required field groups results for comparison and serves as a label for the group; you can specify up to 250 characters in the key field","maxLength":250,"minLength":1}},"required":["key"],"additionalProperties":false},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned objects optional fielddefault value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain search_results_domain minimum value: 1 maximum value: 10 default value: 5","minimum":1,"maximum":10,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_search_mentions":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"search_after_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 1000 results in a single request; by specifying the unique search","maxLength":2000},"limit":{"type":"integer","description":"the maximum number of returned objects optional fielddefault value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_target_metrics":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain search_results_domain minimum value: 1 maximum value: 10 default value: 10","minimum":1,"maximum":10,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_target_metrics_lite":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_timeseries_delta":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"date_from":{"type":"string","description":"start date of the time range required field minimal value: 2025-08-01 date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"end date of the time range required field Note:the value specified in date_from cannot exceed the value in date_to date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"group_range":{"type":"string","description":"timeseries delta range required field possible values: day, week, month, year","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target","date_from","date_to","group_range"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_timeseries_new_lost":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"date_from":{"type":"string","description":"start date of the time range required field minimal value: 2025-08-01 date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"end date of the time range required field Note:the value specified in date_from cannot exceed the value in date_to date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"group_range":{"type":"string","description":"timeseries range required field possible values: day, week, month, year","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target","date_from","date_to","group_range"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brand_categories":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: data specific to brand entities is available for chat_gpt only; Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_brand_categories":{"type":"array","description":"array of brand_categories to include in the response optional field if specified, only the listed brand categories will be returned in the items array example: \"include_brand_categories\": [\"business\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_brand_categories":{"type":"array","description":"array of brand categories to exclude from the response optional field if specified, the listed brand categories will be omitted from the items array example: \"exclude_brand_categories\": [\"business\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brand_categories_lite":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: data specific to brand entities is available for chat_gpt only; Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_brand_categories":{"type":"array","description":"array of brand categories to include in the response optional field if specified, only the listed brand categories will be returned in the items array example: [\"company\",\"insurance\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_brand_categories":{"type":"array","description":"array of brand categories to exclude from the response optional field if specified, the listed brand categories will be omitted from the items array example: [\"company\",\"insurance\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brands":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: data specific to brand entities is available for chat_gpt only; Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_brands":{"type":"array","description":"array of brands to include in the response optional field if specified, only the listed brands will be returned in the items array example: \"include_brands\": [\"Audi\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_brands":{"type":"array","description":"array of brands to exclude from the response optional field if specified, the listed brands will be omitted from the items array example: \"exclude_brands\": [\"Audi\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brands_lite":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: data specific to brand entities is available for chat_gpt only; Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_brands":{"type":"array","description":"array of brands to include in the response optional field if specified, only the listed brands will be returned in the items array example: [\"BMW\",\"Audi\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_brands":{"type":"array","description":"array of brands to exclude from the response optional field if specified, the listed brands will be omitted from the items array example: [\"BMW\",\"Audi\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_domains":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"links_scope":{"type":"string","description":"links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources, search_results default value: sources Note:if you specify search_results, the data will be","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_domains":{"type":"array","description":"array of domains to include in the response optional field if specified, only the listed domains will be returned in the items array example: \"include_domains\": [\"en.wikipedia.org\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_domains":{"type":"array","description":"array of domains to exclude from the response optional field if specified, the listed domains will be omitted from the items array example: \"exclude_domains\": [\"en.wikipedia.org\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_domains_lite":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"links_scope":{"type":"string","description":"links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources, search_results default value: sources; Note: if you specify search_results, the data will ","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_domains":{"type":"array","description":"array of domains to include in the response optional field if specified, only the listed domains will be returned in the items array example: [\"dataforseo.com\",\"seoinsider.com\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_domains":{"type":"array","description":"array of domains to exclude from the response optional field if specified, the listed domains will be omitted from the items array example: [\"google.com\",\"bing.com\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_pages":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"links_scope":{"type":"string","description":"links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources, search_results default value: sources; Note:if you specify search_results, the data will b","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_pages":{"type":"array","description":"array of pages to include in the response optional field if specified, only the listed pages will be returned in the items array example: \"include_pages\": [\"https://example.page/\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_pages":{"type":"array","description":"array of pages to exclude from the response optional field if specified, the listed pages will be omitted from the items array example: \"exclude_pages\": [\"https://example.page/\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_pages_lite":{"type":"object","properties":{"target":{"type":"array","description":"array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a d","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"keyword":{"type":"string","minLength":1,"maxLength":200},"search_scope":{"type":"array","items":{"enum":["any","question","answer","sources","search_results"]},"minItems":1,"maxItems":3},"search_filter":{"enum":["include","exclude"]},"include_subdomains":{"type":"boolean"},"match_type":{"enum":["word_match","partial_match"]}},"oneOf":[{"required":["domain"],"not":{"required":["keyword"]}},{"required":["keyword"],"not":{"required":["domain"]}}],"additionalProperties":false},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available loc","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api"},"language_name":{"type":"string","description":"full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available lang","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://ap","maxLength":10,"minLength":1},"platform":{"type":"string","description":"target platform optional field possible values: chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only","maxLength":2000,"minLength":1},"links_scope":{"type":"string","description":"links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources, search_results default value: sources; ; Note: if you specify search_results, the data wil","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, <>, in, not_in, like, no","items":{},"maxItems":15,"minItems":1},"initial_dataset_filters":{"type":"array","description":"array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filt","items":{},"maxItems":15,"minItems":1},"limit":{"type":"integer","description":"maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100","minimum":1,"maximum":100,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain, search_results_domain, brand_entities_title, brand_entities_category minimu","minimum":1,"maximum":10,"default":10},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned mentions data optional fielddefault value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the success","minimum":0},"include_pages":{"type":"array","description":"array of page URLs to include in the response optional field if specified, only the listed pages will be returned in the items array example: `[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"exclude_pages":{"type":"array","description":"array of page URLs to exclude from the response optional field if specified, the listed pages will be omitted from the items array example: `[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis/a","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_ai_optimization_perplexity_llm_responses":{"type":"object","properties":{"user_prompt":{"type":"string","description":"prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field","maxLength":500,"minLength":1},"model_name":{"type":"string","description":"name of the AI model required field model_nameconsists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; you can receive the list of available LLM models by making a ","maxLength":2000,"minLength":1,"enum":["sonar"],"default":"sonar"},"max_output_tokens":{"type":"integer","description":"maximum number of tokens in the AI response optional field minimum value: 1 maximum value: 4096; default value: 2048; Note: if the reasoning model is specified in the request, the output token count may exceed the specified max_output_token","minimum":16,"maximum":1024,"default":256},"temperature":{"type":"number","description":"randomness of the AI response optional field higher values make output more diverse lower values make output more focused minimum value: 0 maximum value: 1.9 default value: 0.77","minimum":0,"maximum":1.9},"top_p":{"type":"number","description":"diversity of the AI response optional field controls diversity of the response by limiting token selection minimum value: 0 maximum value: 1 default value: 0.9","minimum":0,"maximum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["user_prompt","model_name"],"additionalProperties":false},"Input_dataforseo_app_data_apple_app_info":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL `https://apps.apple.com/us/app/id835599320` the id is `835599320`","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2]},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL `https://apps.apple.com/us/app/id835599320` the id is `835599320`","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2],"default":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_apple_app_list":{"type":"object","properties":{"app_collection":{"type":"string","description":"app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value","maximum":10,"minimum":1},"app_category":{"type":"string","description":"application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_collection":{"type":"string","description":"app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value","maximum":10,"minimum":1,"default":10},"app_category":{"type":"string","description":"application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_collection"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_apple_app_listings_search":{"type":"object","properties":{"categories":{"type":"array","description":"app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"description":{"type":"string","description":"keyword in the app's description optional field keywords that occur in the description of the app; can contain up to 200 characters","maxLength":200,"minLength":1},"title":{"type":"string","description":"keyword in the app's title optional field keywords that occur in the title of the app; can contain up to 200 characters","maxLength":200,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned apps optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recomme","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_app_data_apple_app_reviews":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 5","maximum":10,"minimum":1},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 5","maximum":10,"minimum":1,"default":10},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_apple_app_searches":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum va","maximum":10,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum va","maximum":10,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_google_app_info":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is ","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is ","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_google_app_list":{"type":"object","properties":{"app_collection":{"type":"string","description":"app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_s","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 2","maximum":10,"minimum":1},"app_category":{"type":"string","description":"application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/goo","maxLength":2000,"minLength":1},"age_rating":{"type":"string","description":"filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return apps approved for chi","maxLength":5,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_collection":{"type":"string","description":"app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_s","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if language_code is not specified if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate requ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reques","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 2","maximum":10,"minimum":1,"default":10},"app_category":{"type":"string","description":"application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/goo","maxLength":2000,"minLength":1},"age_rating":{"type":"string","description":"filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return apps approved for chi","maxLength":5,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_collection"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_google_app_listings_search":{"type":"object","properties":{"categories":{"type":"array","description":"app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"description":{"type":"string","description":"keyword in the app's description optional field keywords that occur in the description of the app; can contain up to 200 characters","maxLength":200,"minLength":1},"title":{"type":"string","description":"keyword in the app's title optional field keywords that occur in the title of the app; can contain up to 200 characters","maxLength":200,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned apps optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recomme","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_app_data_google_app_reviews":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: https://play.google.com/store/apps/details?id=org.telegram.messenger","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value","maximum":10,"minimum":1},"rating":{"type":"integer","description":"filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 — return reviews with three-s"},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default rule: most_relevant","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: https://play.google.com/store/apps/details?id=org.telegram.messenger","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate reque","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value","maximum":10,"minimum":1,"default":10},"rating":{"type":"integer","description":"filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 — return reviews with three-s"},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default rule: most_relevant","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_app_data_google_app_searches":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value:","maximum":10,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by ma"},"language_name":{"type":"string","description":"full name of search engine language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value:","maximum":10,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]}}]},"Input_dataforseo_backlinks_anchors":{"type":"object","properties":{"target":{"type":"string","minLength":3,"maxLength":300,"description":"Domain (no https:// or www.), subdomain, or full page URL."},"filters":{"type":"array","maxItems":8,"items":{},"description":"DataForSEO filters, e.g. [\"dofollow\",\"=\",true]."},"order_by":{"type":"array","maxItems":3,"items":{"type":"string"},"description":"e.g. [\"rank,desc\"]."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Rows returned, $0.000036 each."},"offset":{"type":"integer","minimum":0,"maximum":20000,"default":0},"backlinks_status_type":{"type":"string","enum":["all","live","lost"],"default":"live"},"include_subdomains":{"type":"boolean","default":true},"include_indirect_links":{"type":"boolean","default":true},"exclude_internal_backlinks":{"type":"boolean","default":true},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"},"internal_list_limit":{"type":"integer","minimum":1,"maximum":1000,"default":10}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_list":{"type":"object","properties":{"target":{"type":"string","minLength":3,"maxLength":300,"description":"Domain (no https:// or www.), subdomain, or full page URL."},"mode":{"type":"string","enum":["as_is","one_per_domain","one_per_anchor"],"default":"as_is"},"filters":{"type":"array","maxItems":8,"items":{},"description":"DataForSEO filters, e.g. [\"dofollow\",\"=\",true]."},"order_by":{"type":"array","maxItems":3,"items":{"type":"string"},"description":"e.g. [\"rank,desc\"]."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Rows returned, $0.000036 each."},"offset":{"type":"integer","minimum":0,"maximum":20000,"default":0},"backlinks_status_type":{"type":"string","enum":["all","live","lost"],"default":"live"},"include_subdomains":{"type":"boolean","default":true},"include_indirect_links":{"type":"boolean","default":true},"exclude_internal_backlinks":{"type":"boolean","default":true},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"},"search_after_token":{"type":"string","maxLength":500}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_backlinks":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":1000}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_new_lost_backlinks":{"type":"object","properties":{"targets":{"type":"array","description":"domains, subdomains or webpages to get new & lost backlinks for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without `https://` and `www.` the page should be specified wit","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"date_from":{"type":"string","description":"starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks; the backlinks that appeared in our index after the specified date will be considered as new; the back","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_new_lost_referring_domains":{"type":"object","properties":{"targets":{"type":"array","description":"domains, subdomains or webpages to get new & lost referring domains for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www. the page should be specified","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"date_from":{"type":"string","description":"starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost referring domains; the referring domains that appeared in our index after the specified date will be considered ","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_pages_summary":{"type":"object","properties":{"targets":{"type":"array","description":"domains, subdomains or webpages to get summary data for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://) you can specify up to ","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_ranks":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":1000},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_referring_domains":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":1000}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_bulk_spam_score":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":1000}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_competitors":{"type":"object","properties":{"target":{"type":"string","minLength":3,"maxLength":300,"description":"Domain (no https:// or www.), subdomain, or full page URL."},"filters":{"type":"array","maxItems":8,"items":{}},"order_by":{"type":"array","maxItems":3,"items":{"type":"string"}},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100},"offset":{"type":"integer","minimum":0,"default":0},"main_domain":{"type":"boolean","default":true},"exclude_large_domains":{"type":"boolean","default":true},"exclude_internal_backlinks":{"type":"boolean","default":true},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_domain_intersection":{"type":"object","properties":{"targets":{"type":"object","description":"domains, subdomains or webpages to get links for required field you can set up to 20 domains, subdomains or webpages a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (includi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"exclude_targets":{"type":"array","description":"domains, subdomains or webpages you want to exclude optional field you can specify up to 10 domains, subdomains or webpages if you use this array, results will contain the referring domains that link to targets but don't link to exclude_tar","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the array of returned results optional field default value: 0 if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks","minimum":0},"limit":{"type":"integer","description":"the maximum number of returned results optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes referring_links_platfo","maximum":100,"minimum":1,"default":10},"backlinks_status_type":{"type":"string","description":"set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets; possible values: all - all backlinks will be returned and counted; live","maxLength":2000,"minLength":1},"backlinks_filters":{"type":"array","description":"filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in th","items":{},"maxItems":15,"minItems":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"include_indirect_links":{"type":"boolean","description":"indicates if indirect links to the targets will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page if"},"exclude_internal_backlinks":{"type":"boolean","description":"indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, the backlinks from subdomains of the target will be omitted and you won't receive the same domain in the response; default value: tru"},"intersection_mode":{"type":"string","description":"indicates whether to intersect backlinks optional field use this field to intersect or merge results for the specified domains possible values: all, partial all - results are based on all backlinks; partial - results are based on the inters","maxLength":2000,"minLength":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_domain_pages":{"type":"object","properties":{"target":{"type":"string","description":"domain or subdomain required field a domain or a subdomain should be specified without https:// and www. example: forbes.com","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned pages optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages","minimum":0},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes referring_links_platfo","maximum":100,"minimum":1,"default":10},"backlinks_status_type":{"type":"string","description":"set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics; possible values: all - all backlinks will be returned and counted; live - backlinks foun","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"backlinks_filters":{"type":"array","description":"filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in th","items":{},"maxItems":15,"minItems":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"exclude_internal_backlinks":{"type":"boolean","description":"indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target if set to fa"},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_domain_pages_summary":{"type":"object","properties":{"target":{"type":"string","description":"domain, subdomain or webpage to get summary data for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://)","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned anchors optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors","minimum":0},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes referring_links_platfo","maximum":100,"minimum":1,"default":10},"backlinks_status_type":{"type":"string","description":"set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target; possible values: all - all backlinks will be returned and counted; live ","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"backlinks_filters":{"type":"array","description":"filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in th","items":{},"maxItems":15,"minItems":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target domain will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"include_indirect_links":{"type":"boolean","description":"indicates if indirect links to the target will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page i"},"exclude_internal_backlinks":{"type":"boolean","description":"indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, backlinks from the subdomains of the target domain will be ommited and you won't receive the same domain in the response; default val"},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_history":{"type":"object","properties":{"target":{"type":"string","description":"domain required field a domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimum value 2019-01-01 if you don't specify this field, the minimum value will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_page_intersection":{"type":"object","properties":{"targets":{"type":"object","description":"domains, subdomains or webpages to get links for required field you can set up to 20 domains, subdomains or webpages a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (includi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"exclude_targets":{"type":"array","description":"domains, subdomains or webpages you want to exclude optional field you can set up to 10 domains, subdomains or webpages if you use this array, results will contain the referring pages that link to targets but don't link to exclude_targets e","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"backlinks_status_type":{"type":"string","description":"set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets; possible values: all - all backlinks will be returned and counted; live","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of the returned backlinks optional fielddefault value: 0 if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks","minimum":0},"limit":{"type":"integer","description":"the maximum number of returned backlinks optional fielddefault value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: attributes domain_from_platform_typedefault value: 10 maximum value: 1000","maximum":100,"minimum":1,"default":10},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the targets will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"include_indirect_links":{"type":"boolean","description":"indicates if indirect links to the targets will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page if"},"exclude_internal_backlinks":{"type":"boolean","description":"indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target if set to fa"},"intersection_mode":{"type":"string","description":"indicates whether to intersect backlinks optional field use this field to intersect or merge results for the specified URLs possible values: all, partial all - results are based on all backlinks; partial - results are based on the intersect","maxLength":2000,"minLength":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_backlinks_referring_domains":{"type":"object","properties":{"target":{"type":"string","minLength":3,"maxLength":300,"description":"Domain (no https:// or www.), subdomain, or full page URL."},"filters":{"type":"array","maxItems":8,"items":{},"description":"DataForSEO filters, e.g. [\"dofollow\",\"=\",true]."},"order_by":{"type":"array","maxItems":3,"items":{"type":"string"},"description":"e.g. [\"rank,desc\"]."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Rows returned, $0.000036 each."},"offset":{"type":"integer","minimum":0,"maximum":20000,"default":0},"backlinks_status_type":{"type":"string","enum":["all","live","lost"],"default":"live"},"include_subdomains":{"type":"boolean","default":true},"include_indirect_links":{"type":"boolean","default":true},"exclude_internal_backlinks":{"type":"boolean","default":true},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"},"internal_list_limit":{"type":"integer","minimum":1,"maximum":1000,"default":10}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_referring_networks":{"type":"object","properties":{"target":{"type":"string","description":"domain, subdomain or webpage to get referring networks for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://)","maxLength":2000,"minLength":1},"network_address_type":{"type":"string","description":"indicates the type of network to get data for optional field possible values: ip, subnet default value: ip","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned networks optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned networks optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages","minimum":0},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes referring_links_platfo","maximum":100,"minimum":1,"default":10},"backlinks_status_type":{"type":"string","description":"set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target; possible values: all - all backlinks will be returned and counted; live ","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"backlinks_filters":{"type":"array","description":"filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in th","items":{},"maxItems":15,"minItems":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"include_indirect_links":{"type":"boolean","description":"indicates if indirect links to the target will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page i"},"exclude_internal_backlinks":{"type":"boolean","description":"indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response; default value: tru"},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_summary":{"type":"object","properties":{"target":{"type":"string","minLength":3,"maxLength":300,"description":"Domain (no https:// or www.), subdomain, or full page URL."},"include_subdomains":{"type":"boolean","default":true},"include_indirect_links":{"type":"boolean","default":true},"exclude_internal_backlinks":{"type":"boolean","default":true},"backlinks_status_type":{"type":"string","enum":["all","live","lost"],"default":"live"},"internal_list_limit":{"type":"integer","minimum":1,"maximum":1000,"default":10},"rank_scale":{"type":"string","enum":["one_hundred","one_thousand"],"default":"one_thousand"}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_timeseries_new_lost_summary":{"type":"object","properties":{"target":{"type":"string","description":"domain to get data for required field a domain should be specified without https:// and www. example: \"forbes.com\"","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specif","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the date_from maximum value: today's date date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"group_range":{"type":"string","description":"time range which will be used to group the results optional field default value: month possible values: day, week, month, yearnote: for day, we will return items corresponding to all dates between and including date_from and date_to; for we","maxLength":2000,"minLength":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_backlinks_timeseries_summary":{"type":"object","properties":{"target":{"type":"string","description":"domain to get data for required field a domain should be specified without https:// and www. example: \"forbes.com\"","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field this field indicates the date which will be used as a threshold for summary data;minimum value: 2019-01-30 maximum value shouldn't exceed the date specified in the date_to date format: \"yyyy-mm","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the date_from maximum value: today's date date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"group_range":{"type":"string","description":"time range which will be used to group the results optional field default value: month possible values: day, week, month, yearnote: for day, we will return items corresponding to all dates between and including date_from and date_to; for we","maxLength":2000,"minLength":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_business_data_business_listings_categories_aggregation":{"type":"object","properties":{"categories":{"type":"array","description":"business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up to 10 categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"description":{"type":"string","description":"description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters","maxLength":200,"minLength":1},"title":{"type":"string","description":"title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters","maxLength":200,"minLength":1},"is_claimed":{"type":"boolean","description":"indicates whether the business is verified by its owner on Google Maps optional field"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": ","maxLength":2000,"minLength":1},"initial_dataset_filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the aggregated categories default value: 10","minimum":1,"maximum":100,"default":10},"limit":{"type":"integer","description":"the maximum number of returned businesses optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"the maximum number of returned businesses optional field","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_business_data_business_listings_search":{"type":"object","properties":{"categories":{"type":"array","description":"business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up to 10 categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"description":{"type":"string","description":"description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters","maxLength":200,"minLength":1},"title":{"type":"string","description":"title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters","maxLength":200,"minLength":1},"is_claimed":{"type":"boolean","description":"indicates whether the business is verified by its owner on Google Maps optional field"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the value of \"radius\" is specifi","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned businesses optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we r","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_business_data_google_extended_reviews":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field if you don't specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ ","maxLength":700,"minLength":1},"cid":{"type":"string","description":"unique, google-defined id of the business entity required field if you don't specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center articleNote: if you use this field, your account will b","maxLength":2000,"minLength":1},"place_id":{"type":"string","description":"identifier of the business entity in Google Maps required field if you don't specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center articleNote: if you use this field, your account wi","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: 20 maximum value: 1000Your account will ","maximum":20,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field if you don't specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ ","maxLength":700,"minLength":1},"cid":{"type":"string","description":"unique, google-defined id of the business entity required field if you don't specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center articleNote: if you use this field, your account will b","maxLength":2000,"minLength":1},"place_id":{"type":"string","description":"identifier of the business entity in Google Maps required field if you don't specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center articleNote: if you use this field, your account wi","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: 20 maximum value: 1000Your account will ","maximum":20,"minimum":1,"default":20},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_business_data_google_hotel_info":{"type":"object","properties":{"hotel_identifier":{"type":"string","description":"unique hotel identifier required field unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches en","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"check_in":{"type":"string","description":"check-in date optional field if you don't specify this field, tomorrow's date will be used by default; the value must not be earlier than today's date date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"minLength":1},"check_out":{"type":"string","description":"check-out date optional field if you don't specify this field, our system will apply the date of two days from now by default; Note: the value cannot be less than or equal to check_in; the range between check_in and check_out values cannot ","maxLength":2000,"minLength":1},"currency":{"type":"string","description":"currency optional field example: \"USD\"","maxLength":2000,"minLength":1},"adults":{"type":"integer","description":"number of adults optional field if you don't specify this field, two adults will be used by default example: 1"},"children":{"type":"array","description":"number and age of children optional field if you don't specify this field, no children will be included in the search;set the following value if you want to include one 14-years-old child: [14] set the following value if you want to include","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"load_prices_by_dates":{"type":"boolean","description":"load hotel stay prices by dates optional field if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates if you use this parameter, you will be charged double the ba"},"prices_start_date":{"type":"string","description":"start date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, the start date is set to check_in date date format: yyyy-mm-dd example: 2025-05-20","maxLength":2000,"minLength":1},"prices_end_date":{"type":"string","description":"end date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, you will get prices by date for the month date format: yyyy-mm-dd example: 2025-05-21","maxLength":2000,"minLength":1},"prices_date_range":{"type":"string","description":"predefined period for retrieving daily price data optional field to use this parameter, you must specify load_prices_by_dates with true if the prices_start_date is not specified, the start date is set to check_in date possible values: month","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["hotel_identifier"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_business_data_google_hotel_searches":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword optional field the keyword you specify is used to search for the list of hotels; if you don't use this field, we will return the list of hotels found in a specified location; you can specify up to 700 characters in the keyword filed","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"search_this_area":{"type":"boolean","description":"show hotels from the displayed area optional field can take the values: true, false default value: true if set to false the search_this_area mode will be turned off Note: if the search_this_area mode is turned off, the location_name won't b"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in Google Hotels default value: 18 organic results max value: 140 Note: your account will be billed per each 18 organic results regardless of paid listings in the response; thus, setting a dept","maximum":100,"minimum":1,"default":10},"check_in":{"type":"string","description":"check-in date optional field if you don't specify this field, tomorrow's date will be used by default; date format: \"yyyy-mm-dd\" example: \"2019-01-15\" Note: the value cannot precede the today's date","maxLength":2000,"minLength":1},"check_out":{"type":"string","description":"check-out date optional field if you don't specify this field, our system will apply the date of two days from now by default; date format: \"yyyy-mm-dd\" example: \"2019-01-15\" Note: the value cannot be less than or equal to check_in; the ran","maxLength":2000,"minLength":1},"currency":{"type":"string","description":"currency optional field example: \"USD\"","maxLength":2000,"minLength":1},"adults":{"type":"integer","description":"number of adults optional field if you don't specify this field, the default value of 2 will be applied; note that you can specify up to 6 persons including both adults and children example: 1"},"children":{"type":"array","description":"number and age of children optional field if you don't specify this field, no children will be included in the search; age of child can be from 0 to 17; note that you can specify up to 6 persons including both adults and children set the fo","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":6,"minItems":1},"stars":{"type":"array","description":"hotel stars optional field set this field to [5] if you want to get the list of 5-star hotels only example: [3,4,5]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"min_rating":{"type":"number","description":"minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5"},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest rating most_reviewed ","maxLength":2000,"minLength":1},"min_price":{"type":"integer","description":"minimum price per night optional field the currency of this value depends on the currency field example: 100"},"max_price":{"type":"integer","description":"maximum price per night optional field the currency of this value depends on the currency field example: 600"},"free_cancellation":{"type":"boolean","description":"hotels with a free cancellation optional field set this field to true if you want to get the list of hotels with free cancellation of reservations default value: false"},"is_vacation_rentals":{"type":"boolean","description":"search for vacation rentals optional field set this field to true if you want to get the list of vacation rentals instead of hotels default value: false"},"amenities":{"type":"array","description":"hotel amenities optional field you can use this field to specify different hotel amenities example: [ \"free_parking\", \"pets_allowed\" ] possible values: `\"air_conditioning\", \"all_inclusive_available\", \"bar\", \"free_breakfast\", \"fitness_center","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_business_data_google_my_business_info":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) i","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_business_data_google_my_business_updates":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) i","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row please note that Google returns 4490 updates maximum default ","minimum":1,"maximum":100},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) i","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row please note that Google returns 4490 updates maximum default ","minimum":1,"maximum":100,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_business_data_google_questions_and_answers":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) i","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 20 max value: 100 Your account will be billed per each SERP containing up to 20 results; Setting depth above 20 may result in additional charges if the search engine retu","maximum":100,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_business_data_google_reviews":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field if you don't specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ ","maxLength":700,"minLength":1},"cid":{"type":"string","description":"unique, google-defined id of the business entity required field if you don't specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article","maxLength":2000,"minLength":1},"place_id":{"type":"string","description":"identifier of the business entity in Google Maps required field if you don't specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: 10 maximum value: 4490 Your account will be bi","maximum":10,"minimum":1},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results possible types of sorting: newest – sort by newest first highest_rating – sort by highest rating lowest_rating – sort by lowest rating relevant – sort by r","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field if you don't specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ ","maxLength":700,"minLength":1},"cid":{"type":"string","description":"unique, google-defined id of the business entity required field if you don't specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article","maxLength":2000,"minLength":1},"place_id":{"type":"string","description":"identifier of the business entity in Google Maps required field if you don't specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with "},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with language_name by making a separate req","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate reque","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: 10 maximum value: 4490 Your account will be bi","maximum":10,"minimum":1,"default":10},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results possible types of sorting: newest – sort by newest first highest_rating – sort by highest rating lowest_rating – sort by lowest rating relevant – sort by r","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_business_data_social_media_pinterest":{"type":"object","properties":{"targets":{"type":"array","description":"target URLs required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/Note: you can specify 10 targets maximum. You will be charged per earch URL you specify in this","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_business_data_tripadvisor_reviews":{"type":"object","properties":{"url_path":{"type":"string","description":"URL path of the business entity required field if you do not specify keyword URL path to the Tripadvisor page of the business entity; examples: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html ht","maxLength":2000,"minLength":1},"keyword":{"type":"string","description":"keyword required field if you do not specify url_path the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the keyword filed; all %## will be decod","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or url_path you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or url_path you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tri"},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"language_name":{"type":"string","description":"full name of search engine language optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_name by making a separate request to the https://api.","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_code by making a separate request to the https://api.datafors","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: 10; max value: 4490 Your account will be bil","maximum":10,"minimum":1},"ratings":{"type":"array","description":"Tripadvisor traveler rating for a place of interest optional field rating based on the written reviews by a traveler after they visited a place. possible values: excellent, very_good, average, poor, terrible you can specify several values a","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"visit_type":{"type":"array","description":"filter by type of travelers who left a review optional field possible values: families, couples, solo, business, friends you can specify several values at once","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"months":{"type":"array","description":"filter by months when a traveler made a visit optional field possible values: january, february, march, april, may, april, june, july, august, september, october, november, december you can specify several values at once","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent detailed_reviews","maxLength":2000,"minLength":1},"translate_reviews":{"type":"boolean","description":"translate reviews according to the URL path optional field if set to true, returned reviews will be translated to the language matching the specified url_path; for example, if url_path contains tripadvisor.it and translate_reviews is true, "},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"url_path":{"type":"string","description":"URL path of the business entity required field if you do not specify keyword URL path to the Tripadvisor page of the business entity; examples: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html ht","maxLength":2000,"minLength":1},"keyword":{"type":"string","description":"keyword required field if you do not specify url_path the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the keyword filed; all %## will be decod","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or url_path you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or url_path you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tri"},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"language_name":{"type":"string","description":"full name of search engine language optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_name by making a separate request to the https://api.","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_code by making a separate request to the https://api.datafors","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: 10; max value: 4490 Your account will be bil","maximum":10,"minimum":1,"default":10},"ratings":{"type":"array","description":"Tripadvisor traveler rating for a place of interest optional field rating based on the written reviews by a traveler after they visited a place. possible values: excellent, very_good, average, poor, terrible you can specify several values a","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"visit_type":{"type":"array","description":"filter by type of travelers who left a review optional field possible values: families, couples, solo, business, friends you can specify several values at once","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"months":{"type":"array","description":"filter by months when a traveler made a visit optional field possible values: january, february, march, april, may, april, june, july, august, september, october, november, december you can specify several values at once","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"sort_by":{"type":"string","description":"results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent detailed_reviews","maxLength":2000,"minLength":1},"translate_reviews":{"type":"boolean","description":"translate reviews according to the URL path optional field if set to true, returned reviews will be translated to the language matching the specified url_path; for example, if url_path contains tripadvisor.it and translate_reviews is true, "},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]}}]},"Input_dataforseo_business_data_tripadvisor_search":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded t","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadv","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/loc"},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default valu","maximum":100,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded t","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadv","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/loc"},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default valu","maximum":100,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]}}]},"Input_dataforseo_business_data_trustpilot_reviews":{"type":"object","properties":{"domain":{"type":"string","description":"domain of the local establishment required field domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: www.thepearlsource.com https://www.trustpilot.com/review/ww","maxLength":2000,"minLength":1},"sort_by":{"type":"string","description":"results sorting parameter optional field you can use this field to sort the results; possible sorting parameters: recency — most recent reviews first; relevance — most relevant reviews first; default value: relevance","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: 20 maximum v","maximum":10,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"domain":{"type":"string","description":"domain of the local establishment required field domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: www.thepearlsource.com https://www.trustpilot.com/review/ww","maxLength":2000,"minLength":1},"sort_by":{"type":"string","description":"results sorting parameter optional field you can use this field to sort the results; possible sorting parameters: recency — most recent reviews first; relevance — most relevant reviews first; default value: relevance","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: 20 maximum v","maximum":10,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["domain"],"additionalProperties":false}}]},"Input_dataforseo_business_data_trustpilot_search":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character)","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default valu","maximum":100,"minimum":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character)","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default valu","maximum":100,"minimum":1,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false}}]},"Input_dataforseo_content_analysis_category_trends":{"type":"object","properties":{"category_code":{"type":"integer","description":"target category code required field to obtain a full list of available categories, refer to the Categories endpoint"},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"search_mode":{"type":"string","description":"results grouping type optional field possible grouping types: as_is - returns data on all citations for the target category_code one_per_domain - returns data on one citation of the category_code per domain default value: as_is","maxLength":2000,"minLength":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum va","maximum":20,"minimum":1,"default":10},"date_from":{"type":"string","description":"starting date of the time range required field minimum value: 2022-10-31 date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_group":{"type":"string","description":"time range which will be used to group the results optional field default value: month possible values: day, week, month","maxLength":2000,"minLength":1},"initial_dataset_filters":{"type":"array","description":"initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint; you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the cond","items":{},"maxItems":15,"minItems":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_hundred — rank values are displayed on","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["category_code","date_from"],"additionalProperties":false},"Input_dataforseo_content_analysis_phrase_trends":{"type":"object","properties":{"keyword":{"type":"string","description":"target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: \"keyword\": \"\\\"tesla palo alto\\\"\"","maxLength":700,"minLength":1},"keyword_fields":{"type":"object","description":"target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"search_mode":{"type":"string","description":"results grouping type optional field possible grouping types: as_is - returns data on all citations for the target keyword one_per_domain - returns data on one citation of the keyword per domain default value: as_is","maxLength":2000,"minLength":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum va","maximum":20,"minimum":1,"default":10},"date_from":{"type":"string","description":"starting date of the time range required field date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_group":{"type":"string","description":"time range which will be used to group the results optional field default value: month possible values: day, week, month","maxLength":2000,"minLength":1},"initial_dataset_filters":{"type":"array","description":"initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint; you can add several filters at once (8 filters maximum); you should set a logical operator and, or between the con","items":{},"maxItems":15,"minItems":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_hundred — rank values are displayed on","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword","date_from"],"additionalProperties":false},"Input_dataforseo_content_analysis_rating_distribution":{"type":"object","properties":{"keyword":{"type":"string","description":"target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: \"keyword\": \"\\\"tesla palo alto\\\"\"","maxLength":700,"minLength":1},"keyword_fields":{"type":"object","description":"target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum va","maximum":20,"minimum":1,"default":10},"search_mode":{"type":"string","description":"results grouping type optional field possible grouping types: as_is - returns all citations for the target keyword one_per_domain - returns one citation of the keyword per domain default value: as_is","maxLength":2000,"minLength":1},"positive_connotation_threshold":{"type":"number","description":"positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on "},"sentiments_connotation_threshold":{"type":"number","description":"sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contai"},"initial_dataset_filters":{"type":"array","description":"initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the condi","items":{},"maxItems":15,"minItems":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_hundred — rank values are displayed on","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false},"Input_dataforseo_content_analysis_search":{"type":"object","properties":{"keyword":{"type":"string","description":"target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: `\"keyword\": \"\\\"tesla palo alto\\\"","maxLength":700,"minLength":1},"keyword_fields":{"type":"object","description":"target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"search_mode":{"type":"string","description":"results grouping type optional field possible grouping types: as_is - returns all citations for the target keyword one_per_domain - returns one citation of the keyword per domain default value: as_is","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned citations optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of returned citations optional field default value: 0 if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations Note: we ","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical field of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the domain_rank, and url_rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_hundred — rank va","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false},"Input_dataforseo_content_analysis_sentiment_analysis":{"type":"object","properties":{"keyword":{"type":"string","description":"target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: \"keyword\": \"\\\"tesla palo alto\\\"\"","maxLength":700,"minLength":1},"keyword_fields":{"type":"object","description":"target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum va","maximum":20,"minimum":1,"default":10},"positive_connotation_threshold":{"type":"number","description":"positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on "},"sentiments_connotation_threshold":{"type":"number","description":"sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contai"},"initial_dataset_filters":{"type":"array","description":"initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the condi","items":{},"maxItems":15,"minItems":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed ","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false},"Input_dataforseo_content_analysis_summary":{"type":"object","properties":{"keyword":{"type":"string","description":"target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: \"keyword\": \"\\\"tesla palo alto\\\"\"","maxLength":700,"minLength":1},"keyword_fields":{"type":"object","description":"target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fi","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"page_type":{"type":"array","description":"target page types optional field use this parameter to filter the dataset by page types possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum va","maximum":20,"minimum":1,"default":10},"positive_connotation_threshold":{"type":"number","description":"positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on "},"sentiments_connotation_threshold":{"type":"number","description":"sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contai"},"initial_dataset_filters":{"type":"array","description":"initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the condi","items":{},"maxItems":15,"minItems":1},"rank_scale":{"type":"string","description":"defines the scale used for calculating and displaying the rank values optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values: one_hundred — rank values are displayed on","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_amazon_bulk_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataFor","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note:","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_amazon_product_competitors":{"type":"object","properties":{"asin":{"type":"string","description":"product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e","maxLength":10,"minLength":1},"limit":{"type":"integer","description":"the maximum number of products in the results array optional field default value: 100; maximum value: 1000","maximum":100,"minimum":1,"default":10},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["asin"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_amazon_product_keyword_intersections":{"type":"object","properties":{"asins":{"type":"object","description":"asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: \"asins\": { \"1\": \"019005476X\", \"2\": \"0190074442\" } the maximum number of ASI","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e","maxLength":10,"minLength":1},"limit":{"type":"integer","description":"the maximum number of products in the results array optional field default value: 100; maximum value: 1000","maximum":100,"minimum":1,"default":10},"intersection_mode":{"type":"string","description":"mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["asins"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_amazon_product_rank_overview":{"type":"object","properties":{"asins":{"type":"array","description":"product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoin","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["asins"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_amazon_ranked_keywords":{"type":"object","properties":{"asin":{"type":"string","description":"product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e","maxLength":10,"minLength":1},"limit":{"type":"integer","description":"the maximum number of products in the results array optional field default value: 100; maximum value: 1000","maximum":100,"minimum":1,"default":10},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["asin"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_amazon_related_keywords":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field UTF-8 encoding the keywords should be specified in the lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to h","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 - the keyword set","minimum":1,"maximum":4,"default":1},"include_seed_keyword":{"type":"boolean","description":"include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_apple_app_competitors":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned apps optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_apple_app_intersection":{"type":"object","properties":{"app_ids":{"type":"object","description":"ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; th","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_ids"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_apple_bulk_app_metrics":{"type":"object","properties":{"app_ids":{"type":"array","description":"ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the maximum number o","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_ids"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_apple_keywords_for_app":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_app_competitors":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is ","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned apps optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_app_intersection":{"type":"object","properties":{"app_ids":{"type":"object","description":"ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.me","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_ids"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_available_history":{"type":"object","properties":{},"additionalProperties":{"type":["string","number","boolean","null"]},"maxProperties":20},"Input_dataforseo_dataforseo_labs_google_bulk_app_metrics":{"type":"object","properties":{"app_ids":{"type":"array","description":"ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id ","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_ids"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_bulk_keyword_difficulty":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForS","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if don't specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if don't specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e"},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages e","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_bulk_traffic_estimation":{"type":"object","properties":{"targets":{"type":"array","description":"target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, incl","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location if you use this field, you don't have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code if you use this field, you don't have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/location"},"language_name":{"type":"string","description":"full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_l","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/location","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type i","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_categories_for_domain":{"type":"object","properties":{"target":{"type":"string","description":"domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"include_subcategories":{"type":"boolean","description":"indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article"},"historical_serp_mode":{"type":"string","description":"data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in w","maxLength":2000,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first ","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned categories optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned categories optional field default value: 0 if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_categories_for_keywords":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForS","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/catego","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_key","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_competitors_domain":{"type":"object","properties":{"target":{"type":"string","description":"domain required field the domain name of the target website the domain should be specified without https:// and www. you can specify page URL, but the results will be specific to the domain in the specified URL","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type i","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned domains optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"max_rank_group":{"type":"integer","description":"maximum rank up to which competitors will be considered optional field default value: 100if you specify 10 here, we will extract competitors from the top 10 Google search results only"},"exclude_top_domains":{"type":"boolean","description":"indicates whether to exclude world's largest websites optional field default value: false set to true if you want to get highly-relevant competitors excluding the websites listed below:wikipedia.org pinterest.com amazon.com google.com faceb"},"exclude_domains":{"type":"array","description":"exclude domains from the results optional field use this parameter to exclude specific domains from the results Note: you can specify up to 1000 domains in this arrayexample: \"exclude_domains\": [ \"reddit.com\", \"youtube.com\" ]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"intersecting_domains":{"type":"array","description":"additional domains for improving results accuracy optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs; if you use this array, metrics in the result will be based","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":20,"minItems":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_domain_intersection":{"type":"object","properties":{"target1":{"type":"string","description":"domain required field the domain name of the first target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"target2":{"type":"string","description":"domain required field the domain name of the second target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"intersections":{"type":"boolean","description":"domain intersections in SERP optional field if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the corresponding SERP elements for bo"},"item_types":{"type":"array","description":"search results type indicates type of search results included in the response optional field possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the items array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target1","target2"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_domain_metrics_by_categories":{"type":"object","properties":{"category_codes":{"type":"array","description":"product and service categories required field The maximum number of categories you can specify: 5 you can download the full list of possible categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":5,"minItems":1},"first_date":{"type":"string","description":"first date of comparison period required field first date for which domain metrics will be provided; date format: \"yyyy-mm-dd\"; example: \"2021-06-01\"; the list available dates is available through the available history endpoint; Note: first","maxLength":2000,"minLength":1},"second_date":{"type":"string","description":"second date of comparison period required field second date for which domain metrics will be provided; date format: \"yyyy-mm-dd\"; example: \"2021-10-01\"; the list available dates is available through the available history endpoint; Note: sec","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code; you can receive the list of available locations with their location_name by making a separate","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code; you can receive the list of available locations with their location_code by making a separat"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code; you can receive the list of available languages with their language_name by making a separate","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"unique language identifier required field if you don't specify language_name Note: it is required to specify either language_name or language_code; you can receive the list of available languages with their language_code by making a separat","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the response;Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"top_categories_count":{"type":"integer","description":"number of additional domain categories optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above; to learn more about the parameter, please refer to this","maximum":5},"include_subdomains":{"type":"boolean","description":"return subdomains in the API response optional field if false, the API response will contain main_domain only; if true, the API will return main_domain plus its subdomains (if available); default value: true"},"etv_min":{"type":"integer","description":"minimum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv greater than the specified value"},"etv_max":{"type":"integer","description":"maximum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv lesser than the specified value"},"correlate":{"type":"boolean","description":"correlate data with previously obtained datasets optional field default value: true; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is intended to mitigate any inco"},"limit":{"type":"integer","description":"the maximum number of domains in the results array optional field default value: 100; maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0; if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains","minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum); you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; default rule: [\"organic_etv,desc\"]; possible sorting types: asc - results will be sorted in ascending order desc - results will be","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255; you can use this parameter to identify the task and match it with the result; you will find the specified tag value in the data object of the response","maxLength":255}},"required":["category_codes","first_date","second_date"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_domain_rank_overview":{"type":"object","properties":{"target":{"type":"string","description":"domain required field the domain name of the target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforse"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value:"},"limit":{"type":"integer","description":"the maximum number of returned results for domain optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_historical_bulk_traffic_estimation":{"type":"object","properties":{"targets":{"type":"array","description":"target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location if you use this field, you don't have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code if you use this field, you don't have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/location"},"language_name":{"type":"string","description":"full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_l","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/location","maxLength":10,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default; date format: \"yyyy-mm-dd\" example: \"2021-04-01\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["targets"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_historical_keyword_data":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase ","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to t","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_historical_rank_overview":{"type":"object","properties":{"target":{"type":"string","description":"domain required field the domain name of the target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to t","maxLength":10,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2021-04-01\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"correlate":{"type":"boolean","description":"correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any incons"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_historical_serps":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as","maxLength":700,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the API will return all SERPs collected for 365 days starting from the current datetime value; minimal possible value: 365 days from the current datetime value;","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default; date format: \"yyyy-mm-dd\"; example: \"2021-09-01\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"unique language identifier required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_keyword_ideas":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this H","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"closely_variants":{"type":"boolean","description":"search mode optional field if set to_true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: falsen"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"limit":{"type":"integer","description":"the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we rec","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_keyword_overview":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase ","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to t","maxLength":10,"minLength":1},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_keyword_suggestions":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field UTF-8 encoding the keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforse"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"include_seed_keyword":{"type":"boolean","description":"include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false"},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"exact_match":{"type":"boolean","description":"search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order a","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we rec","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_keywords_for_app":{"type":"object","properties":{"app_id":{"type":"string","description":"id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to h"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc - results will be sorted in the ascending order; desc - results will be sorted in the descending order","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["app_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_keywords_for_categories":{"type":"object","properties":{"category_codes":{"type":"array","description":"product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":20,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"unique language identifier required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate","maxLength":10,"minLength":1},"category_intersection":{"type":"boolean","description":"category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true"},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"limit":{"type":"integer","description":"the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we rec","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["category_codes"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_keywords_for_site":{"type":"object","properties":{"target":{"type":"string","description":"target domain required field the domain name of the target website the domain should be specified without https://","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"limit":{"type":"integer","description":"the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we rec","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_page_intersection":{"type":"object","properties":{"pages":{"type":"object","description":"target URLs of pages required field you can set up to 20 pages in this object the pages should be specified with absolute URLs (including http:// or https://) example: `\"pages\": {` `\"1\":\"https://www.apple.com/mac/*\",` `\"2\":\"https://datafors","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"exclude_pages":{"type":"array","description":"URLs of pages you want to exclude optional field you can set up to 10 pages in this array if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not;note that","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to t","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"search results type indicates type of search results included in the response optional fieldpossible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the items array of returned keywords optional field default value: 0 if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"intersection_mode":{"type":"string","description":"indicates whether to intersect keywords optional field use this field to intersect or merge results for the specified URLspossible values: union, intersectunion - results are based on all keywords any URL from pages rank for;intersect - res","maxLength":2000,"minLength":1},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["pages"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_ranked_keywords":{"type":"object","properties":{"target":{"type":"string","description":"domain name or page url required field the domain name of the target website, subdomain or URL of the target webpage; the domain name must be specified without https:// or www.; the subdomain must be specified without https://; the webpage ","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforse"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type i","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"load_rank_absolute":{"type":"boolean","description":"return rankings distribution by rank_absolute optional field default value: false if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position"},"historical_serp_mode":{"type":"string","description":"data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return keywords for which the specified target currently has ranking results in SERP; lost — return keywords for which the","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_related_keywords":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field UTF-8 encoding the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to t","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"keyword search depth optional field default value: 1number of the returned results depends on the value you set in this field you can specify a level from 0 to 4 estimated number of keywords for each level (maximum): 0 - the keyword set in ","minimum":1,"maximum":100,"default":10},"include_seed_keyword":{"type":"boolean","description":"include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false"},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"ignore_synonyms":{"type":"boolean"},"replace_with_core_keyword":{"type":"boolean","description":"return data for core keyword optional field if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to; if false, serp_info and related_keywords will be returned for the "},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_relevant_pages":{"type":"object","properties":{"target":{"type":"string","description":"domain required field the domain name of the target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforse"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type i","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned pages optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages","minimum":0},"historical_serp_mode":{"type":"string","description":"data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in w","maxLength":2000,"minLength":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_search_intent":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataFor","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"language_name":{"type":"string","description":"full name of the language required field if don't specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_lan","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if don't specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note:","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_serp_competitors":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywordslearn more about rules and limi","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a sepa","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"unique language identifier required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making","maxLength":10,"minLength":1},"include_subdomains":{"type":"boolean","description":"indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true"},"item_types":{"type":"array","description":"search results type indicates type of search results included in the response optional fieldpossible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned domains optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains","minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order t","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_dataforseo_labs_google_subdomains":{"type":"object","properties":{"target":{"type":"string","description":"domain required field the domain name of the target website the domain should be specified without https:// and www.","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforse"},"language_name":{"type":"string","description":"full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforse","maxLength":10,"minLength":1},"item_types":{"type":"array","description":"display results by item type optional field indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type i","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"historical_serp_mode":{"type":"string","description":"data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in w","maxLength":2000,"minLength":1},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords","minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false},"Input_dataforseo_dataforseo_labs_google_top_searches":{"type":"object","properties":{"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to t","maxLength":10,"minLength":1},"include_serp_info":{"type":"boolean","description":"include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false"},"ignore_synonyms":{"type":"boolean","description":"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we rec","minimum":0},"offset_token":{"type":"string","description":"offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the uniq","maxLength":2000,"minLength":1}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_domain_analytics_technologies_aggregation_technologies":{"type":"object","properties":{"group":{"type":"string","description":"id of the target technology group required field if you don't specify technology, category or keyword at least one field (group, category, keyword, technology) must be set you can find the full list of technology group ids on this page exam","maxLength":2000,"minLength":1},"category":{"type":"string","description":"id of the target technology category required field if you don't specify group, keyword or technology at least one field (group, category, keyword, technology) must be set you can find the full list of technology category ids on this page e","maxLength":2000,"minLength":1},"technology":{"type":"string","description":"target technology required field if you don't specify group, keyword or category at least one field (group, category, keyword, technology) must be set you can find the full list of technologies on this page example: \"Salesforce\"","maxLength":2000,"minLength":1},"keyword":{"type":"string","description":"target keyword in the domain's meta keywords required field if you don't specify group, category or technology at least one field (group, category, keyword, technology) must be set UTF-8 encoding example: \"seo\"learn more about rules and lim","maxLength":700,"minLength":1},"mode":{"type":"string","description":"search mode optional field possible search mode types: as_is - search for results exactly matching the specified group ids, category ids, or technology names entry - search for results matching a part of the specified group ids, category id","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the following values to sort the results: groups_count, categories_count, technologies_count possible sorting types: asc - results will be sorted in the ascending order desc - results will be","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"internal_groups_list_limit":{"type":"integer","description":"maximum number of returned technology groups optional field you can use this field to limit the number of items with identical \"group\" in the results default value: 5 minimum value: 1 maximum value: 10000","minimum":1,"maximum":10000},"internal_categories_list_limit":{"type":"integer","description":"maximum number of returned technology categories within the same group optional field you can use this field to limit the number of items with identical \"category\" in the results default value: 5 minimum value: 1 maximum value: 10000","minimum":1,"maximum":10000},"internal_technologies_list_limit":{"type":"integer","description":"maximum number of returned technologies within the same category optional field you can use this field to limit the number of items with identical \"technology\" in the results default value: 10 minimum value: 1 maximum value: 10000","minimum":1,"maximum":10000},"internal_list_limit":{"type":"integer","description":"maximum number of items with identical \"category\", \"group\", and \"technology\" optional field if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will ","minimum":1,"maximum":100,"default":10},"limit":{"type":"integer","description":"the maximum number of returned technologies optional field default value: 100 maximum value: 10000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0 maximum value: 9999 if you specify the 10 value, the first ten technologies in the results array will be omitted and the data will be provided for the successiv","maximum":9999,"minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_domain_analytics_technologies_domain_technologies":{"type":"object","properties":{"target":{"type":"string","description":"target domain required field domain name of the website to analyze Note: results will be returned for the specified domain only","maxLength":2000,"minLength":1}},"required":["target"],"additionalProperties":false},"Input_dataforseo_domain_analytics_technologies_domains_by_html_terms":{"type":"object","properties":{"search_terms":{"type":"array","description":"target search terms required field specify target HTML elements, tags, attributes, their content or all of the above if you specify more than one search term, you will receive only the domains containing all of the specified terms in the HT","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"keywords":{"type":"array","description":"target keywords in the domain's title, description or meta keywords optional field UTF-8 encoding maximum number of keywords you can specify: 10 example: [\"seo\",\"software\"]learn more about rules and limitations of keyword and keywords field","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":10,"minItems":1},"mode":{"type":"string","description":"search mode optional field possible search mode types: strict_entry - search for results exactly matching the order, intervals and separators in the specified search terms entry - search for results ignoring the order, intervals and separat","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code possible sorting types: asc - results will be sorted in the ascending order desc - results will","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned domains optional field default value: 100 maximum value: 10000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains; Note: the maxi","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1}},"required":["search_terms"],"additionalProperties":false},"Input_dataforseo_domain_analytics_technologies_domains_by_technology":{"type":"object","properties":{"technology_paths":{"type":"array","description":"target technology paths required field if you don't specify groups, technologies, keywords or categories at least one field (technology_paths, groups, technologies, keywords or categories) must be set; each technology path should be specifi","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"groups":{"type":"array","description":"ids of the target technology groups required field if you don't specify technologies, technology_paths, keywords or categories you can find the full list of technology group ids on this page note: you can specify up to 10 technology groups ","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"categories":{"type":"array","description":"ids of the target technology categories required field if you don't specify groups, technology_paths, keywords or technologies you can find the full list of technology category ids on this page note: you can specify up to 10 technology cate","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"technologies":{"type":"array","description":"target technologies required field if you don't specify groups, technology_paths, keywords or categories you can find the full list of technologies you can specify here on this page note: you can specify up to 10 technologies in this array ","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"keywords":{"type":"array","description":"target keywords in the domain's title, description or meta keywords required field if you don't specify groups, technology_paths, technologies or categories optional field you can specify the maximum of 10 keywords; UTF-8 encoding; example:","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":10,"minItems":1},"mode":{"type":"string","description":"search mode optional field possible search mode types: as_is - search for results exactly matching the specified group ids, category ids, or technology names entry - search for results matching a part of the specified group ids, category id","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code possible sorting types: asc - results will be sorted in the ascending order desc - results will","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"limit":{"type":"integer","description":"the maximum number of returned domains optional field default value: 100 maximum value: 10000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains; Note: the maxi","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1}},"additionalProperties":false},"Input_dataforseo_domain_analytics_technologies_technologies_summary":{"type":"object","properties":{"technologies":{"type":"array","description":"target technologies required field if you don't specify groups, technology_paths, categories, or keywords you can find the full list of technologies you can specify here on this page note: you can specify up to 10 technologies in this array","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":10,"minItems":1},"mode":{"type":"string","const":"as_is","default":"as_is"},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: <, <=, >, >=, =, <>, in, no","items":{},"maxItems":15,"minItems":1},"internal_list_limit":{"type":"integer","description":"maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: countries, languages, content_languages, keywords default value: 10 minimum value: 1 maximu","minimum":1,"maximum":100,"default":10},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false,"required":["technologies"]},"Input_dataforseo_domain_analytics_technologies_technology_stats":{"type":"object","properties":{"technology":{"type":"string","description":"target technology required field you can find the full list of technologies you can specify here on this page example: \"Salesforce\"","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimum value: 2022-10-31 if you don't specify this field, the minimum value will be used by default date format: \"yyyy-mm-dd\" example: \"2023-06-01\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2023-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["technology"],"additionalProperties":false},"Input_dataforseo_domain_analytics_whois_overview":{"type":"object","properties":{"limit":{"type":"integer","description":"the maximum number of returned domains optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items; Note: we recommend u","minimum":0},"offset_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique off","maxLength":2000,"minLength":1},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, <, <=, >, >=, =, <>,","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order t","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"additionalProperties":false},"Input_dataforseo_keywords_data_bing_audience_estimation":{"type":"object","properties":{"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"age":{"type":"array","description":"selection of age ranges for targeting possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"bid":{"type":"number","description":"desired bid setting value in USD maximum value: 1000","maximum":1000},"daily_budget":{"type":"number","description":"daily campaign budget value in USD maximum value: 10000","maximum":10000},"gender":{"type":"array","description":"gender to target possible values: male, female, unknown","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"industry":{"type":"array","description":"industry of LinkedIn profile targetingif you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/indu","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"job_function":{"type":"array","description":"job function of LinkedIn profile targetingif you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_est","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]}]},"Input_dataforseo_keywords_data_bing_keyword_performance":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"device":{"type":"string","description":"device type optional field specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all default value: all","maxLength":2000,"minLength":1},"match":{"type":"string","description":"keywords match type optional field can take the following values: aggregate returns data across all match types; broad returns data for all user queries containing the specified keyword with varying word order; phrase returns data for all u","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations and l"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available locations and languages by making a separate request ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance","maxLength":10,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_bing_keyword_suggestions_for_url":{"type":"object","properties":{"target":{"type":"string","description":"required field; webpage URL, maximum length 2000 characters","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"required field if language_name omitted","maxLength":10,"minLength":1},"language_name":{"type":"string","description":"required field if language_code omitted","maxLength":2000,"minLength":1},"exclude_brands":{"type":"boolean"}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_bing_keywords_for_keywords":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters; the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about r","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code supported languages: English, French, German","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name supported languages: en, fr, de","maxLength":10,"minLength":1},"sort_by":{"type":"string","description":"results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance","maxLength":2000,"minLength":1},"keywords_negative":{"type":"array","description":"keywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to lowercase format","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"device":{"type":"string","description":"device type optional field specify this field if you want to get the data for a particular device type; possible values: all, mobile, desktop, tablet default value: all","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimal value: 24 months from today's date; if you don't specify this field, data will be provided for the last 12 months; if Status endpoint returns false in the actual_data field, date_from c","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today's date; date format: \"yyyy-mm-d","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"search_partners":{"type":"boolean","description":"Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search. default value: false -"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_bing_keywords_for_site":{"type":"object","properties":{"target":{"type":"string","description":"domain or URL required field the domain name or URL of the target website","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code supported languages: English, French, German","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name supported languages: en, fr, de","maxLength":10,"minLength":1},"keywords_negative":{"type":"array","description":"keywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to lowercase format","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"device":{"type":"string","description":"device type optional field specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet default value: all","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimal value: 24 months from today's date; if you don't specify this field, data will be provided for the last 12 months; if Status endpoint returns false in the actual_data field, date_from c","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today's date; note: we do not recomme","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"sort_by":{"type":"string","description":"results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance","maxLength":2000,"minLength":1},"search_partners":{"type":"boolean","description":"Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search. default value: false -"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["target"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_bing_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 100 the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more a","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code supported languages: English, French, German","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name supported languages: en, fr, de","maxLength":10,"minLength":1},"device":{"type":"string","description":"device type optional field specify this field if you want to get the data for a particular device type; possible values: all, mobile, desktop, tablet default value: all","maxLength":2000,"minLength":1},"sort_by":{"type":"string","description":"results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimal value: 24 months from today's date; if you don't specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; if Status endpoint re","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today's date; note: we do not recomme","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"search_partners":{"type":"boolean","description":"Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search. default value: false -"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_bing_search_volume_history":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 100 the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more a","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engines with their language_c","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engines with their language_code by m","maxLength":10,"minLength":1},"device":{"type":"array","description":"device types optional field specify this field if you want to get the data for a particular device types possible values: mobile, desktop, tablet, non_smartphones default value: [\"mobile\", \"desktop\", \"tablet\", \"non_smartphones\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"period":{"type":"string","description":"aggregates the returned data to a certain time period optional field specify this field if you want to get the data in monthly, weekly or daily formatpossible values: monthly, weekly, dailymonthly - returns data up to past 24 months weekly ","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field minimum value: 24 months back from today’s date; if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior; if Status endpoint returns t","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional fieldminimum value: two years back from today’s date; maximum value: one day from today's date; date format: \"yyyy-mm-dd\" example: \"2020-03-15\"Note: we do not recommend using a custom time rangeNote 2:","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_clickstream_data_bulk_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; the keywords will be converted to lowercase format; Note: certain symbols and c","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate ","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to t"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]}]},"Input_dataforseo_keywords_data_clickstream_data_dataforseo_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase formatNote: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed ","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don’t specify location_name if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywor"},"language_name":{"type":"string","description":"full name of search engine language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/click","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_d","maxLength":10,"minLength":1},"use_clickstream":{"type":"boolean","description":"use clickstream data to provide results optional field if set to true, you will get DataForSEO search volume values based on clickstream data; if set to false, Bing search volume data will be used to calculate DataForSEO search volume; defa"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_keywords_data_clickstream_data_global_search_volume":{"type":"object","properties":{"keywords":{"type":"array","description":"target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; the keywords will be converted to lowercase format; Note: certain symbols and c","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":100,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_keywords_data_dataforseo_trends_demography":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more abo","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":5,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_code you can receive the list of available locations of the search eng","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines wit"},"type":{"type":"string","description":"type of element","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 dat","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"time_range":{"type":"string","description":"preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_keywords_data_dataforseo_trends_explore":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field the maximum number of keywords you can specify: 5learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":5,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_code you can receive the list of available locations of the search eng","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines wit"},"type":{"type":"string","description":"type of element","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 dat","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"time_range":{"type":"string","description":"preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_keywords_data_dataforseo_trends_merged_data":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more abo","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":5,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_code you can receive the list of available locations of the search eng","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines wit"},"type":{"type":"string","description":"type of element","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 dat","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"time_range":{"type":"string","description":"preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_keywords_data_dataforseo_trends_subregion_interests":{"type":"object","properties":{"keywords":{"type":"array","description":"keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more abo","items":{"type":"string","maxLength":80,"minLength":1},"maxItems":5,"minItems":1},"location_name":{"type":"string","description":"full name of search engine location optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_code you can receive the list of available locations of the search eng","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code optional field if you don't use this field, you will recieve global results if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines wit"},"type":{"type":"string","description":"type of element","maxLength":2000,"minLength":1},"date_from":{"type":"string","description":"starting date of the time range optional field if you don't specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 dat","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"date_to":{"type":"string","description":"ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: \"yyyy-mm-dd\" example: \"2019-01-15\"","maxLength":2000,"pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$","minLength":1},"time_range":{"type":"string","description":"preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_google_ads_ad_traffic":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","maxLength":80},"minItems":1,"maxItems":1000},"bid":{"type":"number","minimum":0.01,"description":"Max CPC bid in USD."},"match":{"type":"string","enum":["exact","broad","phrase"]},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"date_interval":{"type":"string","enum":["next_week","next_month","next_quarter"],"default":"next_month"},"sort_by":{"type":"string","enum":["relevance","impressions","ctr","average_cpc","cost","clicks"],"default":"relevance"}},"required":["keywords","bid","match"],"additionalProperties":false},"Input_dataforseo_google_ads_keywords_for_keywords":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","maxLength":80},"minItems":1,"maxItems":20,"description":"Up to 20 seed keywords."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"search_partners":{"type":"boolean","default":false,"description":"Include Google search partners."},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Up to 4 years back."},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"include_adult_keywords":{"type":"boolean","default":false},"sort_by":{"type":"string","enum":["relevance","search_volume","competition_index","low_top_of_page_bid","high_top_of_page_bid"],"default":"relevance"}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_google_ads_keywords_for_site":{"type":"object","properties":{"target":{"type":"string","maxLength":300,"description":"Domain or URL."},"target_type":{"type":"string","enum":["site","page"],"default":"page"},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"search_partners":{"type":"boolean","default":false,"description":"Include Google search partners."},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Up to 4 years back."},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"include_adult_keywords":{"type":"boolean","default":false},"sort_by":{"type":"string","enum":["relevance","search_volume","competition_index","low_top_of_page_bid","high_top_of_page_bid"],"default":"relevance"}},"required":["target"],"additionalProperties":false},"Input_dataforseo_google_ads_search_volume":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","maxLength":80},"minItems":1,"maxItems":1000,"description":"Up to 1,000 keywords, same price for 1 or 1,000."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"search_partners":{"type":"boolean","default":false,"description":"Include Google search partners."},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Up to 4 years back."},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"include_adult_keywords":{"type":"boolean","default":false},"sort_by":{"type":"string","enum":["relevance","search_volume","competition_index","low_top_of_page_bid","high_top_of_page_bid"],"default":"relevance"}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_google_trends":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","minLength":2,"maxLength":100},"minItems":1,"maxItems":5,"description":"Up to 5 keywords to compare."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"type":{"type":"string","enum":["web","news","youtube","images","froogle"],"default":"web"},"category_code":{"type":"integer","minimum":0,"default":0},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"time_range":{"type":"string","enum":["past_hour","past_4_hours","past_day","past_7_days","past_30_days","past_90_days","past_12_months","past_5_years","2004_present","2008_present"]},"item_types":{"type":"array","items":{"type":"string","enum":["google_trends_graph","google_trends_map","google_trends_topics_list","google_trends_queries_list"]},"default":["google_trends_graph"]}},"required":["keywords"],"additionalProperties":false},"Input_dataforseo_amazon_asin":{"type":"object","properties":{"asin":{"type":"string","minLength":10,"maxLength":10},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"e.g. en_US, fr_FR, en_GB. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"e.g. English (United States)."},"se_domain":{"type":"string","maxLength":50}},"required":["asin"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_amazon_products_task":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"e.g. en_US, fr_FR, en_GB. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"e.g. English (United States)."},"se_domain":{"type":"string","maxLength":50,"description":"amazon.com, amazon.fr, amazon.co.uk... (auto by location)."},"department":{"type":"string","maxLength":100},"price_min":{"type":"integer","minimum":0},"price_max":{"type":"integer","minimum":0},"sort_by":{"type":"string","enum":["relevance","price_low_to_high","price_high_to_low","featured","avg_customer_review","newest_arrival"]},"depth":{"type":"integer","minimum":1,"maximum":700,"description":"Products, billed per SERP."},"priority":{"type":"integer","enum":[1,2],"description":"2 = high priority, x2, about one minute."},"action":{"type":"string","enum":["submit","result","live"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"e.g. en_US, fr_FR, en_GB. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"e.g. English (United States)."},"se_domain":{"type":"string","maxLength":50,"description":"amazon.com, amazon.fr, amazon.co.uk... (auto by location)."},"department":{"type":"string","maxLength":100},"price_min":{"type":"integer","minimum":0},"price_max":{"type":"integer","minimum":0},"sort_by":{"type":"string","enum":["relevance","price_low_to_high","price_high_to_low","featured","avg_customer_review","newest_arrival"]},"depth":{"type":"integer","minimum":1,"maximum":700,"default":100,"description":"Products, billed per SERP."},"priority":{"type":"integer","enum":[1,2],"default":1,"description":"2 = high priority, x2, about one minute."},"action":{"enum":["submit","live"]}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_amazon_sellers":{"type":"object","properties":{"asin":{"type":"string","minLength":10,"maxLength":10},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"e.g. en_US, fr_FR, en_GB. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"e.g. English (United States)."},"se_domain":{"type":"string","maxLength":50}},"required":["asin"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_merchant_google_product_info":{"type":"object","properties":{"product_id":{"type":"string","description":"unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by makin","maxLength":2000,"minLength":1},"data_docid":{"type":"string","description":"unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making ","maxLength":2000,"minLength":1},"gid":{"type":"string","description":"global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product b","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available Google Shopping l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations wit"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate req","maxLength":10,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"product_id":{"type":"string","description":"unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by makin","maxLength":2000,"minLength":1},"data_docid":{"type":"string","description":"unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making ","maxLength":2000,"minLength":1},"gid":{"type":"string","description":"global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product b","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available Google Shopping l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations wit"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate req","maxLength":10,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_google_shopping_products_task":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"se_domain":{"type":"string","maxLength":50,"description":"google.fr, google.co.uk... (auto by location)."},"price_min":{"type":"integer","minimum":0},"price_max":{"type":"integer","minimum":0},"sort_by":{"type":"string","enum":["review_score","price_low_to_high","price_high_to_low"]},"depth":{"type":"integer","minimum":1,"maximum":120,"description":"Products, billed per SERP of 40."},"priority":{"type":"integer","enum":[1,2],"description":"2 = high priority, x2, about one minute."},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"se_domain":{"type":"string","maxLength":50,"description":"google.fr, google.co.uk... (auto by location)."},"price_min":{"type":"integer","minimum":0},"price_max":{"type":"integer","minimum":0},"sort_by":{"type":"string","enum":["review_score","price_low_to_high","price_high_to_low"]},"depth":{"type":"integer","minimum":1,"maximum":120,"default":40,"description":"Products, billed per SERP of 40."},"priority":{"type":"integer","enum":[1,2],"default":1,"description":"2 = high priority, x2, about one minute."},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_merchant_google_reviews":{"type":"object","properties":{"gid":{"type":"string","description":"required field; global product identifier from Google Shopping Products","maxLength":2000,"minLength":1},"product_id":{"type":"string","maxLength":2000,"minLength":1},"data_docid":{"type":"string","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"required field if location_name omitted"},"location_name":{"type":"string","description":"required field if location_code omitted","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"required field if language_name omitted","maxLength":10,"minLength":1},"language_name":{"type":"string","description":"required field if language_code omitted","maxLength":2000,"minLength":1},"depth":{"type":"integer","minimum":1,"maximum":10},"priority":{"type":"integer","enum":[1,2]},"tag":{"type":"string","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"gid":{"type":"string","description":"required field; global product identifier from Google Shopping Products","maxLength":2000,"minLength":1},"product_id":{"type":"string","maxLength":2000,"minLength":1},"data_docid":{"type":"string","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"required field if location_name omitted"},"location_name":{"type":"string","description":"required field if location_code omitted","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"required field if language_name omitted","maxLength":10,"minLength":1},"language_name":{"type":"string","description":"required field if language_code omitted","maxLength":2000,"minLength":1},"depth":{"type":"integer","minimum":1,"maximum":10,"default":10},"priority":{"type":"integer","enum":[1,2],"default":1},"tag":{"type":"string","maxLength":255},"action":{"const":"submit"}},"required":["gid"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_merchant_google_sellers":{"type":"object","properties":{"product_id":{"type":"string","description":"unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by makin","maxLength":2000,"minLength":1},"data_docid":{"type":"string","description":"unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making ","maxLength":2000,"minLength":1},"gid":{"type":"string","description":"global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product b","maxLength":2000,"minLength":1},"pvf":{"type":"string","description":"product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available Google Shopping l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations wit"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate req","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional","maximum":10,"minimum":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.","maxLength":2000,"minLength":1},"get_shops_on_google":{"type":"boolean","description":"include \"buy on Google\" shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be doubled"},"additional_specifications":{"type":"object","description":"object containing additional url parameters you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint example","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"product_id":{"type":"string","description":"unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by makin","maxLength":2000,"minLength":1},"data_docid":{"type":"string","description":"unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making ","maxLength":2000,"minLength":1},"gid":{"type":"string","description":"global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product b","maxLength":2000,"minLength":1},"pvf":{"type":"string","description":"product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of the location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available Google Shopping l","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations wit"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate req","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional","maximum":10,"minimum":1,"default":10},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.","maxLength":2000,"minLength":1},"get_shops_on_google":{"type":"boolean","description":"include \"buy on Google\" shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be doubled"},"additional_specifications":{"type":"object","description":"object containing additional url parameters you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint example","properties":{},"additionalProperties":{"type":"string","maxLength":2000,"minLength":1}},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_on_page_content_parsing":{"type":"object","properties":{"url":{"type":"string","description":"URL of the content to parse required field URL of the page to parse example: `https://www.fujielectric.com/`","maxLength":2000,"minLength":1},"browser_preset":{"type":"string","description":"preset for browser screen parameters optional field if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will appl","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set"},"browser_screen_height":{"type":"integer","description":"browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, s"},"browser_screen_scale_factor":{"type":"number","description":"browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use t","minimum":0.5,"maximum":3},"store_raw_html":{"type":"boolean","description":"store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false"},"disable_cookie_popup":{"type":"boolean","description":"disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false"},"accept_language":{"type":"string","description":"language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"ty","maxLength":2000,"minLength":1},"switch_pool":{"type":"boolean","description":"switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable "},"ip_pool_for_scan":{"type":"string","description":"proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachabl","maxLength":2000,"minLength":1},"markdown_view":{"type":"boolean","description":"return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false"}},"required":["url"],"additionalProperties":false},"Input_dataforseo_on_page_crawl":{"type":"object","properties":{"target":{"type":"string","description":"target domain required field domain name should be specified without https:// and www. if you specify the page URL, the results will be returned for the domain included in the URL","maxLength":2000,"minLength":1},"start_url":{"type":"string","description":"the first url to crawl optional field Note: you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1 you can also use the live Instant Pages","maxLength":2000,"minLength":1},"force_sitewide_checks":{"type":"boolean","description":"enable sitewide checks when crawling a single page optional field set to true to get data on sitewide checks when crawling a single page; default value: false"},"priority_urls":{"type":"array","description":"urls to be crawled bypassing the queue optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; Note: you should specify the absolute URL; you can specify up to 20 URLs; all URLs in th","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":20,"minItems":1},"max_crawl_depth":{"type":"integer","description":"crawl depth optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc."},"crawl_delay":{"type":"integer","description":"delay between hits, ms optional field the custom delay between crawler hits to the server default value: 2000"},"store_raw_html":{"type":"boolean","default":true},"enable_content_parsing":{"type":"boolean","default":true},"support_cookies":{"type":"boolean","description":"support cookies on crawled pages optional field set to true to support cookies when crawling the pages default value: false"},"accept_language":{"type":"string","description":"language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"ty","maxLength":2000,"minLength":1},"browser_preset":{"type":"string","description":"preset for browser screen parameters optional field if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, mobile, tabletdesktop preset will apply ","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set"},"browser_screen_height":{"type":"integer","description":"browser screen height optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter"},"browser_screen_scale_factor":{"type":"number","description":"browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use t","maximum":3},"respect_sitemap":{"type":"boolean","description":"respect sitemap when crawling optional field set to true if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: false Note: if set to true, the click_depth value in the API response will equa"},"custom_sitemap":{"type":"string","description":"custom sitemap url optional field the URL of the page where the alternative sitemap is located Note: if you want to use this parameter, respect_sitemap should be true","maxLength":2000,"minLength":1},"crawl_sitemap_only":{"type":"boolean","description":"crawl only pages indicated in the sitemap optional field set to true if you want to crawl only the pages indicated in the sitemap if you set this parameter to true and do not specify custom_sitemap, we will crawl the default sitemap default"},"enable_www_redirect_check":{"type":"boolean","description":"check if the domain implemented the www redirection optional field set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: false"},"disable_cookie_popup":{"type":"boolean","description":"disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false"},"validate_micromarkup":{"type":"boolean","default":true},"allow_subdomains":{"type":"boolean","description":"include pages on subdomains optional field set to true if you want to crawl all subdomains of a target website default value: false"},"allowed_subdomains":{"type":"array","description":"subdomains to crawl optional field specify subdomains that you want to crawl example: [\"blog.site.com\", \"my.site.com\", \"shop.site.com\"] Note: to use this parameter, the allow_subdomains parameter should be set to false; otherwise, the conte","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"disallowed_subdomains":{"type":"array","description":"subdomains not to crawl optional field specify subdomains that you don't want to crawl example: [\"status.site.com\", \"docs.site.com\"] Note: to use this parameter, the allow_subdomains parameter should be set to true","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"check_spell_language":{"type":"string","description":"language of the spell check optional field supported languages: 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'm","maxLength":2000,"minLength":1},"check_spell_exceptions":{"type":"array","description":"words excluded from spell check optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: \"SERP\", \"minifiers\", \"JavaScript\"","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"checks_threshold":{"type":"object","description":"custom threshold values for checks optional field you can specify custom threshold values for the parameters included in the checks object of OnPage API responses; Note: only integer threshold values can be modified; for example, the high_l","properties":{},"additionalProperties":{"type":"integer"}},"disable_sitewide_checks":{"type":"array","description":"prevent certain sitewide checks from running optional field specify the following checks to prevent them from running on the target website: \"test_page_not_found\" \"test_canonicalization\" \"test_https_redirect\" \"test_directory_browsing\"exampl","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"disable_page_checks":{"type":"array","description":"prevent certain page checks from running optional field specify certain checks to prevent them from running and impacting the onpage_scoreexample: \"disable_page_checks\": [\"is_5xx_code\", \"is_4xx_code\"]","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"switch_pool":{"type":"boolean","description":"switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable "},"return_despite_timeout":{"type":"boolean","description":"return data on pages despite the timeout error optional field if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: false"},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"max_crawl_pages":{"type":"integer","minimum":1,"maximum":100,"default":5,"description":"Maximum pages Agentik authorizes the upstream crawler to fetch."},"load_resources":{"type":"boolean","default":false},"enable_javascript":{"type":"boolean","default":false},"enable_browser_rendering":{"type":"boolean","default":false},"calculate_keyword_density":{"type":"boolean","default":false}},"required":["target"],"additionalProperties":false,"allOf":[{"if":{"properties":{"enable_browser_rendering":{"const":true}},"required":["enable_browser_rendering"]},"then":{"properties":{"enable_javascript":{"const":true},"load_resources":{"const":true}},"required":["enable_javascript","load_resources"]}}]},"Input_dataforseo_on_page_duplicate_content":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"page URL required field specify the initial page you want to receive duplicate content for","maxLength":2000,"minLength":1},"similarity":{"type":"integer","description":"content similarity score by default, the content is considered duplicate if the value is greater than or equals 6 you can specify any similarity score in the 0-to-10 range"},"limit":{"type":"integer","description":"the maximum number of returned pages optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive page","maximum":2000000,"minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id","url"],"additionalProperties":false},"Input_dataforseo_on_page_duplicate_tags":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"type":{"type":"string","enum":["duplicate_title","duplicate_description"],"description":"Which duplicated tag to inspect."},"accumulator":{"type":"string","description":"tag value optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned pages optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive page","maximum":2000000,"minimum":0},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id","type"],"additionalProperties":false},"Input_dataforseo_on_page_force_stop":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"note: you can set up to 1000 id values as separate objects in the POST array","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_instant_pages":{"type":"object","properties":{"url":{"type":"string","description":"target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 ","maxLength":2000,"minLength":1},"browser_preset":{"type":"string","description":"preset for browser screen parametersoptional fieldif you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen widthoptional fieldyou can set a custom browser screen width to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set ena"},"browser_screen_height":{"type":"integer","description":"browser screen heightoptional fieldyou can set a custom browser screen height to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set e"},"browser_screen_scale_factor":{"type":"number","description":"browser screen scale factoroptional fieldyou can set a custom browser screen resolution ratio to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this "},"store_raw_html":{"type":"boolean","description":"store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false"},"accept_language":{"type":"string","description":"language header for accessing the websiteoptional fieldall locale formats are supported (xx, xx-XX, xxx-XX, etc.)Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\"","maxLength":2000,"minLength":1},"disable_cookie_popup":{"type":"boolean","description":"disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false"},"return_despite_timeout":{"type":"boolean","description":"return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false"},"validate_micromarkup":{"type":"boolean","description":"enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false"},"checks_threshold":{"type":"object","description":"custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified;","properties":{},"additionalProperties":{"type":"integer"}},"switch_pool":{"type":"boolean","description":"switch proxy pooloptional fieldif true, additional proxy pools will be used to obtain the requested data;the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable err"},"ip_pool_for_scan":{"type":"string","description":"proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable e","maxLength":2000,"minLength":1}},"required":["url"],"additionalProperties":false},"Input_dataforseo_on_page_keyword_density":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"keyword_length":{"type":"integer","description":"number of words for a keyword required field possible values: 1, 2, 3, 4, 5"},"url":{"type":"string","description":"page URL optional field if you do not specify a page here, the results will be provided for the whole website if you use this field, the API response will contain only keywords from the specified page a page should be specified with absolut","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned keywords optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id","keyword_length"],"additionalProperties":false},"Input_dataforseo_on_page_lighthouse":{"type":"object","properties":{"url":{"type":"string","description":"target URL required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/","maxLength":2000,"minLength":1},"for_mobile":{"type":"boolean","description":"applies mobile emulation optional field if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment if set to false, the results will be provided for desktop default value: false"},"categories":{"type":"array","description":"categories of Lighthouse audits optional field each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)if you ignore this field, we will return data for all categor","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"audits":{"type":"array","description":"Lighthouse audits optional field audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition); if you ignore this field, we will return data for all audits; u","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"version":{"type":"string","description":"lighthouse version optional field you can obtain the results specific to a certain Lighthouse version by specifying its number the list of available versions is available through the Lighthouse Versions endpoint","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"lighthouse language name optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages default value: ","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"lighthouse language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages default value: ","maxLength":10,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen width optional field set the screen width of the browser used for the Lighthouse audit to emulate a specific device; can be specified within the following range: 240–9999;"},"browser_screen_height":{"type":"integer","description":"browser screen height optional field set the screen height of the browser used for the Lighthouse audit to emulate a specific device; can be specified within the following range: 240–9999;"},"browser_screen_scale_factor":{"type":"number","description":"browser screen scale factor optional field set the device pixel ratio of the browser used for the Lighthouse audit; can be specified within the following range: 0.5–3;"},"browser_network_throttling_method":{"type":"string","description":"browser network throttling method optional field defines the method used to apply throttling during the Lighthouse audit; possible vaules: simulate - calculates estimated performance metrics without applying explicit throttling; devtools - ","maxLength":2000,"minLength":1},"browser_cpu_throttling_multiplier":{"type":"number","description":"browser CPU throttling multiplier required if browser_network_throttling_method is set to devtools; set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit; can be specified within the followi"},"browser_network_throttling":{"type":"string","description":"browser network throttling required if browser_network_throttling_method is set to devtools; set the network throttling profile to simulate connection speed conditions during the Lighthouse audit; possible values: no_throttling, fast_4g, sl","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["url"],"additionalProperties":false},"Input_dataforseo_on_page_links":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"page_from":{"type":"string","description":"relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only","maxLength":2000,"minLength":1},"page_to":{"type":"string","description":"relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned links optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive link","maximum":2000000,"minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in","items":{},"maxItems":15,"minItems":1},"search_after_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique sear","maxLength":2000},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_microdata":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id","url"],"additionalProperties":false},"Input_dataforseo_on_page_non_indexable":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"limit":{"type":"integer","description":"the maximum number of returned pages optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive page","maximum":2000000,"minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_page_screenshot":{"type":"object","properties":{"url":{"type":"string","description":"page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain \"error_message\":\"Screenshot is empty\" in the response array","maxLength":2000,"minLength":1},"accept_language":{"type":"string","description":"language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) note: if you do not specify this parameter, some websites may deny access; in this case, you will obtain \"error_message\":\"Sc","maxLength":2000,"minLength":1},"browser_preset":{"type":"string","description":"preset for browser screen parameters optional field if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, mobile, tabletdesktop preset will apply ","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value, in pixels: 240 max"},"browser_screen_height":{"type":"integer","description":"browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value, in pixels: 240 m"},"browser_screen_scale_factor":{"type":"number","description":"browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value: ","minimum":0.5,"maximum":3},"full_page_screenshot":{"type":"boolean","description":"take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true"},"disable_cookie_popup":{"type":"boolean","description":"disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false"},"switch_pool":{"type":"boolean","description":"switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable "},"ip_pool_for_scan":{"type":"string","description":"proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachabl","maxLength":2000,"minLength":1},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["id","url"],"additionalProperties":false},"Input_dataforseo_on_page_pages":{"type":"object","properties":{"id":{"type":"string","description":"ID of the taskrequired fieldyou can get this ID in the response of the Task POST endpointexample:\"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"limit":{"type":"integer","description":"the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000","minimum":1,"maximum":100,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned pagesoptional fielddefault value: 0maximum value: 2000000if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages","minimum":0},"filters":{"type":"array","description":"array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, i","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou sho","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"search_after_token":{"type":"string","description":"token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;by specifying the unique search_a","maxLength":2000},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_raw_html":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"page url required field the absolute URL of a page to request HTML Note: this field is optional if the task was set using the Instant Pages endpoint","maxLength":2000,"minLength":1}},"required":["id","url"],"additionalProperties":false},"Input_dataforseo_on_page_redirect_chains":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"page URL optional field absolute URL of the target page if you use this field, the API response will return only redirect chains which contain the specified URL","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned redirect chains optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned redirect chains optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the data will be provided for","maximum":2000000,"minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can use only one filtering parameter with this endpointthe following filtering parameter is supported: is_redirect_loop the following operators are supported: regex, not_regex, =, <>e","items":{},"maxItems":15,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_resources":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"page URL optional field specify this field if you want to get the resources for a specific page note that to obtain resource's meta from a particular URL, you should specify the URL in this field; if you do not indicate a url when setting a","maxLength":2000,"minLength":1},"limit":{"type":"integer","description":"the maximum number of returned resources optional field default value: 100 maximum value: 1000","maximum":100,"minimum":1,"default":10},"offset":{"type":"integer","description":"offset in the results array of returned resources optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be provided for the success","maximum":2000000,"minimum":0},"filters":{"type":"array","description":"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >,","items":{},"maxItems":15,"minItems":1},"relevant_pages_filters":{"type":"array","description":"filter the resources by relevant pages optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the pages endpoint you can add several filte","items":{},"maxItems":15,"minItems":1},"order_by":{"type":"array","description":"results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order y","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":3,"minItems":1},"search_after_token":{"type":"string","description":"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique sear","maxLength":2000},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_summary":{"type":"object","properties":{"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["id"],"additionalProperties":false},"Input_dataforseo_on_page_waterfall":{"type":"object","properties":{"id":{"type":"string","description":"ID of the task required field you can get this ID in the response of the Task POST endpoint example: \"07131248-1535-0216-1000-17384017ad04\"","maxLength":80,"minLength":8,"pattern":"^[A-Za-z0-9-]+$"},"url":{"type":"string","description":"page URL required field specify the pages you want to receive timing for","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255}},"required":["id","url"],"additionalProperties":false},"Input_dataforseo_serp_baidu_organic":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine retu","maximum":10,"minimum":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.c","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/se","maxLength":10,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values: desktop, mobile, tablet default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"get_website_url":{"type":"boolean","description":"include direct URL for each ranked result optional field if set to true, the returned results will contain direct URLs of the ranked websites by default, the URLs in Baidu results are encoded by the search engine, for example: http://www.ba"},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine retu","maximum":10,"minimum":1,"default":10},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.c","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/se","maxLength":10,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values: desktop, mobile, tablet default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"get_website_url":{"type":"boolean","description":"include direct URL for each ranked result optional field if set to true, the returned results will contain direct URLs of the ranked websites by default, the URLs in Baidu results are encoded by the search engine, for example: http://www.ba"},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]}}]},"Input_dataforseo_serp_bing_organic":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the \"%\" character for your keyword, please specify it as \"%25\"","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns m","minimum":1,"maximum":10,"default":10},"device":{"type":"string","description":"device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, ios","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"target":{"type":"string","description":"target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url stri","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"match_type":{"type":"string","description":"target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern","maxLength":2000,"minLength":1},"match_value":{"type":"string","description":"target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\"","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 f"},"browser_screen_height":{"type":"integer","description":"browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640"},"browser_screen_resolution_ratio":{"type":"integer","description":"browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 f"},"url":{"type":"string","description":"direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language","maxLength":2000,"minLength":1},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_google_ads_advertisers":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700,"description":"Advertiser or brand name."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."}},"required":["keyword"],"additionalProperties":false,"allOf":[{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_google_ads_search":{"type":"object","properties":{"target":{"type":"string","maxLength":300,"description":"Advertiser domain (one of target or advertiser_ids)."},"advertiser_ids":{"type":"array","items":{"type":"string"},"maxItems":25,"description":"Advertiser ids from dataforseo/google-ads-advertisers."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\")."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"platform":{"type":"string","enum":["all","google_play","google_maps","google_search","google_shopping","youtube"],"default":"all"},"format":{"type":"string","enum":["all","text","image","video"],"default":"all"},"date_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"From 2018-05-31."},"date_to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"depth":{"type":"integer","minimum":1,"maximum":120,"default":40,"description":"Ads, billed per 40."}},"additionalProperties":false},"Input_dataforseo_google_ai_mode":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700,"description":"Search query. Operators such as site: or intitle: multiply the price by 5."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"device":{"type":"string","enum":["desktop","mobile"],"default":"desktop"},"os":{"type":"string","enum":["windows","macos","android","ios"],"description":"windows or macos for desktop, android or ios for mobile."},"calculate_rectangles":{"type":"boolean","default":false,"description":"Pixel positions (x2)."}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_autocomplete":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/g"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code by maki","maxLength":10,"minLength":1},"cursor_pointer":{"type":"integer","description":"search bar cursor pointeroptional fieldthe horizontal numerical position of the cursor pointer within the keyword in the search bar;by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the "},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name","maxLength":2000,"minLength":1},"client":{"type":"string","description":"search client for autocompleteoptional fieldautocomplete results may differ depending on the search client;possible values:chrome — used when google search is opened in google chrome;chrome-omni — used in the address bar in chrome;gws-wiz —","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_dataset_info":{"type":"object","properties":{"dataset_id":{"type":"string","description":"ID of the datasetrequired fieldyou can find dataset ID in the dataset URL or dataset item of Google Dataset Search resultexample:L2cvMTFqbl85ZHN6MQ==","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language codeoptional fieldif you use this field, you don't need to specify language_namepossible value:en","maxLength":10,"minLength":1},"device":{"type":"string","description":"device typeoptional fieldreturn results for a specific device typepossible value: desktop","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldpossible values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255}},"required":["dataset_id"],"additionalProperties":false},"Input_dataforseo_serp_google_dataset_search":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”","maxLength":700,"minLength":1},"language_code":{"type":"string","description":"search engine language codeoptional field if you don't specify language_nameif you use this field, you don't need to specify language_namepossible value:en","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 20max value: 200 Your account will be billed per each SERP containing up to 20 results;Setting depth above 20 may result in additional charges if the search engine returns m","minimum":1,"maximum":10,"default":10},"device":{"type":"string","description":"device typeoptional fieldreturn results for a specific device typepossible value: desktop","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldchoose from the following values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"last_updated":{"type":"string","description":"last time the dataset was updatedoptional fieldpossible values: 1m, 1y, 3y","maxLength":2000,"minLength":1},"file_formats":{"type":"array","description":"file formats of the datasetoptional fieldpossible values: other, archive, text, image, document, tabular","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"usage_rights":{"type":"string","description":"usage rights of the datasetoptional fieldpossible values: commercial, noncommercial","maxLength":2000,"minLength":1},"is_free":{"type":"boolean","description":"indicates whether displayed datasets are freeoptional fieldpossible values: true, false"},"topics":{"type":"array","description":"dataset topicsoptional fieldpossible values: humanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineering","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1}},"required":["keyword"],"additionalProperties":false,"allOf":[{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_events":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the \"%\" character for your keyword, please specify it as \"%25\"","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language codeoptional fieldif you use this field, you don't need to specify language_nameby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of avai","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns m","minimum":1,"maximum":10},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority You will be additionally charged for the tasks with high execution priority;The cost can be calculated on th","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codeby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"date_range":{"type":"string","description":"date range to get events foroptional fieldif you do not use this field, we will return all eventspossible values: today, tomorrow, week, weekend, next_week, month, next_month","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de,","maxLength":2000,"minLength":1},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the \"%\" character for your keyword, please specify it as \"%25\"","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language codeoptional fieldif you use this field, you don't need to specify language_nameby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of avai","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns m","minimum":1,"maximum":10,"default":10},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority You will be additionally charged for the tasks with high execution priority;The cost can be calculated on th","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codeby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"date_range":{"type":"string","description":"date range to get events foroptional fieldif you do not use this field, we will return all eventspossible values: today, tomorrow, week, weekend, next_week, month, next_month","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de,","maxLength":2000,"minLength":1},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]}}]},"Input_dataforseo_google_finance_explore":{"type":"object","properties":{"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"news_type":{"type":"string","enum":["top_stories","local_market","world_markets"],"default":"top_stories","description":"local_market and world_markets cost x2."}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_google_finance_markets":{"type":"object","properties":{"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"market_type":{"type":"string","enum":["most-active","indexes","indexes/americas","indexes/europe-middle-east-africa","indexes/asia-pacific","gainers","losers","climate-leaders","cryptocurrencies","currencies"],"default":"most-active"}},"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_google_finance_quote":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":100,"description":"Ticker with exchange, e.g. NVDA:NASDAQ, AIR:EPA, BTC-USD."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"window":{"type":"string","enum":["1D","5D","1M","6M","YTD","1Y","5Y","MAX"],"default":"1D","description":"Chart window; anything but 1D costs x2."}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_google_finance_ticker_search":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":200,"description":"Company or instrument name, e.g. Airbus."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"category":{"type":"string","enum":["all","stock","index","mutual_fund","currency","futures"],"default":"all"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_images":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the \"%\" character for your keyword, please specify it as \"%25\"","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 200 Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine return","minimum":1,"maximum":10,"default":10},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"url":{"type":"string","description":"direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language","maxLength":2000,"minLength":1},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldWe choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com","maxLength":2000,"minLength":1}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_jobs":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/g"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code by maki","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERP;default value: 10max value: 200 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns ","minimum":1,"maximum":10},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority You will be additionally charged for the tasks with high execution priority;The cost can be calculated on th","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"location_radius":{"type":"string","description":"location search radiusoptional fieldlocation search radius in kilometers;Note: for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by 1.609;if value is not spec","maxLength":2000,"minLength":1},"employment_type":{"type":"array","description":"employment contract typeoptional fieldtype of employment contract for which the search results will be returned;possible values:fulltime, partime, contractor, intern","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/g"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code by maki","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERP;default value: 10max value: 200 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns ","minimum":1,"maximum":10,"default":10},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority You will be additionally charged for the tasks with high execution priority;The cost can be calculated on th","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"location_radius":{"type":"string","description":"location search radiusoptional fieldlocation search radius in kilometers;Note: for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by 1.609;if value is not spec","maxLength":2000,"minLength":1},"employment_type":{"type":"array","description":"employment contract typeoptional fieldtype of employment contract for which the search results will be returned;possible values:fulltime, partime, contractor, intern","items":{"type":"string","maxLength":2000,"minLength":1},"maxItems":100,"minItems":1},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]}}]},"Input_dataforseo_serp_google_local_finder":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value for desktop: 20max value for desktop: 100 default value for mobile: 10max value for mobile: 100 Your account will be billed per each SERP containing up to 20 results for desk","minimum":1,"maximum":10,"default":10},"device":{"type":"string","description":"device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop","maxLength":2000,"minLength":1},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, ios","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the","enum":[1,2],"default":1},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"min_rating":{"type":"number","description":"filter results by minimum ratingoptional fieldpossible values for desktop: 3.5, 4, 4.5;possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5"},"time_filter":{"type":"string","description":"filter results by open hoursoptional fieldusing this field, you can filter places in the results by the time a place is open for visitorsnote that Google may also provide results that do not match this filterpossible values: \"open_now\", \"24","maxLength":2000,"minLength":1}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_google_maps":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700,"description":"Search query. Operators such as site: or intitle: multiply the price by 5."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"device":{"type":"string","enum":["desktop","mobile"],"default":"desktop"},"os":{"type":"string","enum":["windows","macos","android","ios"],"description":"windows or macos for desktop, android or ios for mobile."},"location_coordinate":{"type":"string","maxLength":60,"description":"\"latitude,longitude,zoom\" instead of a location code."},"depth":{"type":"integer","minimum":1,"maximum":700,"default":20,"description":"Results, billed per 100 (max 20 on mobile)."},"search_places":{"type":"boolean","default":true},"search_this_area":{"type":"boolean","default":true}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_news":{"type":"object","properties":{"keyword":{"type":"string","description":"keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the \"%\" character for your keyword, please specify it as \"%25\"","maxLength":700,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"depth":{"type":"integer","description":"parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200 Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns m","minimum":1,"maximum":10,"default":10},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows","maxLength":2000,"minLength":1},"browser_screen_width":{"type":"integer","description":"browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_height":{"type":"integer","description":"browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_resolution_ratio":{"type":"integer","description":"browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangle"},"url":{"type":"string","description":"direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language","maxLength":2000,"minLength":1},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.a","maxLength":2000,"minLength":1}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_google_organic":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700,"description":"Search query. Operators such as site: or intitle: multiply the price by 5."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"device":{"type":"string","enum":["desktop","mobile"],"default":"desktop"},"os":{"type":"string","enum":["windows","macos","android","ios"],"description":"windows or macos for desktop, android or ios for mobile."},"depth":{"type":"integer","minimum":1,"maximum":200,"default":10,"description":"Number of results, billed per 10."},"max_crawl_pages":{"type":"integer","minimum":1,"maximum":100,"description":"Pages to crawl, each billed as a SERP."},"se_domain":{"type":"string","maxLength":100,"description":"Google domain, e.g. google.fr (auto by location)."},"target":{"type":"string","maxLength":300,"description":"Only results from this domain, subdomain or URL (wildcards allowed)."},"group_organic_results":{"type":"boolean","default":true},"calculate_rectangles":{"type":"boolean","default":false,"description":"Pixel positions (+$0.002)."},"load_async_ai_overview":{"type":"boolean","default":false,"description":"Load the AI overview (+$0.002)."},"remove_from_url":{"type":"array","items":{"type":"string"},"maxItems":10}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_serp_google_search_by_image":{"type":"object","properties":{"image_url":{"type":"string","description":"URL of the imagerequired fieldthe results will be based on the image you specified in this fieldexample:https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the","enum":[1,2]},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"browser_screen_width":{"type":"integer","description":"browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_height":{"type":"integer","description":"browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_resolution_ratio":{"type":"integer","description":"browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangle"},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.a","maxLength":2000,"minLength":1},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"image_url":{"type":"string","description":"URL of the imagerequired fieldthe results will be based on the image you specified in this fieldexample:https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the s"},"language_code":{"type":"string","description":"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by makin","maxLength":10,"minLength":1},"priority":{"type":"integer","description":"task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the","enum":[1,2],"default":1},"location_name":{"type":"string","description":"full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations ","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name ","maxLength":2000,"minLength":1},"tag":{"type":"string","description":"user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response","maxLength":255},"browser_screen_width":{"type":"integer","description":"browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_height":{"type":"integer","description":"browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true"},"browser_screen_resolution_ratio":{"type":"integer","description":"browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangle"},"location_coordinate":{"type":"string","description":"GPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.a","maxLength":2000,"minLength":1},"action":{"const":"submit"}},"required":["image_url"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]}}]},"Input_dataforseo_serp_naver_organic":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"url":{"type":"string","description":"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields in most cases, we wouldn’t recommend using this method; example: https://search.naver.com/search.naver?where=nexearch","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine retu","maximum":10,"minimum":1},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically however, you can set a custom search engine domain in this field example: search.naver.com","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"url":{"type":"string","description":"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields in most cases, we wouldn’t recommend using this method; example: https://search.naver.com/search.naver?where=nexearch","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine retu","maximum":10,"minimum":1,"default":10},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically however, you can set a custom search engine domain in this field example: search.naver.com","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]}}]},"Input_dataforseo_serp_seznam_organic":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by m"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_na","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code_by ma","maxLength":10,"minLength":1},"url":{"type":"string","description":"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields; note that this method is the most difficult for our API to process and also requires you to specify the exact langua","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2]},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engin","maximum":10,"minimum":1},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically however, you can set a custom search engine domain in this field example: search.seznam.cz","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"type":"string","enum":["submit","result"],"default":"submit"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"allOf":[{"if":{"properties":{"action":{"const":"result"}},"required":["action"]},"then":{"type":"object","properties":{"action":{"const":"result"},"id":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9-]+$"}},"required":["action","id"],"additionalProperties":false},"else":{"type":"object","properties":{"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_na","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by m"},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_na","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code_by ma","maxLength":10,"minLength":1},"url":{"type":"string","description":"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields; note that this method is the most difficult for our API to process and also requires you to specify the exact langua","maxLength":2000,"minLength":1},"priority":{"type":"integer","description":"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated o","enum":[1,2],"default":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engin","maximum":10,"minimum":1,"default":10},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically however, you can set a custom search engine domain in this field example: search.seznam.cz","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"action":{"const":"submit"}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]}}]},"Input_dataforseo_serp_yahoo_organic":{"type":"object","properties":{"url":{"type":"string","description":"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact langua","maxLength":2000,"minLength":1},"keyword":{"type":"string","description":"keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your keyword, please specify it as \"","maxLength":700,"minLength":1},"location_name":{"type":"string","description":"full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locatio","maxLength":2000,"minLength":1},"location_code":{"type":"integer","description":"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of th"},"location_coordinate":{"type":"string","description":"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latit","maxLength":2000,"minLength":1},"language_name":{"type":"string","description":"full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_na","maxLength":2000,"minLength":1},"language_code":{"type":"string","description":"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code_by ma","maxLength":10,"minLength":1},"device":{"type":"string","description":"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop","maxLength":2000,"minLength":1},"os":{"type":"string","description":"device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android,","maxLength":2000,"minLength":1},"se_domain":{"type":"string","description":"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: au.search.yahoo.com, ","maxLength":2000,"minLength":1},"depth":{"type":"integer","description":"parsing depth optional field number of results in SERP default value: 6 max value: 200 Your account will be billed per each SERP; Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in addi","maximum":10,"minimum":1,"default":10},"target":{"type":"string","description":"target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without https:// and www. note that the results of target-specific tasks will only include SERP elements that contain a url s","maxLength":2000,"minLength":1},"stop_crawl_on_match":{"type":"array","description":"array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"matc","items":{"type":"object","properties":{"match_value":{"type":"string","description":"arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: dataforseo.com","maxLength":2000,"minLength":1},"match_type":{"type":"string","description":"target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard","maxLength":2000,"minLength":1}},"additionalProperties":false},"maxItems":10,"minItems":1},"tag":{"type":"string","description":"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response","maxLength":255},"max_crawl_pages":{"type":"integer","const":2,"default":2}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]},{"required":["location_coordinate"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_youtube_search":{"type":"object","properties":{"keyword":{"type":"string","minLength":1,"maxLength":700,"description":"Search query. Operators such as site: or intitle: multiply the price by 5."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"device":{"type":"string","enum":["desktop","mobile"],"default":"desktop"},"os":{"type":"string","enum":["windows","macos","android","ios"],"description":"windows or macos for desktop, android or ios for mobile."},"block_depth":{"type":"integer","minimum":20,"maximum":200,"default":20,"description":"Results, billed per block of 20."}},"required":["keyword"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]},{"not":{"properties":{"keyword":{"pattern":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"}},"required":["keyword"]}},{"not":{"properties":{"keyword":{"pattern":"%[0-9a-fA-F]{2}"}},"required":["keyword"]}}]},"Input_dataforseo_youtube_video_comments":{"type":"object","properties":{"video_id":{"type":"string","minLength":5,"maxLength":20},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"depth":{"type":"integer","minimum":1,"maximum":200,"default":20,"description":"Comments, billed per 20."}},"required":["video_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_youtube_video_info":{"type":"object","properties":{"video_id":{"type":"string","minLength":5,"maxLength":20,"description":"YouTube video id (the v= parameter)."},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."}},"required":["video_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_dataforseo_youtube_video_subtitles":{"type":"object","properties":{"video_id":{"type":"string","minLength":5,"maxLength":20},"location_code":{"type":"integer","description":"Location code from DataForSEO (location_code (2840 United States, 2250 France, 2826 United Kingdom, 2276 Germany, 2724 Spain, 2380 Italy, 2124 Canada) or location_name such as \"Paris,Ile-de-France,France\"). One of location_code or location_name is required."},"location_name":{"type":"string","maxLength":200,"description":"Full location name, e.g. \"London,England,United Kingdom\" or \"France\"."},"language_code":{"type":"string","maxLength":10,"description":"Language code, e.g. en, fr, de. One of language_code or language_name is required."},"language_name":{"type":"string","maxLength":60,"description":"Language name, e.g. English."},"subtitles_language":{"type":"string","maxLength":10,"description":"Language code of the original subtitles."},"subtitles_translate_language":{"type":"string","maxLength":10,"description":"Translate subtitles into this language code."}},"required":["video_id"],"additionalProperties":false,"allOf":[{"anyOf":[{"required":["location_code"]},{"required":["location_name"]}]},{"anyOf":[{"required":["language_code"]},{"required":["language_name"]}]}]},"Input_leadsforge_account_balance":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_company_followers_filters_countries":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_company_followers_filters_departments":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_company_followers_filters_job_titles":{"type":"object","properties":{"search":{"type":"string","description":"Search query","maxLength":2048},"page":{"minimum":1,"type":"integer","description":"Page number"},"page_size":{"maximum":20,"minimum":1,"type":"integer","description":"Page size"}},"additionalProperties":false},"Input_leadsforge_company_followers_filters_levels":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_company_followers_filters_states":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_list_company_followers_jobs":{"type":"object","properties":{"offset":{"type":"integer","description":"Offset","minimum":0,"maximum":1000000,"default":0},"limit":{"type":"integer","description":"Page size (max 100)","minimum":1,"maximum":100,"default":25},"status":{"enum":["in_progress","completed","failed","no_results"],"type":"string","description":"Filter by status","maxLength":2048},"clientRequestID":{"type":"string","description":"Filter by your clientRequestID","maxLength":2048},"from":{"type":"string","description":"Created-at lower bound (RFC3339)","maxLength":2048,"format":"date-time"},"to":{"type":"string","description":"Created-at upper bound (RFC3339)","maxLength":2048,"format":"date-time"}},"additionalProperties":false,"required":["limit"]},"Input_leadsforge_get_company_followers_job":{"type":"object","properties":{"jobID":{"type":"string","description":"Job ID","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"}},"additionalProperties":false,"required":["jobID"]},"Input_leadsforge_get_company_followers_results":{"type":"object","properties":{"jobID":{"type":"string","description":"Job ID","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"},"offset":{"type":"integer","description":"Offset","minimum":0,"maximum":1000000,"default":0},"limit":{"type":"integer","description":"Page size","minimum":1,"maximum":100,"default":25}},"additionalProperties":false,"required":["jobID"]},"Input_leadsforge_search_company_followers":{"type":"object","required":["limit","linkedinUrl"],"properties":{"clientRequestID":{"type":"string","maxLength":128},"countries":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"departments":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"jobTitles":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"levels":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"limit":{"type":"integer","maximum":50000,"minimum":1},"linkedinUrl":{"type":"string","maxLength":2048,"pattern":"^https://(?:www\\.)?linkedin\\.com/company/[^\\s]+$"},"states":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"webhookURL":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://[^\\s]+$"}},"additionalProperties":false},"Input_leadsforge_find_email":{"type":"object","properties":{"company":{"type":"string","maxLength":2048,"minLength":1},"companyDomain":{"type":"string","maxLength":2048,"minLength":1},"externalID":{"type":"string","maxLength":128},"firstName":{"type":"string","maxLength":2048,"minLength":1},"lastName":{"type":"string","maxLength":2048,"minLength":1},"linkedinURL":{"type":"string","maxLength":2048,"minLength":1,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$"},"personID":{"type":"string","maxLength":2048,"minLength":1}},"additionalProperties":false,"anyOf":[{"required":["linkedinURL"]},{"required":["firstName","lastName","company"]},{"required":["firstName","lastName","companyDomain"]},{"required":["personID"]}]},"Input_leadsforge_find_emails_batch":{"type":"object","properties":{"clientRequestID":{"type":"string","maxLength":128},"people":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"object","properties":{"company":{"type":"string","maxLength":2048,"minLength":1},"companyDomain":{"type":"string","maxLength":2048,"minLength":1},"externalID":{"type":"string","maxLength":128},"firstName":{"type":"string","maxLength":2048,"minLength":1},"lastName":{"type":"string","maxLength":2048,"minLength":1},"linkedinURL":{"type":"string","maxLength":2048,"minLength":1,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$"}},"additionalProperties":false,"anyOf":[{"required":["linkedinURL"]},{"required":["firstName","lastName","company"]},{"required":["firstName","lastName","companyDomain"]}]}},"personIDs":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"string","maxLength":256,"minLength":1},"uniqueItems":true},"saveToList":{"type":"boolean","default":false},"webhookURL":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://[^\\s]+$"}},"additionalProperties":false,"oneOf":[{"required":["people"],"not":{"required":["personIDs"]}},{"required":["personIDs"],"not":{"required":["people"]}}]},"Input_leadsforge_list_enrichment_jobs":{"type":"object","properties":{"offset":{"type":"integer","description":"Offset","minimum":0,"maximum":1000000,"default":0},"limit":{"type":"integer","description":"Page size (max 100)","minimum":1,"maximum":100,"default":25},"status":{"enum":["in_progress","completed","failed"],"type":"string","description":"Filter by status","maxLength":2048},"channel":{"enum":["email","phone","linkedin"],"type":"string","description":"Filter by channel","maxLength":2048},"clientRequestID":{"type":"string","description":"Filter by your clientRequestID","maxLength":2048},"from":{"type":"string","description":"Created-at lower bound (RFC3339)","maxLength":2048,"format":"date-time"},"to":{"type":"string","description":"Created-at upper bound (RFC3339)","maxLength":2048,"format":"date-time"}},"additionalProperties":false,"required":["limit"]},"Input_leadsforge_get_enrichment_job":{"type":"object","properties":{"jobID":{"type":"string","description":"Job ID","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"}},"additionalProperties":false,"required":["jobID"]},"Input_leadsforge_get_enrichment_results":{"type":"object","properties":{"jobID":{"type":"string","description":"Job ID","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"},"offset":{"type":"integer","description":"Offset","minimum":0,"maximum":1000000,"default":0},"limit":{"type":"integer","description":"Page size","minimum":1,"maximum":100,"default":25}},"additionalProperties":false,"required":["jobID","limit"]},"Input_leadsforge_find_linkedin_batch":{"type":"object","properties":{"clientRequestID":{"type":"string","maxLength":128},"people":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"object","properties":{"company":{"type":"string","maxLength":2048,"minLength":1},"companyDomain":{"type":"string","maxLength":2048,"minLength":1},"externalID":{"type":"string","maxLength":128},"firstName":{"type":"string","maxLength":2048,"minLength":1},"lastName":{"type":"string","maxLength":2048,"minLength":1},"linkedinURL":{"type":"string","maxLength":2048,"minLength":1,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$"}},"additionalProperties":false,"anyOf":[{"required":["linkedinURL"]},{"required":["firstName","lastName","company"]},{"required":["firstName","lastName","companyDomain"]}]}},"personIDs":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"string","maxLength":256,"minLength":1},"uniqueItems":true},"saveToList":{"type":"boolean","default":false},"webhookURL":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://[^\\s]+$"}},"additionalProperties":false,"oneOf":[{"required":["people"],"not":{"required":["personIDs"]}},{"required":["personIDs"],"not":{"required":["people"]}}]},"Input_leadsforge_find_phone":{"type":"object","properties":{"company":{"type":"string","maxLength":2048,"minLength":1},"companyDomain":{"type":"string","maxLength":2048,"minLength":1},"externalID":{"type":"string","maxLength":128},"firstName":{"type":"string","maxLength":2048,"minLength":1},"lastName":{"type":"string","maxLength":2048,"minLength":1},"linkedinURL":{"type":"string","maxLength":2048,"minLength":1,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$"},"personID":{"type":"string","maxLength":2048,"minLength":1}},"additionalProperties":false,"anyOf":[{"required":["linkedinURL"]},{"required":["firstName","lastName","company"]},{"required":["firstName","lastName","companyDomain"]},{"required":["personID"]}]},"Input_leadsforge_find_phones_batch":{"type":"object","properties":{"clientRequestID":{"type":"string","maxLength":128},"people":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"object","properties":{"company":{"type":"string","maxLength":2048,"minLength":1},"companyDomain":{"type":"string","maxLength":2048,"minLength":1},"externalID":{"type":"string","maxLength":128},"firstName":{"type":"string","maxLength":2048,"minLength":1},"lastName":{"type":"string","maxLength":2048,"minLength":1},"linkedinURL":{"type":"string","maxLength":2048,"minLength":1,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$"}},"additionalProperties":false,"anyOf":[{"required":["linkedinURL"]},{"required":["firstName","lastName","company"]},{"required":["firstName","lastName","companyDomain"]}]}},"personIDs":{"type":"array","maxItems":500,"minItems":1,"items":{"type":"string","maxLength":256,"minLength":1},"uniqueItems":true},"saveToList":{"type":"boolean","default":false},"webhookURL":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://[^\\s]+$"}},"additionalProperties":false,"oneOf":[{"required":["people"],"not":{"required":["personIDs"]}},{"required":["personIDs"],"not":{"required":["people"]}}]},"Input_leadsforge_lookalikes_filters_departments":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_lookalikes_filters_employee_ranges":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_lookalikes_filters_locations":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_lookalikes_filters_seniorities":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_preview_lookalike_companies":{"type":"object","required":["domains"],"properties":{"categories":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"domains":{"type":"array","maxItems":10,"minItems":1,"items":{"type":"string","maxLength":2048}},"employeeRanges":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"fundingStages":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"locations":{"type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","maxLength":2048},"type":{"type":"string","enum":["region","country"],"maxLength":2048}},"additionalProperties":false},"maxItems":500}},"additionalProperties":false},"Input_leadsforge_search_lookalike_companies":{"type":"object","required":["domains"],"properties":{"categories":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"domains":{"type":"array","maxItems":10,"minItems":1,"items":{"type":"string","maxLength":2048}},"employeeRanges":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"fundingStages":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"locations":{"type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","maxLength":2048},"type":{"type":"string","enum":["region","country"],"maxLength":2048}},"additionalProperties":false},"maxItems":500},"page":{"type":"integer","minimum":1,"maximum":100,"default":1},"pageSize":{"type":"integer","maximum":100,"minimum":1,"default":10}},"additionalProperties":false},"Input_leadsforge_search_people":{"type":"object","properties":{"companyBusinessModels":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyDomains":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyEmployeeNumberRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"companyFoundedYearRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"companyFundingRounds":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyIDs":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyIndustries":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyKeywords":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"matchAll":{"type":"boolean"}},"additionalProperties":false},"companyLocations":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyNames":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyNiches":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyRequired":{"type":"boolean"},"companyRevenueRanges":{"type":"array","items":{"type":"string","enum":["very_small","small_lower","small_upper","lower_mid_sized","mid_sized_lower","mid_sized_upper","large_lower","large_upper","enterprise_lower","enterprise_upper","global_giants_lower","global_giants_upper","super_enterprises"],"maxLength":2048},"maxItems":500},"companyTechnologies":{"type":"object","properties":{"all":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"any":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyTypes":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyYearsInBusinessRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"leadDepartments":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadIDs":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadJobTitles":{"type":"object","properties":{"exactMatch":{"type":"boolean"},"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadLanguages":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"primaryOnly":{"type":"boolean"}},"additionalProperties":false},"leadLocations":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadSeniorities":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadTenure":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"limit":{"type":"integer","maximum":2000,"minimum":1,"default":25},"maxContactsPerCompany":{"type":"integer","maximum":100,"minimum":0},"cursor":{"type":"string","description":"Cursor","maxLength":2048},"excludeEmails":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}},"excludeDomains":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}},"excludeLinkedInURLs":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}}},"additionalProperties":false},"Input_leadsforge_count_people":{"type":"object","properties":{"companyBusinessModels":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyDomains":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyEmployeeNumberRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"companyFoundedYearRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"companyFundingRounds":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyIDs":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyIndustries":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyKeywords":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"matchAll":{"type":"boolean"}},"additionalProperties":false},"companyLocations":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyNames":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyNiches":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyRequired":{"type":"boolean"},"companyRevenueRanges":{"type":"array","items":{"type":"string","enum":["very_small","small_lower","small_upper","lower_mid_sized","mid_sized_lower","mid_sized_upper","large_lower","large_upper","enterprise_lower","enterprise_upper","global_giants_lower","global_giants_upper","super_enterprises"],"maxLength":2048},"maxItems":500},"companyTechnologies":{"type":"object","properties":{"all":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"any":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyTypes":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"companyYearsInBusinessRange":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"leadDepartments":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadIDs":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadJobTitles":{"type":"object","properties":{"exactMatch":{"type":"boolean"},"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadLanguages":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"primaryOnly":{"type":"boolean"}},"additionalProperties":false},"leadLocations":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadSeniorities":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500},"include":{"type":"array","items":{"type":"string","maxLength":2048},"maxItems":500}},"additionalProperties":false},"leadTenure":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"additionalProperties":false},"maxContactsPerCompany":{"type":"integer","maximum":100,"minimum":0},"excludeEmails":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}},"excludeDomains":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}},"excludeLinkedInURLs":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1,"maxLength":2048}}},"additionalProperties":false},"Input_leadsforge_search_filters_company_types":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_search_filters_departments":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_search_filters_funding_types":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_search_filters_industries":{"type":"object","properties":{"search":{"type":"string","description":"Search query","maxLength":2048},"offset":{"type":"integer","description":"Offset","minimum":0,"maximum":1000000,"default":0},"limit":{"type":"integer","description":"Limit (1-100)","minimum":1,"maximum":100,"default":25}},"additionalProperties":false,"required":["limit"]},"Input_leadsforge_search_filters_revenue_ranges":{"type":"object","properties":{},"additionalProperties":false},"Input_leadsforge_search_filters_seniorities":{"type":"object","properties":{},"additionalProperties":false},"Input_icypeas_find_email":{"type":"object","properties":{"firstname":{"type":"string","maxLength":2048},"lastname":{"type":"string","maxLength":2048},"domainOrCompany":{"type":"string","maxLength":2048,"minLength":1},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["firstname","lastname","domainOrCompany"],"additionalProperties":false,"anyOf":[{"properties":{"firstname":{"minLength":1}}},{"properties":{"lastname":{"minLength":1}}}]},"Input_icypeas_find_email_sync":{"type":"object","properties":{"firstname":{"type":"string","maxLength":2048},"lastname":{"type":"string","maxLength":2048},"domainOrCompany":{"type":"string","maxLength":2048,"minLength":1},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["firstname","lastname","domainOrCompany"],"additionalProperties":false,"anyOf":[{"properties":{"firstname":{"minLength":1}}},{"properties":{"lastname":{"minLength":1}}}]},"Input_icypeas_find_emails_batch":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"minLength":1},"data":{"type":"array","items":{"type":"array","items":[{"type":"string","maxLength":2048},{"type":"string","maxLength":2048},{"type":"string","maxLength":2048,"minLength":1}],"minItems":3,"maxItems":3,"anyOf":[{"items":[{"minLength":1},{},{}]},{"items":[{},{"minLength":1},{}]}]},"minItems":1,"maxItems":5000},"custom":{"type":"object","properties":{"externalIds":{"type":"array","items":{"type":"string","maxLength":256},"minItems":1,"maxItems":5000},"webhookUrlItem":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"webhookUrlBulkDone":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"includeResultsInWebhook":{"type":"boolean"}},"required":[],"additionalProperties":false}},"required":["name","data"],"additionalProperties":false},"Input_icypeas_verify_email":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email","minLength":3},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["email"],"additionalProperties":false},"Input_icypeas_verify_email_sync":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email","minLength":3},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["email"],"additionalProperties":false},"Input_icypeas_verify_emails_batch":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"minLength":1},"data":{"type":"array","items":{"type":"array","items":{"type":"string","maxLength":320,"format":"email","minLength":3},"minItems":1,"maxItems":1},"minItems":1,"maxItems":5000},"custom":{"type":"object","properties":{"externalIds":{"type":"array","items":{"type":"string","maxLength":256},"minItems":1,"maxItems":5000},"webhookUrlItem":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"webhookUrlBulkDone":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"includeResultsInWebhook":{"type":"boolean"}},"required":[],"additionalProperties":false}},"required":["name","data"],"additionalProperties":false},"Input_icypeas_scan_domain":{"type":"object","properties":{"domainOrCompany":{"type":"string","maxLength":2048,"minLength":1},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["domainOrCompany"],"additionalProperties":false},"Input_icypeas_scan_domain_sync":{"type":"object","properties":{"domainOrCompany":{"type":"string","maxLength":2048,"minLength":1},"custom":{"type":"object","properties":{"externalId":{"type":"string","maxLength":256},"webhookUrl":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"}},"required":[],"additionalProperties":false}},"required":["domainOrCompany"],"additionalProperties":false},"Input_icypeas_scan_domains_batch":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"minLength":1},"data":{"type":"array","items":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":1,"maxItems":1},"minItems":1,"maxItems":5000},"custom":{"type":"object","properties":{"externalIds":{"type":"array","items":{"type":"string","maxLength":256},"minItems":1,"maxItems":5000},"webhookUrlItem":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"webhookUrlBulkDone":{"type":"string","maxLength":2048,"format":"uri","pattern":"^https://"},"includeResultsInWebhook":{"type":"boolean"}},"required":[],"additionalProperties":false}},"required":["name","data"],"additionalProperties":false},"Input_icypeas_scrape_profile":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$","minLength":1}},"required":["url"],"additionalProperties":false},"Input_icypeas_scrape_profiles_batch":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","maxLength":2048,"pattern":"^https://(?:www\\.)?linkedin\\.com/in/[^\\s]+$","minLength":1},"minItems":1,"maxItems":50}},"required":["data"],"additionalProperties":false},"Input_icypeas_find_profile_url":{"type":"object","properties":{"firstname":{"type":"string","maxLength":2048,"minLength":1},"lastname":{"type":"string","maxLength":2048,"minLength":1},"companyOrDomain":{"type":"string","maxLength":2048,"minLength":1},"jobTitle":{"type":"string","maxLength":2048,"minLength":1}},"required":["firstname","lastname"],"additionalProperties":false,"anyOf":[{"required":["companyOrDomain"]},{"required":["jobTitle"]}]},"Input_icypeas_find_profile_urls_batch":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"firstname":{"type":"string","maxLength":2048,"minLength":1},"lastname":{"type":"string","maxLength":2048,"minLength":1},"companyOrDomain":{"type":"string","maxLength":2048,"minLength":1},"jobTitle":{"type":"string","maxLength":2048,"minLength":1}},"required":["firstname","lastname"],"additionalProperties":false,"anyOf":[{"required":["companyOrDomain"]},{"required":["jobTitle"]}]},"minItems":1,"maxItems":50}},"required":["data"],"additionalProperties":false},"Input_icypeas_scrape_company":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"pattern":"^https://(?:www\\.)?linkedin\\.com/company/[^\\s]+$","minLength":1}},"required":["url"],"additionalProperties":false},"Input_icypeas_scrape_companies_batch":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","maxLength":2048,"pattern":"^https://(?:www\\.)?linkedin\\.com/company/[^\\s]+$","minLength":1},"minItems":1,"maxItems":50}},"required":["data"],"additionalProperties":false},"Input_icypeas_find_company_url":{"type":"object","properties":{"companyOrDomain":{"type":"string","maxLength":2048,"minLength":1}},"required":["companyOrDomain"],"additionalProperties":false},"Input_icypeas_find_company_urls_batch":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"companyOrDomain":{"type":"string","maxLength":2048,"minLength":1}},"required":["companyOrDomain"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["data"],"additionalProperties":false},"Input_icypeas_count_people":{"type":"object","properties":{"query":{"type":"object","properties":{"firstname":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"lastname":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentJobTitle":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastJobTitle":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"school":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"languages":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"skills":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"profileLocation":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"workLocation":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"totalYearsOfExperience":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"timeInCurrentCompany":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompanyName":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyWebsite":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyUrn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompany.revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompany.headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false},"pastCompanyName":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyWebsite":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyUrn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"pastCompany.revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"pastCompany.headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false}},"required":[],"additionalProperties":false}},"required":["query"],"additionalProperties":false},"Input_icypeas_find_people":{"type":"object","properties":{"query":{"type":"object","properties":{"firstname":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"lastname":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentJobTitle":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastJobTitle":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"school":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"languages":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"skills":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"profileLocation":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"workLocation":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"totalYearsOfExperience":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"timeInCurrentCompany":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompanyName":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyWebsite":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompanyUrn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"currentCompany.headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompany.revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"currentCompany.headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false},"pastCompanyName":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyWebsite":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompanyUrn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"pastCompany.headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"pastCompany.revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"pastCompany.headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false}},"required":[],"additionalProperties":false},"pagination":{"type":"object","properties":{"size":{"type":"integer","minimum":1,"maximum":200,"default":10},"token":{"type":"string","maxLength":100000}},"required":[],"additionalProperties":false,"default":{"size":10}}},"required":["query"],"additionalProperties":false},"Input_icypeas_count_companies":{"type":"object","properties":{"query":{"type":"object","properties":{"name":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"lid":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"urn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"companyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"domain":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false}},"required":[],"additionalProperties":false}},"required":["query"],"additionalProperties":false},"Input_icypeas_find_companies":{"type":"object","properties":{"query":{"type":"object","properties":{"name":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"lid":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"urn":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"companyId":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"type":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"industry":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"location":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"keyword":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"domain":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200},"exclude":{"type":"array","items":{"type":"string","maxLength":2048,"minLength":1},"minItems":0,"maxItems":200}},"required":[],"additionalProperties":false},"headcount":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"revenue":{"type":"object","properties":{">":{"type":"integer","minimum":0},"<":{"type":"integer","minimum":0},">=":{"type":"integer","minimum":0},"<=":{"type":"integer","minimum":0}},"required":[],"additionalProperties":false,"minProperties":1},"headcountGrowth":{"type":"object","properties":{"timespan":{"type":"string","enum":["6months","12months","24months"]},"min":{"type":"number","minimum":-100,"maximum":10000},"max":{"type":"number","minimum":-100,"maximum":10000}},"required":["timespan"],"additionalProperties":false}},"required":[],"additionalProperties":false},"pagination":{"type":"object","properties":{"size":{"type":"integer","minimum":1,"maximum":200,"default":10},"token":{"type":"string","maxLength":100000}},"required":[],"additionalProperties":false,"default":{"size":10}}},"required":["query"],"additionalProperties":false},"Input_icypeas_reverse_email_lookup":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email","minLength":3}},"required":["email"],"additionalProperties":false},"Input_icypeas_reverse_email_lookups_batch":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","maxLength":320,"format":"email","minLength":3},"minItems":2,"maxItems":50}},"required":["data"],"additionalProperties":false},"Input_icypeas_get_search_result":{"type":"object","properties":{"id":{"type":"string","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["id"],"additionalProperties":false},"Input_icypeas_get_bulk_results":{"type":"object","properties":{"file":{"type":"string","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"next":{"type":"boolean"},"sorts":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048},{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048}]},"minItems":0,"maxItems":4}]},"minItems":0,"maxItems":4}},"required":["file"],"additionalProperties":false},"Input_icypeas_get_bulk_status":{"type":"object","properties":{"file":{"type":"string","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["file"],"additionalProperties":false},"Input_icypeas_list_single_search_results":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"next":{"type":"boolean"},"sorts":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048},{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048}]},"minItems":0,"maxItems":4}]},"minItems":0,"maxItems":4},"type":{"type":"string","enum":["email-search","email-verification","domain-search"]}},"required":[],"additionalProperties":false},"Input_icypeas_list_bulk_search_results":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"next":{"type":"boolean"},"sorts":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048},{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048}]},"minItems":0,"maxItems":4}]},"minItems":0,"maxItems":4}},"required":[],"additionalProperties":false},"Input_icypeas_list_bulk_files":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":50,"default":10},"next":{"type":"boolean"},"sorts":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048},{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"string","maxLength":2048}]},"minItems":0,"maxItems":4}]},"minItems":0,"maxItems":4},"status":{"type":"string","enum":["in_progress","done"]}},"required":[],"additionalProperties":false},"Input_icypeas_subscription_information":{"type":"object","properties":{},"required":[],"additionalProperties":false}}},"x-toolrouter-tools":[{"id":"open-meteo/geocode","name":"Geocode a place name","status":"active","pricing":{"model":"per_call","amountUsd":0.0002},"input":"#/components/schemas/Input_open_meteo_geocode"},{"id":"open-meteo/forecast","name":"Weather forecast","status":"active","pricing":{"model":"per_call","amountUsd":0.0002},"input":"#/components/schemas/Input_open_meteo_forecast"},{"id":"frankfurter/latest-rates","name":"Currency exchange rates","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_frankfurter_latest_rates"},{"id":"defillama/protocol-tvl","name":"DeFi protocol TVL","status":"active","pricing":{"model":"per_call","amountUsd":0.0002},"input":"#/components/schemas/Input_defillama_protocol_tvl"},{"id":"wikipedia/page-summary","name":"Wikipedia page summary","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_wikipedia_page_summary"},{"id":"wikipedia/search","name":"Wikipedia search","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_wikipedia_search"},{"id":"hackernews/search","name":"Hacker News search","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_hackernews_search"},{"id":"hackernews/item","name":"Hacker News item","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_hackernews_item"},{"id":"sec-edgar/company-filings","name":"SEC EDGAR company filings","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_sec_edgar_company_filings"},{"id":"npm/package-latest","name":"npm package (latest)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_npm_package_latest"},{"id":"pypi/package","name":"PyPI package","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_pypi_package"},{"id":"gleif/lei-record","name":"LEI record lookup","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_gleif_lei_record"},{"id":"open-meteo/air-quality","name":"Air quality (current)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_open_meteo_air_quality"},{"id":"open-meteo/historical-weather","name":"Historical weather (archive)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_open_meteo_historical_weather"},{"id":"nominatim/geocode","name":"Geocode an address (OpenStreetMap)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_nominatim_geocode"},{"id":"nominatim/reverse-geocode","name":"Reverse geocode (OpenStreetMap)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_nominatim_reverse_geocode"},{"id":"openalex/search-works","name":"Scholarly works search (OpenAlex)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_openalex_search_works"},{"id":"crossref/search-works","name":"DOI metadata search (Crossref)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_crossref_search_works"},{"id":"github/repo","name":"GitHub repository","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_github_repo"},{"id":"github/search-repositories","name":"GitHub repository search","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_github_search_repositories"},{"id":"usgs/earthquakes","name":"Recent earthquakes (USGS)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_usgs_earthquakes"},{"id":"world-bank/indicator","name":"World Bank indicator","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_world_bank_indicator"},{"id":"recherche-entreprises/search","name":"French company search (Sirene)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_recherche_entreprises_search"},{"id":"api-adresse/geocode","name":"Geocode a French address (BAN)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_api_adresse_geocode"},{"id":"api-adresse/reverse-geocode","name":"Reverse geocode in France (BAN)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_api_adresse_reverse_geocode"},{"id":"open-library/search","name":"Book search (Open Library)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_open_library_search"},{"id":"duckduckgo/instant-answer","name":"DuckDuckGo instant answer","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_duckduckgo_instant_answer"},{"id":"wayback/availability","name":"Wayback Machine snapshot lookup","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_wayback_availability"},{"id":"coingecko/simple-price","name":"Crypto spot price (CoinGecko)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_coingecko_simple_price"},{"id":"open-food-facts/product","name":"Food product by barcode (Open Food Facts)","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_open_food_facts_product"},{"id":"serper/search","name":"Google web search","status":"listed","pricing":{"model":"per_unit","amountUsd":0.001,"unitsPath":"credits","maxUnits":10,"unitsFallback":1},"input":"#/components/schemas/Input_serper_search"},{"id":"serper/news","name":"Google News search","status":"listed","pricing":{"model":"per_unit","amountUsd":0.001,"unitsPath":"credits","maxUnits":10,"unitsFallback":1},"input":"#/components/schemas/Input_serper_news"},{"id":"tavily/search","name":"Tavily agent search","status":"listed","pricing":{"model":"per_call","amountUsd":0.008,"multipliers":[{"when":{"field":"search_depth","equals":"advanced"},"factor":2}]},"input":"#/components/schemas/Input_tavily_search"},{"id":"firecrawl/scrape","name":"Scrape a web page to markdown","status":"listed","pricing":{"model":"per_call","amountUsd":0.005},"input":"#/components/schemas/Input_firecrawl_scrape"},{"id":"browserbase/create-session","name":"Cloud browser session","status":"listed","pricing":{"model":"per_minute","amountUsd":0.002,"maxMinutes":15,"maxMinutesField":"timeout","fieldUnit":"seconds"},"input":"#/components/schemas/Input_browserbase_create_session"},{"id":"browserbase/get-session","name":"Browser session status","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_browserbase_get_session"},{"id":"browserbase/release-session","name":"End a browser session","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_browserbase_release_session"},{"id":"browser-use/run-task","name":"Autonomous browser task","status":"listed","pricing":{"model":"reported","costPath":"totalCostUsd","maxUsdField":"max_cost_usd","maxUsdDefault":0.25,"maxUsdCap":5},"input":"#/components/schemas/Input_browser_use_run_task"},{"id":"browser-use/get-run","name":"Browser task result","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_browser_use_get_run"},{"id":"browser-use/cancel-run","name":"Cancel a browser task","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_browser_use_cancel_run"},{"id":"tavily-mcp/extract","name":"Extract page content (via Tavily MCP)","status":"listed","pricing":{"model":"per_unit","amountUsd":0.008,"unitsPath":"results","unitsPer":5,"maxUnits":1,"unitsFallback":1,"multipliers":[{"when":{"field":"extract_depth","equals":"advanced"},"factor":2}]},"input":"#/components/schemas/Input_tavily_mcp_extract"},{"id":"fal/nano-banana-2","name":"Nano Banana 2 (Google), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.08,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"enable_web_search","truthy":true},"addUsd":0.015},{"when":{"field":"thinking_level","equals":"high"},"addUsd":0.002}]},"input":"#/components/schemas/Input_fal_nano_banana_2"},{"id":"fal/nano-banana-2-edit","name":"Nano Banana 2 (Google), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.08,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"enable_web_search","truthy":true},"addUsd":0.015},{"when":{"field":"thinking_level","equals":"high"},"addUsd":0.002}]},"input":"#/components/schemas/Input_fal_nano_banana_2_edit"},{"id":"fal/nano-banana-pro","name":"Nano Banana Pro (Gemini 3 Pro Image), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.15,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"enable_web_search","truthy":true},"addUsd":0.015}]},"input":"#/components/schemas/Input_fal_nano_banana_pro"},{"id":"fal/nano-banana-pro-edit","name":"Nano Banana Pro (Gemini 3 Pro Image), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.15,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"enable_web_search","truthy":true},"addUsd":0.015}]},"input":"#/components/schemas/Input_fal_nano_banana_pro_edit"},{"id":"fal/gpt-image-2","name":"GPT Image 2 (OpenAI), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.145,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.037},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.145},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.006},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.053},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.211},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.042},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.165},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.04},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.158},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.007},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.056},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.222},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.012},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.101},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.401},{"when":{"field":"prompt","minLength":0},"addUsd":0.002}]},"input":"#/components/schemas/Input_fal_gpt_image_2"},{"id":"fal/gpt-image-2-edit","name":"GPT Image 2 (OpenAI), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.145,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.037},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","1024x768","768x1024"]}],"setUsd":0.145},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.006},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.053},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["square_hd","1024x1024"]}],"setUsd":0.211},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.042},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["1024x1536","1536x1024"]}],"setUsd":0.165},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.005},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.04},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["1920x1080","1080x1920"]}],"setUsd":0.158},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.007},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.056},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["2560x1440","1440x2560"]}],"setUsd":0.222},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.012},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.101},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["3840x2160","2160x3840"]}],"setUsd":0.401},{"when":{"field":"prompt","minLength":0},"addUsd":0.014}]},"input":"#/components/schemas/Input_fal_gpt_image_2_edit"},{"id":"fal/gpt-image-1-5","name":"GPT Image 1.5 (OpenAI), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.133,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"quality","equals":"low"},"setUsd":0.009},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","in":["1536x1024","1024x1536"]}],"setUsd":0.013},{"when":{"field":"quality","equals":"medium"},"setUsd":0.034},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","in":["1536x1024","1024x1536"]}],"setUsd":0.051},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","in":["1536x1024","1024x1536"]}],"setUsd":0.2},{"when":{"field":"prompt","minLength":0},"addUsd":0.002}]},"input":"#/components/schemas/Input_fal_gpt_image_1_5"},{"id":"fal/gpt-image-1-5-edit","name":"GPT Image 1.5 (OpenAI), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.2,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"quality","equals":"low"},"setUsd":0.013},{"all":[{"field":"quality","equals":"low"},{"field":"image_size","equals":"1024x1024"}],"setUsd":0.009},{"when":{"field":"quality","equals":"medium"},"setUsd":0.051},{"all":[{"field":"quality","equals":"medium"},{"field":"image_size","equals":"1024x1024"}],"setUsd":0.034},{"all":[{"field":"quality","equals":"high"},{"field":"image_size","equals":"1024x1024"}],"setUsd":0.133},{"when":{"field":"prompt","minLength":0},"addUsd":0.012}]},"input":"#/components/schemas/Input_fal_gpt_image_1_5_edit"},{"id":"fal/seedream-5-pro","name":"Seedream 5.0 Pro (ByteDance), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.135,"unitsField":"num_images","unitsDefault":1,"maxUnits":6,"multipliers":[{"when":{"field":"image_size","in":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto_1K"]},"setUsd":0.0675}]},"input":"#/components/schemas/Input_fal_seedream_5_pro"},{"id":"fal/seedream-5-pro-edit","name":"Seedream 5.0 Pro (ByteDance), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.135,"unitsField":"num_images","unitsDefault":1,"maxUnits":6,"multipliers":[{"when":{"field":"image_size","in":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto_1K"]},"setUsd":0.0675},{"when":{"field":"image_urls","minLength":2},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":3},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":4},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":5},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":6},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":7},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":8},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":9},"addUsd":0.0045},{"when":{"field":"image_urls","minLength":10},"addUsd":0.0045}]},"input":"#/components/schemas/Input_fal_seedream_5_pro_edit"},{"id":"fal/flux-2-pro","name":"FLUX.2 [pro] (Black Forest Labs), text to image","status":"listed","pricing":{"model":"per_call","amountUsd":0.03,"multipliers":[{"when":{"field":"image_size","in":["1280x720","720x1280"]},"setUsd":0.03},{"when":{"field":"image_size","in":["1536x1024","1024x1536"]},"setUsd":0.045},{"when":{"field":"image_size","in":["1536x1536","1920x1440","1440x1920"]},"setUsd":0.06},{"when":{"field":"image_size","in":["2560x1440","1440x2560"]},"setUsd":0.075}]},"input":"#/components/schemas/Input_fal_flux_2_pro"},{"id":"fal/flux-2-max","name":"FLUX.2 [max] (Black Forest Labs), text to image","status":"listed","pricing":{"model":"per_call","amountUsd":0.07,"multipliers":[{"when":{"field":"image_size","in":["1280x720","720x1280"]},"setUsd":0.07},{"when":{"field":"image_size","in":["1536x1024","1024x1536"]},"setUsd":0.1},{"when":{"field":"image_size","in":["1536x1536","1920x1440","1440x1920"]},"setUsd":0.13},{"when":{"field":"image_size","in":["2560x1440","1440x2560"]},"setUsd":0.16}]},"input":"#/components/schemas/Input_fal_flux_2_max"},{"id":"fal/flux-2-flash","name":"FLUX.2 [flash] (Black Forest Labs), fast text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0053,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"image_size","equals":"1536x1024"},"setUsd":0.007864},{"when":{"field":"image_size","equals":"1024x1536"},"setUsd":0.007864},{"when":{"field":"image_size","equals":"1536x1536"},"setUsd":0.011796},{"when":{"field":"image_size","equals":"1920x1440"},"setUsd":0.013824},{"when":{"field":"image_size","equals":"1440x1920"},"setUsd":0.013824},{"when":{"field":"image_size","equals":"2048x1152"},"setUsd":0.011796},{"when":{"field":"image_size","equals":"1152x2048"},"setUsd":0.011796},{"when":{"field":"image_size","equals":"2048x2048"},"setUsd":0.020972}]},"input":"#/components/schemas/Input_fal_flux_2_flash"},{"id":"fal/flux-2-pro-edit","name":"FLUX.2 [pro] (Black Forest Labs), image edit","status":"listed","pricing":{"model":"per_call","amountUsd":0.045,"multipliers":[{"when":{"field":"image_urls","minLength":2},"addUsd":0.015},{"when":{"field":"image_urls","minLength":3},"addUsd":0.015},{"when":{"field":"image_urls","minLength":4},"addUsd":0.015},{"when":{"field":"image_urls","minLength":5},"addUsd":0.015},{"when":{"field":"image_urls","minLength":6},"addUsd":0.015}]},"input":"#/components/schemas/Input_fal_flux_2_pro_edit"},{"id":"fal/flux-2-max-edit","name":"FLUX.2 [max] (Black Forest Labs), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.03,"unitsHeader":"x-fal-billable-units","maxUnits":40,"maxUnitsField":"max_megapixels","fractional":false,"multipliers":[{"addUsd":0.04}]},"input":"#/components/schemas/Input_fal_flux_2_max_edit"},{"id":"fal/flux-2-pro-outpaint","name":"FLUX.2 [pro] (Black Forest Labs), outpaint","status":"listed","pricing":{"model":"per_unit","amountUsd":0.015,"unitsHeader":"x-fal-billable-units","maxUnits":40,"maxUnitsField":"max_megapixels","fractional":false,"multipliers":[{"addUsd":0.015}]},"input":"#/components/schemas/Input_fal_flux_2_pro_outpaint"},{"id":"fal/ideogram-v3","name":"Ideogram 3, text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.06,"unitsField":"num_images","unitsDefault":1,"maxUnits":8,"multipliers":[{"when":{"field":"rendering_speed","equals":"TURBO"},"setUsd":0.03},{"when":{"field":"rendering_speed","equals":"QUALITY"},"setUsd":0.09}]},"input":"#/components/schemas/Input_fal_ideogram_v3"},{"id":"fal/ideogram-v3-replace-background","name":"Ideogram 3, replace background","status":"listed","pricing":{"model":"per_unit","amountUsd":0.06,"unitsField":"num_images","unitsDefault":1,"maxUnits":8,"multipliers":[{"when":{"field":"rendering_speed","equals":"TURBO"},"setUsd":0.03},{"when":{"field":"rendering_speed","equals":"QUALITY"},"setUsd":0.09}]},"input":"#/components/schemas/Input_fal_ideogram_v3_replace_background"},{"id":"fal/recraft-v4-1-pro","name":"Recraft V4.1 Pro, text to image","status":"listed","pricing":{"model":"per_call","amountUsd":0.21},"input":"#/components/schemas/Input_fal_recraft_v4_1_pro"},{"id":"fal/recraft-v4-1-pro-vector","name":"Recraft V4.1 Pro, text to vector (SVG)","status":"listed","pricing":{"model":"per_call","amountUsd":0.3},"input":"#/components/schemas/Input_fal_recraft_v4_1_pro_vector"},{"id":"fal/recraft-vectorize","name":"Recraft, vectorize an image (SVG)","status":"listed","pricing":{"model":"per_call","amountUsd":0.01},"input":"#/components/schemas/Input_fal_recraft_vectorize"},{"id":"fal/reve-2-1","name":"Reve 2.1, text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.25,"unitsField":"num_images","unitsDefault":1,"maxUnits":4},"input":"#/components/schemas/Input_fal_reve_2_1"},{"id":"fal/reve-2-1-edit","name":"Reve 2.1, image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.25,"unitsField":"num_images","unitsDefault":1,"maxUnits":4},"input":"#/components/schemas/Input_fal_reve_2_1_edit"},{"id":"fal/qwen-image-3","name":"Qwen Image 3 (Alibaba), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.04,"unitsField":"num_images","unitsDefault":1,"maxUnits":6},"input":"#/components/schemas/Input_fal_qwen_image_3"},{"id":"fal/qwen-image-3-edit","name":"Qwen Image 3 (Alibaba), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.04,"unitsField":"num_images","unitsDefault":1,"maxUnits":6},"input":"#/components/schemas/Input_fal_qwen_image_3_edit"},{"id":"fal/grok-imagine-image-2","name":"Grok Imagine Image 2.0 (xAI), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.06,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"quality","equals":"low"},"setUsd":0.04},{"all":[{"field":"quality","equals":"low"},{"field":"resolution","equals":"2k"}],"setUsd":0.06},{"all":[{"field":"quality","equals":"medium"},{"field":"resolution","equals":"2k"}],"setUsd":0.08}]},"input":"#/components/schemas/Input_fal_grok_imagine_image_2"},{"id":"fal/grok-imagine-image-2-edit","name":"Grok Imagine Image 2.0 (xAI), image edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.06,"unitsField":"num_images","unitsDefault":1,"maxUnits":4,"multipliers":[{"when":{"field":"quality","equals":"low"},"setUsd":0.04},{"all":[{"field":"quality","equals":"low"},{"field":"resolution","equals":"2k"}],"setUsd":0.06},{"all":[{"field":"quality","equals":"medium"},{"field":"resolution","equals":"2k"}],"setUsd":0.08},{"when":{"field":"image_urls","minLength":1},"addUsd":0.01},{"when":{"field":"image_urls","minLength":2},"addUsd":0.01},{"when":{"field":"image_urls","minLength":3},"addUsd":0.01},{"when":{"field":"image_urls","minLength":4},"addUsd":0.01},{"when":{"field":"image_urls","minLength":5},"addUsd":0.01},{"when":{"field":"image_urls","minLength":6},"addUsd":0.01},{"when":{"field":"image_urls","minLength":7},"addUsd":0.01},{"when":{"field":"image_urls","minLength":8},"addUsd":0.01}]},"input":"#/components/schemas/Input_fal_grok_imagine_image_2_edit"},{"id":"fal/luma-uni-1-max","name":"Luma Uni-1 Max, text to image","status":"listed","pricing":{"model":"per_call","amountUsd":0.102,"multipliers":[{"when":{"field":"reference_image_urls","minLength":1},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":2},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":3},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":4},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":5},"addUsd":0.003}]},"input":"#/components/schemas/Input_fal_luma_uni_1_max"},{"id":"fal/luma-uni-1-max-edit","name":"Luma Uni-1 Max, image edit","status":"listed","pricing":{"model":"per_call","amountUsd":0.105,"multipliers":[{"when":{"field":"reference_image_urls","minLength":1},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":2},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":3},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":4},"addUsd":0.003},{"when":{"field":"reference_image_urls","minLength":5},"addUsd":0.003}]},"input":"#/components/schemas/Input_fal_luma_uni_1_max_edit"},{"id":"fal/hunyuan-image-3","name":"HunyuanImage 3 Instruct (Tencent), text to image","status":"listed","pricing":{"model":"per_unit","amountUsd":0.095,"unitsField":"num_images","unitsDefault":1,"maxUnits":4},"input":"#/components/schemas/Input_fal_hunyuan_image_3"},{"id":"fal/birefnet-v2","name":"BiRefNet v2, background removal","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_fal_birefnet_v2"},{"id":"fal/bria-background-remove","name":"Bria RMBG 2.0, background removal","status":"listed","pricing":{"model":"per_call","amountUsd":0.018},"input":"#/components/schemas/Input_fal_bria_background_remove"},{"id":"fal/topaz-upscale-precision","name":"Topaz Precision, image upscale","status":"listed","pricing":{"model":"per_unit","amountUsd":0.08,"unitsPath":"image","unitsMeasure":"megapixels","unitsProbe":"image","unitsPer":24,"fractional":false,"maxUnits":10,"maxUnitsField":"max_megapixels"},"input":"#/components/schemas/Input_fal_topaz_upscale_precision"},{"id":"fal/clarity-upscaler","name":"Clarity Upscaler, image upscale","status":"listed","pricing":{"model":"per_unit","amountUsd":0.03,"unitsPath":"image","unitsMeasure":"megapixels","maxUnits":32},"input":"#/components/schemas/Input_fal_clarity_upscaler"},{"id":"fal/seedance-2-5-text-to-video","name":"Seedance 2.5 (ByteDance), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.473,"unitsField":"duration","unitsDefault":5,"maxUnits":30,"multipliers":[{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.2195},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.1645},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.1234},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.0926},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.0695},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.4623},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.3467},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.2601},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.1951},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.1463},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":1.4927},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":1.1373},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.853},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.6397},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.4798},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.3602},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":1.4927}]},"input":"#/components/schemas/Input_fal_seedance_2_5_text_to_video"},{"id":"fal/seedance-2-5-image-to-video","name":"Seedance 2.5 (ByteDance), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.473,"unitsField":"duration","unitsDefault":5,"maxUnits":30,"multipliers":[{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.2195},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.1645},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.1234},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.0926},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.0695},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.4623},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.3467},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.2601},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.1951},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.1463},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":1.4927},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":1.1373},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.853},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.6397},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.4798},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.3602},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":1.4927}]},"input":"#/components/schemas/Input_fal_seedance_2_5_image_to_video"},{"id":"fal/seedance-2-5-reference-to-video","name":"Seedance 2.5 (ByteDance), reference images and audio to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.473,"unitsField":"duration","unitsDefault":5,"maxUnits":30,"multipliers":[{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.2195},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.1645},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.1234},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.0926},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.0695},{"all":[{"field":"resolution","equals":"480p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.2879},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":0.4623},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.3467},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.2601},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.1951},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.1463},{"all":[{"field":"resolution","equals":"720p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":0.6067},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"21:9"}],"setUsd":1.4927},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"16:9"}],"setUsd":1.1373},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"4:3"}],"setUsd":0.853},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"1:1"}],"setUsd":0.6397},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"3:4"}],"setUsd":0.4798},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"9:16"}],"setUsd":0.3602},{"all":[{"field":"resolution","equals":"1080p"},{"field":"aspect_ratio","equals":"auto"}],"setUsd":1.4927}],"unitsHeader":"x-fal-billable-units","fractional":true,"unitsHeaderUsd":0.0214,"unitsHeaderRules":[{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.0234}]},"input":"#/components/schemas/Input_fal_seedance_2_5_reference_to_video"},{"id":"fal/kling-o3-pro-text-to-video","name":"Kling O3 Pro, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.112,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"generate_audio","truthy":true},"setUsd":0.14}]},"input":"#/components/schemas/Input_fal_kling_o3_pro_text_to_video"},{"id":"fal/kling-o3-pro-image-to-video","name":"Kling O3 Pro, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.112,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"generate_audio","truthy":true},"setUsd":0.14}]},"input":"#/components/schemas/Input_fal_kling_o3_pro_image_to_video"},{"id":"fal/kling-o3-4k-text-to-video","name":"Kling O3 4K, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.42,"unitsField":"duration","unitsDefault":5,"maxUnits":15},"input":"#/components/schemas/Input_fal_kling_o3_4k_text_to_video"},{"id":"fal/kling-o3-4k-image-to-video","name":"Kling O3 4K, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.42,"unitsField":"duration","unitsDefault":5,"maxUnits":15},"input":"#/components/schemas/Input_fal_kling_o3_4k_image_to_video"},{"id":"fal/kling-v3-pro-text-to-video","name":"Kling 3.0 Pro, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.112,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"generate_audio","truthy":true},"setUsd":0.196}]},"input":"#/components/schemas/Input_fal_kling_v3_pro_text_to_video"},{"id":"fal/kling-v3-pro-image-to-video","name":"Kling 3.0 Pro, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.112,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"generate_audio","truthy":true},"setUsd":0.196}]},"input":"#/components/schemas/Input_fal_kling_v3_pro_image_to_video"},{"id":"fal/veo-3-1-text-to-video","name":"Veo 3.1 (Google), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.4,"unitsField":"duration","unitsDefault":8,"maxUnits":8,"multipliers":[{"when":{"field":"generate_audio","equals":false},"setUsd":0.2},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","equals":false}],"setUsd":0.4},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","truthy":true}],"setUsd":0.6}]},"input":"#/components/schemas/Input_fal_veo_3_1_text_to_video"},{"id":"fal/veo-3-1-fast-text-to-video","name":"Veo 3.1 Fast (Google), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.15,"unitsField":"duration","unitsDefault":8,"maxUnits":8,"multipliers":[{"when":{"field":"generate_audio","equals":false},"setUsd":0.1},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","equals":false}],"setUsd":0.3},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","truthy":true}],"setUsd":0.35}]},"input":"#/components/schemas/Input_fal_veo_3_1_fast_text_to_video"},{"id":"fal/veo-3-1-image-to-video","name":"Veo 3.1 (Google), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.4,"unitsField":"duration","unitsDefault":8,"maxUnits":8,"multipliers":[{"when":{"field":"generate_audio","equals":false},"setUsd":0.2},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","equals":false}],"setUsd":0.4},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","truthy":true}],"setUsd":0.6}]},"input":"#/components/schemas/Input_fal_veo_3_1_image_to_video"},{"id":"fal/veo-3-1-fast-image-to-video","name":"Veo 3.1 Fast (Google), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.15,"unitsField":"duration","unitsDefault":8,"maxUnits":8,"multipliers":[{"when":{"field":"generate_audio","equals":false},"setUsd":0.1},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","equals":false}],"setUsd":0.3},{"all":[{"field":"resolution","equals":"4k"},{"field":"generate_audio","truthy":true}],"setUsd":0.35}]},"input":"#/components/schemas/Input_fal_veo_3_1_fast_image_to_video"},{"id":"fal/gemini-omni-flash-text-to-video","name":"Gemini Omni Flash 1.1 (Google), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"duration","unitsDefault":8,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"360p"},"setUsd":0.03},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.15},{"when":{"field":"resolution","equals":"4k"},"setUsd":0.3}]},"input":"#/components/schemas/Input_fal_gemini_omni_flash_text_to_video"},{"id":"fal/gemini-omni-flash-image-to-video","name":"Gemini Omni Flash 1.1 (Google), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"duration","unitsDefault":8,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"360p"},"setUsd":0.03},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.15},{"when":{"field":"resolution","equals":"4k"},"setUsd":0.3}]},"input":"#/components/schemas/Input_fal_gemini_omni_flash_image_to_video"},{"id":"fal/gemini-omni-flash-video-edit","name":"Gemini Omni Flash 1.1 (Google), video edit","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsHeader":"x-fal-billable-units","maxUnits":120,"maxUnitsField":"max_seconds","fractional":true,"multipliers":[{"when":{"field":"resolution","equals":"360p"},"setUsd":0.03},{"when":{"field":"resolution","equals":"720p"},"setUsd":0.1},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.15},{"when":{"field":"resolution","equals":"4k"},"setUsd":0.3}]},"input":"#/components/schemas/Input_fal_gemini_omni_flash_video_edit"},{"id":"fal/minimax-h3-max-text-to-video","name":"MiniMax H3 Max, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.08,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480P"},"setUsd":0.05}]},"input":"#/components/schemas/Input_fal_minimax_h3_max_text_to_video"},{"id":"fal/minimax-h3-max-image-to-video","name":"MiniMax H3 Max, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.08,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480P"},"setUsd":0.05}]},"input":"#/components/schemas/Input_fal_minimax_h3_max_image_to_video"},{"id":"fal/minimax-h3-max-turbo-text-to-video","name":"MiniMax H3 Max Turbo, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.04,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480P"},"setUsd":0.025}]},"input":"#/components/schemas/Input_fal_minimax_h3_max_turbo_text_to_video"},{"id":"fal/minimax-h3-max-turbo-image-to-video","name":"MiniMax H3 Max Turbo, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.04,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480P"},"setUsd":0.025}]},"input":"#/components/schemas/Input_fal_minimax_h3_max_turbo_image_to_video"},{"id":"fal/wan-2-6-image-to-video","name":"Wan 2.6 (Alibaba), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.15,"unitsField":"duration","unitsDefault":5,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"720p"},"setUsd":0.1}]},"input":"#/components/schemas/Input_fal_wan_2_6_image_to_video"},{"id":"fal/ltx-2-5-pro-text-to-video","name":"LTX 2.5 Pro (Lightricks), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.17,"unitsField":"duration","unitsDefault":6,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"720p"},"setUsd":0.12}]},"input":"#/components/schemas/Input_fal_ltx_2_5_pro_text_to_video"},{"id":"fal/ltx-2-5-pro-image-to-video","name":"LTX 2.5 Pro (Lightricks), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.17,"unitsField":"duration","unitsDefault":6,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"720p"},"setUsd":0.12}]},"input":"#/components/schemas/Input_fal_ltx_2_5_pro_image_to_video"},{"id":"fal/luma-ray-3-2-text-to-video","name":"Luma Ray 3.2, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"duration","unitsDefault":5,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"720p"},"setUsd":0.2},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.4}]},"input":"#/components/schemas/Input_fal_luma_ray_3_2_text_to_video"},{"id":"fal/luma-ray-3-2-image-to-video","name":"Luma Ray 3.2, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.03,"unitsField":"duration","unitsDefault":5,"maxUnits":10,"multipliers":[{"when":{"field":"resolution","equals":"720p"},"setUsd":0.06},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.12}]},"input":"#/components/schemas/Input_fal_luma_ray_3_2_image_to_video"},{"id":"fal/pixverse-5-6-text-to-video","name":"PixVerse V5.6, text to video","status":"listed","pricing":{"model":"per_call","amountUsd":3.3,"multipliers":[{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.35},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.8},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.7},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.6},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.77},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.76},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.35},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.8},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.7},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.6},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.77},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.76},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.45},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.9},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.9},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.8},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.99},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.98},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.75},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.5},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":1.5},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":3},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":1.65},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":3.3}]},"input":"#/components/schemas/Input_fal_pixverse_5_6_text_to_video"},{"id":"fal/pixverse-5-6-image-to-video","name":"PixVerse V5.6, image to video","status":"listed","pricing":{"model":"per_call","amountUsd":3.3,"multipliers":[{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.35},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.8},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.7},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.6},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.77},{"all":[{"field":"resolution","equals":"360p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.76},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.35},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.8},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.7},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.6},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.77},{"all":[{"field":"resolution","equals":"540p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.76},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.45},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":0.9},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.9},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.8},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.99},{"all":[{"field":"resolution","equals":"720p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.98},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":false}],"setUsd":0.75},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"5"},{"field":"generate_audio_switch","equals":true}],"setUsd":1.5},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":false}],"setUsd":1.5},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"8"},{"field":"generate_audio_switch","equals":true}],"setUsd":3},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":false}],"setUsd":1.65},{"all":[{"field":"resolution","equals":"1080p"},{"field":"duration","equals":"10"},{"field":"generate_audio_switch","equals":true}],"setUsd":3.3}]},"input":"#/components/schemas/Input_fal_pixverse_5_6_image_to_video"},{"id":"fal/grok-imagine-video-1-5-text-to-video","name":"Grok Imagine Video 1.5 (xAI), text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.14,"unitsField":"duration","unitsDefault":6,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480p"},"setUsd":0.08},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.25}]},"input":"#/components/schemas/Input_fal_grok_imagine_video_1_5_text_to_video"},{"id":"fal/grok-imagine-video-1-5-image-to-video","name":"Grok Imagine Video 1.5 (xAI), image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.14,"unitsField":"duration","unitsDefault":6,"maxUnits":15,"multipliers":[{"when":{"field":"resolution","equals":"480p"},"setUsd":0.08},{"when":{"field":"resolution","equals":"1080p"},"setUsd":0.25},{"when":{"field":"image_url","minLength":1},"addUsd":0.01}]},"input":"#/components/schemas/Input_fal_grok_imagine_video_1_5_image_to_video"},{"id":"fal/vidu-q3-text-to-video","name":"Vidu Q3, text to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.154,"unitsField":"duration","unitsDefault":5,"maxUnits":16,"multipliers":[{"when":{"field":"resolution","in":["360p","540p"]},"setUsd":0.07}]},"input":"#/components/schemas/Input_fal_vidu_q3_text_to_video"},{"id":"fal/vidu-q3-image-to-video","name":"Vidu Q3, image to video","status":"listed","pricing":{"model":"per_unit","amountUsd":0.154,"unitsField":"duration","unitsDefault":5,"maxUnits":16,"multipliers":[{"when":{"field":"resolution","in":["360p","540p"]},"setUsd":0.07}]},"input":"#/components/schemas/Input_fal_vidu_q3_image_to_video"},{"id":"fal/sync-lipsync-v3","name":"sync-3 (sync.so), lipsync a video to an audio track","status":"listed","pricing":{"model":"per_unit","amountUsd":8,"unitsHeader":"x-fal-billable-units","maxUnits":10,"maxUnitsField":"max_minutes","fractional":true},"input":"#/components/schemas/Input_fal_sync_lipsync_v3"},{"id":"fal/veed-lipsync-v2","name":"VEED Lipsync v2, lipsync a video to an audio track","status":"listed","pricing":{"model":"per_unit","amountUsd":0.07,"unitsHeader":"x-fal-billable-units","maxUnits":600,"maxUnitsField":"max_seconds","fractional":true},"input":"#/components/schemas/Input_fal_veed_lipsync_v2"},{"id":"fal/omnihuman-1-5","name":"OmniHuman 1.5 (ByteDance), talking avatar from an image and an audio track","status":"listed","pricing":{"model":"per_unit","amountUsd":0.16,"unitsHeader":"x-fal-billable-units","maxUnits":600,"maxUnitsField":"max_seconds","fractional":true,"unitsPath":"duration"},"input":"#/components/schemas/Input_fal_omnihuman_1_5"},{"id":"fal/status","name":"fal.ai queue status","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_fal_status"},{"id":"fal/result","name":"fal.ai queue result","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_fal_result"},{"id":"fal/elevenlabs-tts-multilingual-v2","name":"ElevenLabs Multilingual v2, text to speech","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"text","unitsMeasure":"chars","unitsPer":1000,"fractional":true,"unitsDefault":1,"maxUnits":50},"input":"#/components/schemas/Input_fal_elevenlabs_tts_multilingual_v2"},{"id":"fal/elevenlabs-tts-v3","name":"ElevenLabs Eleven v3, expressive text to speech","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"text","unitsMeasure":"chars","unitsPer":1000,"fractional":true,"unitsDefault":1,"maxUnits":50},"input":"#/components/schemas/Input_fal_elevenlabs_tts_v3"},{"id":"fal/elevenlabs-tts-turbo-v2-5","name":"ElevenLabs Turbo v2.5, fast text to speech","status":"listed","pricing":{"model":"per_unit","amountUsd":0.05,"unitsField":"text","unitsMeasure":"chars","unitsPer":1000,"fractional":true,"unitsDefault":1,"maxUnits":50},"input":"#/components/schemas/Input_fal_elevenlabs_tts_turbo_v2_5"},{"id":"fal/elevenlabs-text-to-dialogue-v3","name":"ElevenLabs Eleven v3, multi-speaker dialogue to speech","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsField":"inputs","unitsMeasure":"chars","unitsItemField":"text","unitsPer":1000,"fractional":true,"unitsDefault":1,"maxUnits":50},"input":"#/components/schemas/Input_fal_elevenlabs_text_to_dialogue_v3"},{"id":"fal/elevenlabs-sound-effects-v2","name":"ElevenLabs Sound Effects v2, text to sound effect","status":"listed","pricing":{"model":"per_unit","amountUsd":0.002,"unitsField":"duration_seconds","unitsDefault":22,"maxUnits":22},"input":"#/components/schemas/Input_fal_elevenlabs_sound_effects_v2"},{"id":"fal/elevenlabs-music","name":"ElevenLabs Music, text to music","status":"listed","pricing":{"model":"per_unit","amountUsd":0.6,"unitsField":"music_length_ms","unitsPer":60000,"unitsDefault":60000,"maxUnits":10},"input":"#/components/schemas/Input_fal_elevenlabs_music"},{"id":"fal/elevenlabs-speech-to-text","name":"ElevenLabs Scribe, speech to text","status":"listed","pricing":{"model":"per_unit","amountUsd":0.03,"unitsHeader":"x-fal-billable-units","maxUnits":60,"maxUnitsField":"max_minutes","fractional":true},"input":"#/components/schemas/Input_fal_elevenlabs_speech_to_text"},{"id":"fal/elevenlabs-scribe-v2","name":"ElevenLabs Scribe v2, speech to text","status":"listed","pricing":{"model":"per_unit","amountUsd":0.008,"unitsHeader":"x-fal-billable-units","maxUnits":60,"maxUnitsField":"max_minutes","fractional":true,"multipliers":[{"when":{"field":"keyterms","minLength":1},"factor":1.3}]},"input":"#/components/schemas/Input_fal_elevenlabs_scribe_v2"},{"id":"fal/elevenlabs-audio-isolation","name":"ElevenLabs Audio Isolation, remove background noise","status":"listed","pricing":{"model":"per_unit","amountUsd":0.1,"unitsHeader":"x-fal-billable-units","maxUnits":60,"maxUnitsField":"max_minutes","fractional":true},"input":"#/components/schemas/Input_fal_elevenlabs_audio_isolation"},{"id":"fal/elevenlabs-voice-changer","name":"ElevenLabs Voice Changer, speech to speech","status":"listed","pricing":{"model":"per_unit","amountUsd":0.3,"unitsHeader":"x-fal-billable-units","maxUnits":60,"maxUnitsField":"max_minutes","fractional":true},"input":"#/components/schemas/Input_fal_elevenlabs_voice_changer"},{"id":"fal/elevenlabs-dubbing","name":"ElevenLabs Dubbing, translate and dub a video or audio","status":"listed","pricing":{"model":"per_unit","amountUsd":0.6,"unitsHeader":"x-fal-billable-units","maxUnits":60,"maxUnitsField":"max_minutes","fractional":false},"input":"#/components/schemas/Input_fal_elevenlabs_dubbing"},{"id":"exa/search","name":"Exa web search (neural, fast, deep)","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdDefault":0.007,"maxUsdCap":2,"multipliers":[{"when":{"field":"type","in":["deep-lite","deep"]},"setUsd":0.012},{"when":{"field":"type","equals":"deep-reasoning"},"setUsd":0.015},{"addUsdPer":{"field":"numResults","default":10,"max":100,"usd":0.001,"minus":10}},{"when":{"field":"contents.text","truthy":true},"addUsdPer":{"field":"numResults","usd":0.001,"default":10,"max":100}},{"when":{"field":"contents.highlights","truthy":true},"addUsdPer":{"field":"numResults","usd":0.001,"default":10,"max":100}},{"when":{"field":"contents.summary","truthy":true},"addUsdPer":{"field":"numResults","usd":0.001,"default":10,"max":100}},{"when":{"field":"contents.subpages","gte":1},"addUsdPer":{"field":"contents.subpages","usd":0.003,"max":100,"timesField":"numResults","timesDefault":10,"timesMax":100}},{"when":{"field":"outputSchema","truthy":true},"addUsd":0.001}]},"input":"#/components/schemas/Input_exa_search"},{"id":"exa/contents","name":"Exa page contents (text, highlights, summary) for URLs","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdDefault":0,"maxUsdCap":2,"multipliers":[{"addUsdPer":{"field":"urls","usd":0.001,"max":100}},{"addUsdPer":{"field":"ids","usd":0.001,"max":100}},{"when":{"field":"highlights","truthy":true},"addUsdPer":{"field":"urls","usd":0.001,"max":100}},{"when":{"field":"highlights","truthy":true},"addUsdPer":{"field":"ids","usd":0.001,"max":100}},{"when":{"field":"summary","truthy":true},"addUsdPer":{"field":"urls","usd":0.001,"max":100}},{"when":{"field":"summary","truthy":true},"addUsdPer":{"field":"ids","usd":0.001,"max":100}},{"when":{"field":"subpages","gte":1},"addUsdPer":{"field":"subpages","usd":0.003,"max":100,"timesField":"urls","timesDefault":0,"timesMax":100}},{"when":{"field":"subpages","gte":1},"addUsdPer":{"field":"subpages","usd":0.003,"max":100,"timesField":"ids","timesDefault":0,"timesMax":100}}]},"input":"#/components/schemas/Input_exa_contents"},{"id":"exa/answer","name":"Exa answer with citations","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdDefault":0.005,"maxUsdCap":1,"multipliers":[{"when":{"field":"model","equals":"exa-pro"},"setUsd":0.01},{"when":{"field":"model","equals":"exa-research"},"setUsd":0.05},{"when":{"field":"text","truthy":true},"addUsd":0.02},{"when":{"field":"outputSchema","truthy":true},"addUsd":0.001}]},"input":"#/components/schemas/Input_exa_answer"},{"id":"exa/agent-run","name":"Exa agent run (multi-step research, list building, enrichment)","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"budget.maxCostDollars","maxUsdDefault":5,"maxUsdCap":100,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.012},{"when":{"field":"effort","equals":"low"},"setUsd":0.025},{"when":{"field":"effort","equals":"medium"},"setUsd":0.1},{"when":{"field":"effort","equals":"high"},"setUsd":0.5},{"when":{"field":"effort","equals":"xhigh"},"setUsd":1},{"when":{"field":"effort","equals":"max"},"setUsd":20},{"when":{"field":"dataSources","minLength":1},"setUsd":5}]},"input":"#/components/schemas/Input_exa_agent_run"},{"id":"exa/agent-run-get","name":"Exa agent run: status and output","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_exa_agent_run_get"},{"id":"exa/agent-run-events","name":"Exa agent run: event log","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_exa_agent_run_events"},{"id":"exa/agent-run-stop","name":"Exa agent run: stop early and keep results","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_exa_agent_run_stop"},{"id":"exa/agent-run-cancel","name":"Exa agent run: cancel","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_exa_agent_run_cancel"},{"id":"exa/similarweb","name":"Similarweb via Exa: website traffic, rankings, competitors","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.325,"maxUsdCap":5,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.312},{"when":{"field":"effort","equals":"low"},"setUsd":0.325},{"when":{"field":"effort","equals":"medium"},"setUsd":0.4},{"when":{"field":"effort","equals":"high"},"setUsd":0.8}]},"input":"#/components/schemas/Input_exa_similarweb"},{"id":"exa/financial-datasets","name":"Financial Datasets via Exa: prices, fundamentals, SEC filings, ownership for US tickers","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.225,"maxUsdCap":5,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.212},{"when":{"field":"effort","equals":"low"},"setUsd":0.225},{"when":{"field":"effort","equals":"medium"},"setUsd":0.3},{"when":{"field":"effort","equals":"high"},"setUsd":0.7}]},"input":"#/components/schemas/Input_exa_financial_datasets"},{"id":"exa/fiber","name":"Fiber.ai via Exa: B2B companies, people, LinkedIn signals and contact enrichment","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":1.025,"maxUsdCap":20,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":1.012},{"when":{"field":"effort","equals":"low"},"setUsd":1.025},{"when":{"field":"effort","equals":"medium"},"setUsd":1.1},{"when":{"field":"effort","equals":"high"},"setUsd":1.5}]},"input":"#/components/schemas/Input_exa_fiber"},{"id":"exa/baselayer","name":"Baselayer via Exa: KYB verification of US businesses, officers, registrations, risk","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":2.025,"maxUsdCap":20,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":2.012},{"when":{"field":"effort","equals":"low"},"setUsd":2.025},{"when":{"field":"effort","equals":"medium"},"setUsd":2.1},{"when":{"field":"effort","equals":"high"},"setUsd":2.5}]},"input":"#/components/schemas/Input_exa_baselayer"},{"id":"exa/affiliate","name":"Affiliate.com via Exa: product catalog search with live prices and merchant links","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.25,"maxUsdCap":5,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.237},{"when":{"field":"effort","equals":"low"},"setUsd":0.25},{"when":{"field":"effort","equals":"medium"},"setUsd":0.325},{"when":{"field":"effort","equals":"high"},"setUsd":0.725}]},"input":"#/components/schemas/Input_exa_affiliate"},{"id":"exa/particle","name":"Particle via Exa: podcast transcript search with speakers and timestamps","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.25,"maxUsdCap":5,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.237},{"when":{"field":"effort","equals":"low"},"setUsd":0.25},{"when":{"field":"effort","equals":"medium"},"setUsd":0.325},{"when":{"field":"effort","equals":"high"},"setUsd":0.725}]},"input":"#/components/schemas/Input_exa_particle"},{"id":"exa/jinko","name":"Jinko via Exa: flight and hotel search with live prices","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.125,"maxUsdCap":5,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.112},{"when":{"field":"effort","equals":"low"},"setUsd":0.125},{"when":{"field":"effort","equals":"medium"},"setUsd":0.2},{"when":{"field":"effort","equals":"high"},"setUsd":0.6}]},"input":"#/components/schemas/Input_exa_jinko"},{"id":"exa/polymarket","name":"Polymarket via Exa: prediction-market odds, price history, order books, holders","status":"listed","pricing":{"model":"reported","costPath":"costDollars.total","maxUsdField":"max_cost_usd","maxUsdDefault":0.025,"maxUsdCap":2,"multipliers":[{"when":{"field":"effort","equals":"minimal"},"setUsd":0.012},{"when":{"field":"effort","equals":"low"},"setUsd":0.025},{"when":{"field":"effort","equals":"medium"},"setUsd":0.1},{"when":{"field":"effort","equals":"high"},"setUsd":0.5}]},"input":"#/components/schemas/Input_exa_polymarket"},{"id":"x/search-recent","name":"X (Twitter) recent search: posts from the last 7 days","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"data","usd":0.005},{"path":"includes.tweets","usd":0.005},{"path":"includes.users","usd":0.01}],"maxUsdDefault":0,"maxUsdCap":3,"multipliers":[{"addUsdPer":{"field":"max_results","usd":0.005,"default":10,"max":100}},{"when":{"field":"expansions","truthy":true},"addUsdPer":{"field":"max_results","usd":0.015,"default":10,"max":100}}]},"input":"#/components/schemas/Input_x_search_recent"},{"id":"x/search-all","name":"X (Twitter) full-archive search: posts since 2006","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"data","usd":0.005},{"path":"includes.tweets","usd":0.005},{"path":"includes.users","usd":0.01}],"maxUsdDefault":0,"maxUsdCap":12,"multipliers":[{"addUsdPer":{"field":"max_results","usd":0.005,"default":10,"max":500}},{"when":{"field":"expansions","truthy":true},"addUsdPer":{"field":"max_results","usd":0.015,"default":10,"max":500}}]},"input":"#/components/schemas/Input_x_search_all"},{"id":"x/posts-by-ids","name":"X (Twitter) posts by ids","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"data","usd":0.005},{"path":"includes.tweets","usd":0.005},{"path":"includes.users","usd":0.01}],"maxUsdDefault":0,"maxUsdCap":3,"multipliers":[{"addUsdPer":{"field":"ids","usd":0.005,"max":100}},{"when":{"field":"expansions","truthy":true},"addUsdPer":{"field":"ids","usd":0.015,"max":100}}]},"input":"#/components/schemas/Input_x_posts_by_ids"},{"id":"x/users-by-usernames","name":"X (Twitter) user profiles by usernames","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"data","usd":0.01},{"path":"includes.tweets","usd":0.005}],"maxUsdDefault":0,"maxUsdCap":2,"multipliers":[{"addUsdPer":{"field":"usernames","usd":0.01,"max":100}},{"when":{"field":"expansions","truthy":true},"addUsdPer":{"field":"usernames","usd":0.005,"max":100}}]},"input":"#/components/schemas/Input_x_users_by_usernames"},{"id":"x/user-posts","name":"X (Twitter) posts of a user (timeline)","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"data","usd":0.005},{"path":"includes.tweets","usd":0.005},{"path":"includes.users","usd":0.01}],"maxUsdDefault":0,"maxUsdCap":3,"multipliers":[{"addUsdPer":{"field":"max_results","usd":0.005,"default":10,"max":100}},{"when":{"field":"expansions","truthy":true},"addUsdPer":{"field":"max_results","usd":0.015,"default":10,"max":100}}]},"input":"#/components/schemas/Input_x_user_posts"},{"id":"xai/x-search","name":"Grok X search: what X (Twitter) says, with cited posts","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"usage.cost_in_usd_ticks","usd":1e-10}],"maxUsdField":"max_cost_usd","maxUsdDefault":0.15,"maxUsdCap":5,"multipliers":[{"when":{"field":"model","equals":"grok-4.6"},"setUsd":0.3},{"addUsdPer":{"field":"max_output_tokens","usd":0.000006,"default":1024,"max":8192}}]},"input":"#/components/schemas/Input_xai_x_search"},{"id":"xai/web-search","name":"Grok web search: browse the web and answer with cited sources","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"usage.cost_in_usd_ticks","usd":1e-10}],"maxUsdField":"max_cost_usd","maxUsdDefault":0.15,"maxUsdCap":5,"multipliers":[{"when":{"field":"model","equals":"grok-4.6"},"setUsd":0.3},{"addUsdPer":{"field":"max_output_tokens","usd":0.000006,"default":1024,"max":8192}}]},"input":"#/components/schemas/Input_xai_web_search"},{"id":"dataforseo/ai-optimization-ai-keyword-data-keywords-search-volume","name":"Ai Visibility Ai Keyword Data Keywords Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.01,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.0001,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_ai_keyword_data_keywords_search_volume"},{"id":"dataforseo/ai-optimization-chat-gpt-llm-responses","name":"Ai Visibility Chat Gpt Llm Responses","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.2,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_chat_gpt_llm_responses"},{"id":"dataforseo/ai-optimization-chat-gpt-llm-scraper","name":"Ai Visibility Chat Gpt Llm Scraper","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_chat_gpt_llm_scraper"},{"id":"dataforseo/ai-optimization-claude-llm-responses","name":"Ai Visibility Claude Llm Responses","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.2,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_claude_llm_responses"},{"id":"dataforseo/ai-optimization-gemini-llm-responses","name":"Ai Visibility Gemini Llm Responses","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.2,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_gemini_llm_responses"},{"id":"dataforseo/ai-optimization-gemini-llm-scraper","name":"Ai Visibility Gemini Llm Scraper","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_gemini_llm_scraper"},{"id":"dataforseo/ai-optimization-llm-mentions-historical","name":"Ai Visibility Llm Mentions Historical","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.001,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_historical"},{"id":"dataforseo/ai-optimization-llm-mentions-multi-target-metrics","name":"Ai Visibility Llm Mentions Multi Target Metrics","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000,"timesField":"targets","timesDefault":100,"timesMax":100}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_multi_target_metrics"},{"id":"dataforseo/ai-optimization-llm-mentions-search-mentions","name":"Ai Visibility Llm Mentions Search Mentions","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_search_mentions"},{"id":"dataforseo/ai-optimization-llm-mentions-target-metrics","name":"Ai Visibility Llm Mentions Target Metrics","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":1.1,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_target_metrics"},{"id":"dataforseo/ai-optimization-llm-mentions-target-metrics-lite","name":"Ai Visibility Llm Mentions Target Metrics Lite","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_target_metrics_lite"},{"id":"dataforseo/ai-optimization-llm-mentions-timeseries-delta","name":"Ai Visibility Llm Mentions Timeseries Delta","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.001,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_timeseries_delta"},{"id":"dataforseo/ai-optimization-llm-mentions-timeseries-new-lost","name":"Ai Visibility Llm Mentions Timeseries New Lost","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.001,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_timeseries_new_lost"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-brand-categories","name":"Ai Visibility Llm Mentions Top Mentioned Brand Categories","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brand_categories"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-brand-categories-lite","name":"Ai Visibility Llm Mentions Top Mentioned Brand Categories Lite","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brand_categories_lite"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-brands","name":"Ai Visibility Llm Mentions Top Mentioned Brands","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brands"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-brands-lite","name":"Ai Visibility Llm Mentions Top Mentioned Brands Lite","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_brands_lite"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-domains","name":"Ai Visibility Llm Mentions Top Mentioned Domains","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_domains"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-domains-lite","name":"Ai Visibility Llm Mentions Top Mentioned Domains Lite","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_domains_lite"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-pages","name":"Ai Visibility Llm Mentions Top Mentioned Pages","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_pages"},{"id":"dataforseo/ai-optimization-llm-mentions-top-mentioned-pages-lite","name":"Ai Visibility Llm Mentions Top Mentioned Pages Lite","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_llm_mentions_top_mentioned_pages_lite"},{"id":"dataforseo/ai-optimization-perplexity-llm-responses","name":"Ai Visibility Perplexity Llm Responses","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.2,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_ai_optimization_perplexity_llm_responses"},{"id":"dataforseo/app-data-apple-app-info","name":"App Data Apple App Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_apple_app_info"},{"id":"dataforseo/app-data-apple-app-list","name":"App Data Apple App List","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0012,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_apple_app_list"},{"id":"dataforseo/app-data-apple-app-listings-search","name":"App Data Apple App Listings Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_apple_app_listings_search"},{"id":"dataforseo/app-data-apple-app-reviews","name":"App Data Apple App Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_apple_app_reviews"},{"id":"dataforseo/app-data-apple-app-searches","name":"App Data Apple App Searches","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0012,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_apple_app_searches"},{"id":"dataforseo/app-data-google-app-info","name":"App Data Google App Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_google_app_info"},{"id":"dataforseo/app-data-google-app-list","name":"App Data Google App List","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0012,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_google_app_list"},{"id":"dataforseo/app-data-google-app-listings-search","name":"App Data Google App Listings Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.1,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.001,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_google_app_listings_search"},{"id":"dataforseo/app-data-google-app-reviews","name":"App Data Google App Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_google_app_reviews"},{"id":"dataforseo/app-data-google-app-searches","name":"App Data Google App Searches","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0012,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_app_data_google_app_searches"},{"id":"dataforseo/backlinks-anchors","name":"Anchor texts pointing to a domain or page (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_anchors"},{"id":"dataforseo/backlinks-list","name":"Backlinks of a domain or page (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_list"},{"id":"dataforseo/backlinks-bulk-backlinks","name":"Backlink counts for up to 1,000 targets (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":1,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_backlinks"},{"id":"dataforseo/backlinks-bulk-new-lost-backlinks","name":"Backlinks Bulk New Lost Backlinks","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_new_lost_backlinks"},{"id":"dataforseo/backlinks-bulk-new-lost-referring-domains","name":"Backlinks Bulk New Lost Referring Domains","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_new_lost_referring_domains"},{"id":"dataforseo/backlinks-bulk-pages-summary","name":"Backlinks Bulk Pages Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_pages_summary"},{"id":"dataforseo/backlinks-bulk-ranks","name":"Domain rank for up to 1,000 targets (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":1,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_ranks"},{"id":"dataforseo/backlinks-bulk-referring-domains","name":"Referring domain counts for up to 1,000 targets (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":1,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_referring_domains"},{"id":"dataforseo/backlinks-bulk-spam-score","name":"Spam score for up to 1,000 targets (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.000036,"default":1,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_bulk_spam_score"},{"id":"dataforseo/backlinks-competitors","name":"Backlink competitors of a domain (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_competitors"},{"id":"dataforseo/backlinks-domain-intersection","name":"Backlinks Domain Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_domain_intersection"},{"id":"dataforseo/backlinks-domain-pages","name":"Backlinks Domain Pages","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_domain_pages"},{"id":"dataforseo/backlinks-domain-pages-summary","name":"Backlinks Domain Pages Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_domain_pages_summary"},{"id":"dataforseo/backlinks-history","name":"Backlinks History","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.000036,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_history"},{"id":"dataforseo/backlinks-page-intersection","name":"Backlinks Page Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_page_intersection"},{"id":"dataforseo/backlinks-referring-domains","name":"Referring domains of a domain or page (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":0.1,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_referring_domains"},{"id":"dataforseo/backlinks-referring-networks","name":"Backlinks Referring Networks","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_referring_networks"},{"id":"dataforseo/backlinks-summary","name":"Backlink profile summary of a domain or page (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024036000000000002,"maxUsdCap":0.05,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_summary"},{"id":"dataforseo/backlinks-timeseries-new-lost-summary","name":"Backlinks Timeseries New Lost Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.000036,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_timeseries_new_lost_summary"},{"id":"dataforseo/backlinks-timeseries-summary","name":"Backlinks Timeseries Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.000036,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_backlinks_timeseries_summary"},{"id":"dataforseo/business-data-business-listings-categories-aggregation","name":"Business Data Business Listings Categories Aggregation","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_business_listings_categories_aggregation"},{"id":"dataforseo/business-data-business-listings-search","name":"Business Data Business Listings Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_business_listings_search"},{"id":"dataforseo/business-data-google-extended-reviews","name":"Business Data Google Extended Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0015,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_extended_reviews"},{"id":"dataforseo/business-data-google-hotel-info","name":"Business Data Google Hotel Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_hotel_info"},{"id":"dataforseo/business-data-google-hotel-searches","name":"Business Data Google Hotel Searches","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_hotel_searches"},{"id":"dataforseo/business-data-google-my-business-info","name":"Business Data Google My Business Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0054,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_my_business_info"},{"id":"dataforseo/business-data-google-my-business-updates","name":"Business Data Google My Business Updates","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00225,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_my_business_updates"},{"id":"dataforseo/business-data-google-questions-and-answers","name":"Business Data Google Questions And Answers","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0054,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_questions_and_answers"},{"id":"dataforseo/business-data-google-reviews","name":"Business Data Google Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_google_reviews"},{"id":"dataforseo/business-data-social-media-pinterest","name":"Business Data Social Media Pinterest","status":"listed","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.00004,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_social_media_pinterest"},{"id":"dataforseo/business-data-tripadvisor-reviews","name":"Business Data Tripadvisor Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_tripadvisor_reviews"},{"id":"dataforseo/business-data-tripadvisor-search","name":"Business Data Tripadvisor Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_tripadvisor_search"},{"id":"dataforseo/business-data-trustpilot-reviews","name":"Business Data Trustpilot Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_trustpilot_reviews"},{"id":"dataforseo/business-data-trustpilot-search","name":"Business Data Trustpilot Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_business_data_trustpilot_search"},{"id":"dataforseo/content-analysis-category-trends","name":"Content Analysis Category Trends","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.000036,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_category_trends"},{"id":"dataforseo/content-analysis-phrase-trends","name":"Content Analysis Phrase Trends","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.000036,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_phrase_trends"},{"id":"dataforseo/content-analysis-rating-distribution","name":"Content Analysis Rating Distribution","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_rating_distribution"},{"id":"dataforseo/content-analysis-search","name":"Content Analysis Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.024,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.000036,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_search"},{"id":"dataforseo/content-analysis-sentiment-analysis","name":"Content Analysis Sentiment Analysis","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.06,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_sentiment_analysis"},{"id":"dataforseo/content-analysis-summary","name":"Content Analysis Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.06,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_content_analysis_summary"},{"id":"dataforseo/dataforseo-labs-amazon-bulk-search-volume","name":"Seo Labs Amazon Bulk Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_bulk_search_volume"},{"id":"dataforseo/dataforseo-labs-amazon-product-competitors","name":"Seo Labs Amazon Product Competitors","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_product_competitors"},{"id":"dataforseo/dataforseo-labs-amazon-product-keyword-intersections","name":"Seo Labs Amazon Product Keyword Intersections","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_product_keyword_intersections"},{"id":"dataforseo/dataforseo-labs-amazon-product-rank-overview","name":"Seo Labs Amazon Product Rank Overview","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"asins","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_product_rank_overview"},{"id":"dataforseo/dataforseo-labs-amazon-ranked-keywords","name":"Seo Labs Amazon Ranked Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_ranked_keywords"},{"id":"dataforseo/dataforseo-labs-amazon-related-keywords","name":"Seo Labs Amazon Related Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_amazon_related_keywords"},{"id":"dataforseo/dataforseo-labs-apple-app-competitors","name":"Seo Labs Apple App Competitors","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_apple_app_competitors"},{"id":"dataforseo/dataforseo-labs-apple-app-intersection","name":"Seo Labs Apple App Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_apple_app_intersection"},{"id":"dataforseo/dataforseo-labs-apple-bulk-app-metrics","name":"Seo Labs Apple Bulk App Metrics","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"app_ids","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_apple_bulk_app_metrics"},{"id":"dataforseo/dataforseo-labs-apple-keywords-for-app","name":"Seo Labs Apple Keywords For App","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_apple_keywords_for_app"},{"id":"dataforseo/dataforseo-labs-google-app-competitors","name":"Seo Labs Google App Competitors","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_app_competitors"},{"id":"dataforseo/dataforseo-labs-google-app-intersection","name":"Seo Labs Google App Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_app_intersection"},{"id":"dataforseo/dataforseo-labs-google-available-history","name":"Seo Labs Google Available History","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_available_history"},{"id":"dataforseo/dataforseo-labs-google-bulk-app-metrics","name":"Seo Labs Google Bulk App Metrics","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"app_ids","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_bulk_app_metrics"},{"id":"dataforseo/dataforseo-labs-google-bulk-keyword-difficulty","name":"Seo Labs Google Bulk Keyword Difficulty","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_bulk_keyword_difficulty"},{"id":"dataforseo/dataforseo-labs-google-bulk-traffic-estimation","name":"Seo Labs Google Bulk Traffic Estimation","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_bulk_traffic_estimation"},{"id":"dataforseo/dataforseo-labs-google-categories-for-domain","name":"Seo Labs Google Categories For Domain","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_categories_for_domain"},{"id":"dataforseo/dataforseo-labs-google-categories-for-keywords","name":"Seo Labs Google Categories For Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_categories_for_keywords"},{"id":"dataforseo/dataforseo-labs-google-competitors-domain","name":"Seo Labs Google Competitors Domain","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_competitors_domain"},{"id":"dataforseo/dataforseo-labs-google-domain-intersection","name":"Seo Labs Google Domain Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_domain_intersection"},{"id":"dataforseo/dataforseo-labs-google-domain-metrics-by-categories","name":"Seo Labs Google Domain Metrics By Categories","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.12,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.0012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_domain_metrics_by_categories"},{"id":"dataforseo/dataforseo-labs-google-domain-rank-overview","name":"Seo Labs Google Domain Rank Overview","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_domain_rank_overview"},{"id":"dataforseo/dataforseo-labs-google-historical-bulk-traffic-estimation","name":"Seo Labs Google Historical Bulk Traffic Estimation","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.12,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"targets","usd":0.0144,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_historical_bulk_traffic_estimation"},{"id":"dataforseo/dataforseo-labs-google-historical-keyword-data","name":"Seo Labs Google Historical Keyword Data","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_historical_keyword_data"},{"id":"dataforseo/dataforseo-labs-google-historical-rank-overview","name":"Seo Labs Google Historical Rank Overview","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.12,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.0012,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_historical_rank_overview"},{"id":"dataforseo/dataforseo-labs-google-historical-serps","name":"Seo Labs Google Historical Serps","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.00012,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_historical_serps"},{"id":"dataforseo/dataforseo-labs-google-keyword-ideas","name":"Seo Labs Google Keyword Ideas","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keyword_ideas"},{"id":"dataforseo/dataforseo-labs-google-keyword-overview","name":"Seo Labs Google Keyword Overview","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keyword_overview"},{"id":"dataforseo/dataforseo-labs-google-keyword-suggestions","name":"Seo Labs Google Keyword Suggestions","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keyword_suggestions"},{"id":"dataforseo/dataforseo-labs-google-keywords-for-app","name":"Seo Labs Google Keywords For App","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keywords_for_app"},{"id":"dataforseo/dataforseo-labs-google-keywords-for-categories","name":"Seo Labs Google Keywords For Categories","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keywords_for_categories"},{"id":"dataforseo/dataforseo-labs-google-keywords-for-site","name":"Seo Labs Google Keywords For Site","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_keywords_for_site"},{"id":"dataforseo/dataforseo-labs-google-page-intersection","name":"Seo Labs Google Page Intersection","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_page_intersection"},{"id":"dataforseo/dataforseo-labs-google-ranked-keywords","name":"Seo Labs Google Ranked Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_ranked_keywords"},{"id":"dataforseo/dataforseo-labs-google-related-keywords","name":"Seo Labs Google Related Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_related_keywords"},{"id":"dataforseo/dataforseo-labs-google-relevant-pages","name":"Seo Labs Google Relevant Pages","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_relevant_pages"},{"id":"dataforseo/dataforseo-labs-google-search-intent","name":"Seo Labs Google Search Intent","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_search_intent"},{"id":"dataforseo/dataforseo-labs-google-serp-competitors","name":"Seo Labs Google Serp Competitors","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_serp_competitors"},{"id":"dataforseo/dataforseo-labs-google-subdomains","name":"Seo Labs Google Subdomains","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_subdomains"},{"id":"dataforseo/dataforseo-labs-google-top-searches","name":"Seo Labs Google Top Searches","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.00012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_dataforseo_labs_google_top_searches"},{"id":"dataforseo/domain-analytics-technologies-aggregation-technologies","name":"Domain Analytics Technologies Aggregation Technologies","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.0012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_aggregation_technologies"},{"id":"dataforseo/domain-analytics-technologies-domain-technologies","name":"Domain Analytics Technologies Domain Technologies","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_domain_technologies"},{"id":"dataforseo/domain-analytics-technologies-domains-by-html-terms","name":"Domain Analytics Technologies Domains By Html Terms","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.0012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_domains_by_html_terms"},{"id":"dataforseo/domain-analytics-technologies-domains-by-technology","name":"Domain Analytics Technologies Domains By Technology","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.0012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_domains_by_technology"},{"id":"dataforseo/domain-analytics-technologies-technologies-summary","name":"Domain Analytics Technologies Technologies Summary","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"technologies","usd":0.0012,"default":10,"max":10}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_technologies_summary"},{"id":"dataforseo/domain-analytics-technologies-technology-stats","name":"Domain Analytics Technologies Technology Stats","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"date_from","dateRange":{"endField":"date_to","defaultStart":"2000-01-01"},"usd":0.0012,"default":36525,"max":36525}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_technologies_technology_stats"},{"id":"dataforseo/domain-analytics-whois-overview","name":"Domain Analytics Whois Overview","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.12,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"limit","usd":0.0012,"default":10,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_domain_analytics_whois_overview"},{"id":"dataforseo/keywords-data-bing-audience-estimation","name":"Keywords Data Bing Audience Estimation","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_audience_estimation"},{"id":"dataforseo/keywords-data-bing-keyword-performance","name":"Keywords Data Bing Keyword Performance","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_keyword_performance"},{"id":"dataforseo/keywords-data-bing-keyword-suggestions-for-url","name":"Keywords Data Bing Keyword Suggestions For Url","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_keyword_suggestions_for_url"},{"id":"dataforseo/keywords-data-bing-keywords-for-keywords","name":"Keywords Data Bing Keywords For Keywords","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_keywords_for_keywords"},{"id":"dataforseo/keywords-data-bing-keywords-for-site","name":"Keywords Data Bing Keywords For Site","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_keywords_for_site"},{"id":"dataforseo/keywords-data-bing-search-volume","name":"Keywords Data Bing Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_search_volume"},{"id":"dataforseo/keywords-data-bing-search-volume-history","name":"Keywords Data Bing Search Volume History","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_bing_search_volume_history"},{"id":"dataforseo/keywords-data-clickstream-data-bulk-search-volume","name":"Keywords Data Clickstream Data Bulk Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.012,"maxUsdCap":100,"multipliers":[{"addUsdPer":{"field":"keywords","usd":0.00012,"default":100,"max":1000}}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_clickstream_data_bulk_search_volume"},{"id":"dataforseo/keywords-data-clickstream-data-dataforseo-search-volume","name":"Keywords Data Clickstream Data Dataforseo Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.18,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_clickstream_data_dataforseo_search_volume"},{"id":"dataforseo/keywords-data-clickstream-data-global-search-volume","name":"Keywords Data Clickstream Data Global Search Volume","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.18,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_clickstream_data_global_search_volume"},{"id":"dataforseo/keywords-data-dataforseo-trends-demography","name":"Keywords Data Dataforseo Trends Demography","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0024,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_dataforseo_trends_demography"},{"id":"dataforseo/keywords-data-dataforseo-trends-explore","name":"Keywords Data Dataforseo Trends Explore","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0012,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_dataforseo_trends_explore"},{"id":"dataforseo/keywords-data-dataforseo-trends-merged-data","name":"Keywords Data Dataforseo Trends Merged Data","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.006,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_dataforseo_trends_merged_data"},{"id":"dataforseo/keywords-data-dataforseo-trends-subregion-interests","name":"Keywords Data Dataforseo Trends Subregion Interests","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0024,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_keywords_data_dataforseo_trends_subregion_interests"},{"id":"dataforseo/google-ads-ad-traffic","name":"Google Ads traffic forecast for keywords and a bid (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":0.2,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_ad_traffic"},{"id":"dataforseo/google-ads-keywords-for-keywords","name":"Google Ads keyword ideas from seed keywords (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":0.2,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_keywords_for_keywords"},{"id":"dataforseo/google-ads-keywords-for-site","name":"Google Ads keyword ideas for a website or page (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":0.2,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_keywords_for_site"},{"id":"dataforseo/google-ads-search-volume","name":"Google Ads keyword search volume, CPC and competition (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.09,"maxUsdCap":0.2,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_search_volume"},{"id":"dataforseo/google-trends","name":"Google Trends: interest over time, by region, related topics and queries (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.011,"maxUsdCap":0.05,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_trends"},{"id":"dataforseo/amazon-asin","name":"Amazon product page by ASIN (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.005,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_amazon_asin"},{"id":"dataforseo/amazon-products-task","name":"Amazon product search: create a task (results in a few minutes)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0015,"maxUsdCap":0.5,"multipliers":[{"when":{"field":"depth","gte":101},"addUsd":0.0015},{"when":{"field":"depth","gte":201},"addUsd":0.0015},{"when":{"field":"depth","gte":301},"addUsd":0.0015},{"when":{"field":"depth","gte":401},"addUsd":0.0015},{"when":{"field":"depth","gte":501},"addUsd":0.0015},{"when":{"field":"depth","gte":601},"addUsd":0.0015},{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_amazon_products_task"},{"id":"dataforseo/amazon-sellers","name":"Amazon sellers and offers for an ASIN (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.005,"maxUsdCap":0.05,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_amazon_sellers"},{"id":"dataforseo/merchant-google-product-info","name":"Merchant Google Product Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.001,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_merchant_google_product_info"},{"id":"dataforseo/google-shopping-products-task","name":"Google Shopping product search: create a task (results in a few minutes)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.001,"maxUsdCap":0.05,"multipliers":[{"when":{"field":"depth","gte":41},"addUsd":0.001},{"when":{"field":"depth","gte":81},"addUsd":0.001},{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_shopping_products_task"},{"id":"dataforseo/merchant-google-reviews","name":"Merchant Google Reviews","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00075,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_merchant_google_reviews"},{"id":"dataforseo/merchant-google-sellers","name":"Merchant Google Sellers","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.001,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_merchant_google_sellers"},{"id":"dataforseo/on-page-content-parsing","name":"On Page Content Parsing","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00015,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_on_page_content_parsing"},{"id":"dataforseo/on-page-crawl","name":"On Page Crawl","status":"active","pricing":{"model":"per_unit","amountUsd":0.00015,"unitsPath":"tasks.0.result.0.crawl_status.pages_crawled","maxUnits":100,"maxUnitsField":"max_crawl_pages","multipliers":[{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00015},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0003},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0003},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00045},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0051},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0054},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0015},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00165},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00165},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0018},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0051},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":false},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0054},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00045},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0006},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0006},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00075},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0051},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":false},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0054},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0018},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00195},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00195},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":false},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0021},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":false}],"setUsd":0.0051},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":false},{"field":"enable_content_parsing","equals":true}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":false}],"setUsd":0.00525},{"all":[{"field":"load_resources","equals":true},{"field":"enable_javascript","equals":true},{"field":"enable_browser_rendering","equals":true},{"field":"calculate_keyword_density","equals":true},{"field":"enable_content_parsing","equals":true}],"setUsd":0.0054}]},"input":"#/components/schemas/Input_dataforseo_on_page_crawl"},{"id":"dataforseo/on-page-duplicate-content","name":"On Page Duplicate Content","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_duplicate_content"},{"id":"dataforseo/on-page-duplicate-tags","name":"On Page Duplicate Tags","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_duplicate_tags"},{"id":"dataforseo/on-page-force-stop","name":"On Page Force Stop","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_force_stop"},{"id":"dataforseo/on-page-instant-pages","name":"On Page Instant Pages","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.00015,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_on_page_instant_pages"},{"id":"dataforseo/on-page-keyword-density","name":"On Page Keyword Density","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_keyword_density"},{"id":"dataforseo/on-page-lighthouse","name":"On Page Lighthouse","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.005,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_on_page_lighthouse"},{"id":"dataforseo/on-page-links","name":"On Page Links","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_links"},{"id":"dataforseo/on-page-microdata","name":"On Page Microdata","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_microdata"},{"id":"dataforseo/on-page-non-indexable","name":"On Page Non Indexable","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_non_indexable"},{"id":"dataforseo/on-page-page-screenshot","name":"On Page Page Screenshot","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0048,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_on_page_page_screenshot"},{"id":"dataforseo/on-page-pages","name":"On Page Pages","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_pages"},{"id":"dataforseo/on-page-raw-html","name":"On Page Raw Html","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_raw_html"},{"id":"dataforseo/on-page-redirect-chains","name":"On Page Redirect Chains","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_redirect_chains"},{"id":"dataforseo/on-page-resources","name":"On Page Resources","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_resources"},{"id":"dataforseo/on-page-summary","name":"On Page Summary","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_summary"},{"id":"dataforseo/on-page-waterfall","name":"On Page Waterfall","status":"active","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_dataforseo_on_page_waterfall"},{"id":"dataforseo/serp-baidu-organic","name":"Serp Baidu Organic","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_baidu_organic"},{"id":"dataforseo/serp-bing-organic","name":"Serp Bing Organic","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_bing_organic"},{"id":"dataforseo/google-ads-advertisers","name":"Google Ads Transparency: find advertisers by name (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_advertisers"},{"id":"dataforseo/google-ads-search","name":"Google Ads Transparency: ads run by an advertiser (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"depth","gte":41},"addUsd":0.002},{"when":{"field":"depth","gte":81},"addUsd":0.002}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ads_search"},{"id":"dataforseo/google-ai-mode","name":"Google AI Mode answer (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":0.5,"multipliers":[{"when":{"field":"calculate_rectangles","truthy":true},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_ai_mode"},{"id":"dataforseo/serp-google-autocomplete","name":"Serp Google Autocomplete","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_autocomplete"},{"id":"dataforseo/serp-google-dataset-info","name":"Serp Google Dataset Info","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_dataset_info"},{"id":"dataforseo/serp-google-dataset-search","name":"Serp Google Dataset Search","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_dataset_search"},{"id":"dataforseo/serp-google-events","name":"Serp Google Events","status":"listed","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_events"},{"id":"dataforseo/google-finance-explore","name":"Google Finance explore: market overview and news (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"news_type","in":["local_market","world_markets"]},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_finance_explore"},{"id":"dataforseo/google-finance-markets","name":"Google Finance markets: movers, indexes, crypto, currencies (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_finance_markets"},{"id":"dataforseo/google-finance-quote","name":"Google Finance quote for a ticker (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"window","in":["5D","1M","6M","YTD","1Y","5Y","MAX"]},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_finance_quote"},{"id":"dataforseo/google-finance-ticker-search","name":"Google Finance ticker search (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_finance_ticker_search"},{"id":"dataforseo/serp-google-images","name":"Serp Google Images","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_images"},{"id":"dataforseo/serp-google-jobs","name":"Serp Google Jobs","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_jobs"},{"id":"dataforseo/serp-google-local-finder","name":"Serp Google Local Finder","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_local_finder"},{"id":"dataforseo/google-maps","name":"Google Maps search results (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.5,"multipliers":[{"when":{"field":"depth","gte":101},"addUsd":0.002},{"when":{"field":"depth","gte":201},"addUsd":0.002},{"when":{"field":"depth","gte":301},"addUsd":0.002},{"when":{"field":"depth","gte":401},"addUsd":0.002},{"when":{"field":"depth","gte":501},"addUsd":0.002},{"when":{"field":"depth","gte":601},"addUsd":0.002},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_maps"},{"id":"dataforseo/serp-google-news","name":"Serp Google News","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_news"},{"id":"dataforseo/google-organic","name":"Google organic SERP (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":20,"multipliers":[{"when":{"field":"depth","gte":11},"addUsd":0.002},{"when":{"field":"depth","gte":21},"addUsd":0.002},{"when":{"field":"depth","gte":31},"addUsd":0.002},{"when":{"field":"depth","gte":41},"addUsd":0.002},{"when":{"field":"depth","gte":51},"addUsd":0.002},{"when":{"field":"depth","gte":61},"addUsd":0.002},{"when":{"field":"depth","gte":71},"addUsd":0.002},{"when":{"field":"depth","gte":81},"addUsd":0.002},{"when":{"field":"depth","gte":91},"addUsd":0.002},{"when":{"field":"depth","gte":101},"addUsd":0.002},{"when":{"field":"depth","gte":111},"addUsd":0.002},{"when":{"field":"depth","gte":121},"addUsd":0.002},{"when":{"field":"depth","gte":131},"addUsd":0.002},{"when":{"field":"depth","gte":141},"addUsd":0.002},{"when":{"field":"depth","gte":151},"addUsd":0.002},{"when":{"field":"depth","gte":161},"addUsd":0.002},{"when":{"field":"depth","gte":171},"addUsd":0.002},{"when":{"field":"depth","gte":181},"addUsd":0.002},{"when":{"field":"depth","gte":191},"addUsd":0.002},{"addUsdPer":{"field":"max_crawl_pages","usd":0.002,"max":100}},{"when":{"field":"calculate_rectangles","truthy":true},"addUsd":0.002},{"when":{"field":"load_async_ai_overview","truthy":true},"addUsd":0.002},{"when":{"field":"keyword","regex":"\\b(allinanchor|allintext|allintitle|allinurl|define|filetype|id|inanchor|info|intext|intitle|inurl|link|site):"},"totalFactor":5},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):[\\s\\S]*\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_google_organic"},{"id":"dataforseo/serp-google-search-by-image","name":"Serp Google Search By Image","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_google_search_by_image"},{"id":"dataforseo/serp-naver-organic","name":"Serp Naver Organic","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_naver_organic"},{"id":"dataforseo/serp-seznam-organic","name":"Serp Seznam Organic","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.0006,"maxUsdCap":100,"multipliers":[{"when":{"field":"priority","equals":2},"factor":2},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_seznam_organic"},{"id":"dataforseo/serp-yahoo-organic","name":"Serp Yahoo Organic","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.004,"maxUsdCap":100,"multipliers":[{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_serp_yahoo_organic"},{"id":"dataforseo/youtube-search","name":"YouTube search results (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"block_depth","gte":21},"addUsd":0.002},{"when":{"field":"block_depth","gte":41},"addUsd":0.002},{"when":{"field":"block_depth","gte":61},"addUsd":0.002},{"when":{"field":"block_depth","gte":81},"addUsd":0.002},{"when":{"field":"block_depth","gte":101},"addUsd":0.002},{"when":{"field":"block_depth","gte":121},"addUsd":0.002},{"when":{"field":"block_depth","gte":141},"addUsd":0.002},{"when":{"field":"block_depth","gte":161},"addUsd":0.002},{"when":{"field":"block_depth","gte":181},"addUsd":0.002},{"when":{"field":"keyword","regex":"\\b([aA][lL][lL][iI][nN][aA][nN][cC][hH][oO][rR]|[aA][lL][lL][iI][nN][tT][eE][xX][tT]|[aA][lL][lL][iI][nN][tT][iI][tT][lL][eE]|[aA][lL][lL][iI][nN][uU][rR][lL]|[dD][eE][fF][iI][nN][eE]|[fF][iI][lL][eE][tT][yY][pP][eE]|[iI][dD]|[iI][nN][aA][nN][cC][hH][oO][rR]|[iI][nN][fF][oO]|[iI][nN][tT][eE][xX][tT]|[iI][nN][tT][iI][tT][lL][eE]|[iI][nN][uU][rR][lL]|[lL][iI][nN][kK]|[sS][iI][tT][eE]):"},"totalFactor":5}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_youtube_search"},{"id":"dataforseo/youtube-video-comments","name":"YouTube video comments (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.002,"maxUsdCap":0.1,"multipliers":[{"when":{"field":"depth","gte":21},"addUsd":0.002},{"when":{"field":"depth","gte":41},"addUsd":0.002},{"when":{"field":"depth","gte":61},"addUsd":0.002},{"when":{"field":"depth","gte":81},"addUsd":0.002},{"when":{"field":"depth","gte":101},"addUsd":0.002},{"when":{"field":"depth","gte":121},"addUsd":0.002},{"when":{"field":"depth","gte":141},"addUsd":0.002},{"when":{"field":"depth","gte":161},"addUsd":0.002},{"when":{"field":"depth","gte":181},"addUsd":0.002}],"requireCost":true},"input":"#/components/schemas/Input_dataforseo_youtube_video_comments"},{"id":"dataforseo/youtube-video-info","name":"YouTube video details (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.006,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_youtube_video_info"},{"id":"dataforseo/youtube-video-subtitles","name":"YouTube video subtitles, optionally translated (live)","status":"active","pricing":{"model":"reported","costPath":"cost","maxUsdDefault":0.006,"maxUsdCap":100,"requireCost":true},"input":"#/components/schemas/Input_dataforseo_youtube_video_subtitles"},{"id":"leadsforge/account-balance","name":"Get credit balance","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_account_balance"},{"id":"leadsforge/company-followers-filters-countries","name":"Get available countries for company followers filtering","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_company_followers_filters_countries"},{"id":"leadsforge/company-followers-filters-departments","name":"Get available departments for company followers filtering","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_company_followers_filters_departments"},{"id":"leadsforge/company-followers-filters-job-titles","name":"Get available job titles for company followers filtering","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_company_followers_filters_job_titles"},{"id":"leadsforge/company-followers-filters-levels","name":"Get available levels for company followers filtering","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_company_followers_filters_levels"},{"id":"leadsforge/company-followers-filters-states","name":"Get available states for company followers filtering","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_company_followers_filters_states"},{"id":"leadsforge/list-company-followers-jobs","name":"List company followers jobs","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_list_company_followers_jobs"},{"id":"leadsforge/get-company-followers-job","name":"Get company followers job status","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_get_company_followers_job"},{"id":"leadsforge/get-company-followers-results","name":"List company followers results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_get_company_followers_results"},{"id":"leadsforge/search-company-followers","name":"Search company followers","status":"listed","pricing":{"model":"per_unit","amountUsd":0.011125,"unitsPath":"consumedCredits","maxUnits":50000,"maxUnitsField":"limit"},"input":"#/components/schemas/Input_leadsforge_search_company_followers"},{"id":"leadsforge/find-email","name":"Find email (synchronous)","status":"listed","pricing":{"model":"per_unit","amountUsd":0.011125,"unitsPath":"status","unitsValues":{"succeeded":1,"not_found":0,"failed":0},"maxUnits":1},"input":"#/components/schemas/Input_leadsforge_find_email"},{"id":"leadsforge/find-emails-batch","name":"Find emails","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"consumedCredits","usd":0.011125}],"maxUsdDefault":0,"maxUsdCap":5.5625,"multipliers":[{"addUsdPer":{"field":"people","usd":0.011125,"max":500}},{"addUsdPer":{"field":"personIDs","usd":0.011125,"max":500}}],"requireCost":true},"input":"#/components/schemas/Input_leadsforge_find_emails_batch"},{"id":"leadsforge/list-enrichment-jobs","name":"List enrichment jobs","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_list_enrichment_jobs"},{"id":"leadsforge/get-enrichment-job","name":"Get enrichment job","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_get_enrichment_job"},{"id":"leadsforge/get-enrichment-results","name":"List enrichment results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_get_enrichment_results"},{"id":"leadsforge/find-linkedin-batch","name":"Find linkedin profiles","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"consumedCredits","usd":0.011125}],"maxUsdDefault":0,"maxUsdCap":5.5625,"multipliers":[{"addUsdPer":{"field":"people","usd":0.011125,"max":500}},{"addUsdPer":{"field":"personIDs","usd":0.011125,"max":500}}],"requireCost":true},"input":"#/components/schemas/Input_leadsforge_find_linkedin_batch"},{"id":"leadsforge/find-phone","name":"Find phone number (synchronous)","status":"listed","pricing":{"model":"per_unit","amountUsd":0.11124999999999999,"unitsPath":"status","unitsValues":{"succeeded":1,"not_found":0,"failed":0},"maxUnits":1},"input":"#/components/schemas/Input_leadsforge_find_phone"},{"id":"leadsforge/find-phones-batch","name":"Find phone numbers","status":"listed","pricing":{"model":"reported","costPath":"","costTerms":[{"path":"consumedCredits","usd":0.011125}],"maxUsdDefault":0,"maxUsdCap":55.62499999999999,"multipliers":[{"addUsdPer":{"field":"people","usd":0.11124999999999999,"max":500}},{"addUsdPer":{"field":"personIDs","usd":0.11124999999999999,"max":500}}],"requireCost":true},"input":"#/components/schemas/Input_leadsforge_find_phones_batch"},{"id":"leadsforge/lookalikes-filters-departments","name":"Get available departments","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_lookalikes_filters_departments"},{"id":"leadsforge/lookalikes-filters-employee-ranges","name":"Get available employee ranges","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_lookalikes_filters_employee_ranges"},{"id":"leadsforge/lookalikes-filters-locations","name":"Get available lookalikes locations","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_lookalikes_filters_locations"},{"id":"leadsforge/lookalikes-filters-seniorities","name":"Get available seniorities","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_lookalikes_filters_seniorities"},{"id":"leadsforge/preview-lookalike-companies","name":"Preview lookalike companies (free)","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_preview_lookalike_companies"},{"id":"leadsforge/search-lookalike-companies","name":"Search lookalike companies","status":"listed","pricing":{"model":"per_unit","amountUsd":0.011125,"unitsPath":"companies","maxUnits":100,"maxUnitsField":"pageSize"},"input":"#/components/schemas/Input_leadsforge_search_lookalike_companies"},{"id":"leadsforge/search-people","name":"Search","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_people"},{"id":"leadsforge/count-people","name":"Count search results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_count_people"},{"id":"leadsforge/search-filters-company-types","name":"Get search company types","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_company_types"},{"id":"leadsforge/search-filters-departments","name":"Get search departments","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_departments"},{"id":"leadsforge/search-filters-funding-types","name":"Get search funding types","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_funding_types"},{"id":"leadsforge/search-filters-industries","name":"Get search industries","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_industries"},{"id":"leadsforge/search-filters-revenue-ranges","name":"Get search revenue ranges","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_revenue_ranges"},{"id":"leadsforge/search-filters-seniorities","name":"Get search seniorities","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_leadsforge_search_filters_seniorities"},{"id":"icypeas/find-email","name":"Find email","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"items.0.status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_find_email"},{"id":"icypeas/find-email-sync","name":"Find email sync","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_find_email_sync"},{"id":"icypeas/find-emails-batch","name":"Find emails batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":5000,"unitsPath":"files.0.found","requireUnits":true,"unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_find_emails_batch"},{"id":"icypeas/verify-email","name":"Verify email","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0019,"maxUnits":1,"unitsPath":"items.0.status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":1,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":1,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_verify_email"},{"id":"icypeas/verify-email-sync","name":"Verify email sync","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0019,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":1,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":1,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_verify_email_sync"},{"id":"icypeas/verify-emails-batch","name":"Verify emails batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0019,"maxUnits":5000,"unitsPath":"files.0.done","requireUnits":true,"unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_verify_emails_batch"},{"id":"icypeas/scan-domain","name":"Scan domain","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"items.0.status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_scan_domain"},{"id":"icypeas/scan-domain-sync","name":"Scan domain sync","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_scan_domain_sync"},{"id":"icypeas/scan-domains-batch","name":"Scan domains batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":5000,"unitsPath":"files.0.found","requireUnits":true,"unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_scan_domains_batch"},{"id":"icypeas/scrape-profile","name":"Scrape profile","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0285,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_scrape_profile"},{"id":"icypeas/scrape-profiles-batch","name":"Scrape profiles batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0285,"maxUnits":50,"unitsPath":"data","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0},"unitsItemPath":"status","unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_scrape_profiles_batch"},{"id":"icypeas/find-profile-url","name":"Find profile url","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_find_profile_url"},{"id":"icypeas/find-profile-urls-batch","name":"Find profile urls batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":50,"unitsPath":"data","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0},"unitsItemPath":"status","unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_find_profile_urls_batch"},{"id":"icypeas/scrape-company","name":"Scrape company","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0095,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_scrape_company"},{"id":"icypeas/scrape-companies-batch","name":"Scrape companies batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.0095,"maxUnits":50,"unitsPath":"data","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0},"unitsItemPath":"status","unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_scrape_companies_batch"},{"id":"icypeas/find-company-url","name":"Find company url","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_find_company_url"},{"id":"icypeas/find-company-urls-batch","name":"Find company urls batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.019,"maxUnits":50,"unitsPath":"data","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0},"unitsItemPath":"status","unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_find_company_urls_batch"},{"id":"icypeas/count-people","name":"Count people","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_count_people"},{"id":"icypeas/find-people","name":"Find people","status":"listed","pricing":{"model":"per_unit","amountUsd":0.00038,"maxUnits":200,"unitsPath":"leads","requireUnits":true,"maxUnitsField":"pagination.size"},"input":"#/components/schemas/Input_icypeas_find_people"},{"id":"icypeas/count-companies","name":"Count companies","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_count_companies"},{"id":"icypeas/find-companies","name":"Find companies","status":"listed","pricing":{"model":"per_unit","amountUsd":0.00038,"maxUnits":200,"unitsPath":"leads","requireUnits":true,"maxUnitsField":"pagination.size"},"input":"#/components/schemas/Input_icypeas_find_companies"},{"id":"icypeas/reverse-email-lookup","name":"Reverse email lookup","status":"listed","pricing":{"model":"per_unit","amountUsd":0.19,"maxUnits":1,"unitsPath":"status","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0}},"input":"#/components/schemas/Input_icypeas_reverse_email_lookup"},{"id":"icypeas/reverse-email-lookups-batch","name":"Reverse email lookups batch","status":"listed","pricing":{"model":"per_unit","amountUsd":0.19,"maxUnits":50,"unitsPath":"data","requireUnits":true,"unitsValues":{"FOUND":1,"DEBITED":1,"NOT_FOUND":0,"NOT_DEBITED":0,"DEBITED_NOT_FOUND":0,"BAD_INPUT":0,"INSUFFICIENT_FUNDS":0,"ABORTED":0},"unitsItemPath":"status","unitsField":"data","unitsMeasure":"count"},"input":"#/components/schemas/Input_icypeas_reverse_email_lookups_batch"},{"id":"icypeas/get-search-result","name":"Get search result","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_get_search_result"},{"id":"icypeas/get-bulk-results","name":"Get bulk results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_get_bulk_results"},{"id":"icypeas/get-bulk-status","name":"Get bulk status","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_get_bulk_status"},{"id":"icypeas/list-single-search-results","name":"List single search results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_list_single_search_results"},{"id":"icypeas/list-bulk-search-results","name":"List bulk search results","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_list_bulk_search_results"},{"id":"icypeas/list-bulk-files","name":"List bulk files","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_list_bulk_files"},{"id":"icypeas/subscription-information","name":"Subscription information","status":"listed","pricing":{"model":"per_call","amountUsd":0},"input":"#/components/schemas/Input_icypeas_subscription_information"}],"x-toolrouter-billing":{"payments_enabled":false,"topup_fee_model":"added","topup_fee_rate":0.055,"topup_fee_min_usd":0.8,"topup_min_usd":5,"free_runs_per_day_unfunded":50,"free_runs_per_day_funded":1000}}