A failure answers an HTTP error status with the object below. Branch on error.code; the errors guide says what each code means and what to do about it.
The Error object
Every field sits under error.
error.codestringrequiredStable code to branch on. The table below lists every code by status.
error.messagestringrequiredWhat happened, in one or two plain sentences.
error.next_stepstringWhat to do now, in one sentence.
error.doc_urlstringThis code’s entry in the errors guide (a policy refusal: the policy).
error.request_idstringThe X-Request-Id of this request: quote it to support.
error.reasonstringA finer cause when one helps: site_rate_limited, spend_limit, stopped, build_ended, body_too_large, sign_in_busy, step_expired, or (request_refused) the request check’s verdict: explicit, harmful or platform_probe.
error.retryablebooleanOn a failed run: whether trying again can help (a block, a slow or failing site).
error.may_have_runbooleanA method with side effects failed after its request reached the site: check the site before running it again.
error.retry_afterintegerSeconds to wait before trying again: the plan’s (rate_limited, with Retry-After), Fous’s (service_unavailable) or the site’s, when it said.
error.paramstringThe parameter at fault: input.<name> for an input, method for a method.
error.errorsarray of objectinvalid_input: every input that does not fit, all at once. A required input that a misspelled name was meant for is listed as missing too; the message counts the two once. invalid_request on a workflow: each problem in its definition or a run’s input, at its path (steps[2].input.query).
error.methodstringinvalid_input: the method whose inputs these are.
error.input_schemaobjectinvalid_input: the method’s own input_schema, exactly as stored.
error.exampleJSON valueinvalid_input: a call that fits ({method, input}), from the method’s saved example (a write method’s is built from its schema). not_buildable: a request phrased so it can be built.
error.did_you_meanstringnot_found: the method slug it most likely meant.
error.suggestionsarray of objectnot_found: methods close to the name ({id, slug, name, summary}).
error.alternativesarray of objectmethod_repairing: methods that do the same.
error.versionintegermethod_repairing: the version under repair.
error.latest_versionintegermethod_repairing: the method’s newest version; not_found for a version: the newest one there is.
error.repairobjectmethod_repairing: when the version is expected back.
Show child attributesHide child attributes
expected_atstringback_in_minutesinteger
error.connectobjectconnection_required: the site and connection type to connect, and connection_id when your organization already has a connection for the site.
Show child attributesHide child attributes
sitestringtypestringsessionapi_keyconnection_idstringstatusstringThe status of your connection, when you have one.
pendingactiveneeds_attention
error.connect_urlstringconnection_required: the Fous Studio page where a person connects the account (your connection for the site, or a new one). A login also signs in with POST /v1/connections/{id}/sign-in.
error.billing_urlstringinsufficient_credits: where to get more (on Free: choose a plan, or wait for next month’s free credits; on Starter, Pro and Business: turn on extra credits or raise their monthly limit); plan_limit: where to change plans.
error.available_creditsnumberinsufficient_credits: the credits the organization has left.
error.required_creditsintegerinsufficient_credits: what the run costs, in credits.
error.spend_limitobjectinsufficient_credits with reason spend_limit: the monthly limit, what was spent, in credits, and when it resets.
Show child attributesHide child attributes
limitnumberspentnumberresets_atstring
error.limit_creditsnumberinsufficient_credits with reason spend_limit: spend_limit.limit.
error.spent_creditsnumberinsufficient_credits with reason spend_limit: spend_limit.spent.
error.limitobjectrate_limited or plan_limit: the plan limit met, and its value when the plan sets one. plan_limit kinds: logins (saved logins), sites (sites with methods), builds (Free’s 3 builds), api (on Free: a build started with a key or MCP, or a schedule or webhook), chat_messages (Free’s AI messages: chats, workflows from a prompt, transforms’ code; with plan: the plan to move to). next_step says the one step that raises the limit: an add-on on Pro and Business, else the plan with more. rate_limited kinds: requests_per_minute, concurrent_runs, searches_per_minute, ai_per_minute (workflow AI calls a minute), chat_per_minute (chat messages a minute), concurrent_builds (builds running at once).
Show child attributesHide child attributes
kindstringrequests_per_minuteconcurrent_runssearches_per_minuteloginssitesbuildsapichat_messageschat_per_minuteemail_recipientsconcurrent_buildsvalueinteger
error.run_idstringThe failed run (failures are free).