Skip to content
FousDocs
Open Studio

Errors

The error object every failure returns, and the error codes each HTTP status carries.

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.codestringrequired

    Stable code to branch on. The table below lists every code by status.

  • error.messagestringrequired

    What happened, in one or two plain sentences.

  • error.next_stepstring

    What to do now, in one sentence.

  • error.doc_urlstring

    This code’s entry in the errors guide (a policy refusal: the policy).

  • error.request_idstring

    The X-Request-Id of this request: quote it to support.

  • error.reasonstring

    A 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.retryableboolean

    On a failed run: whether trying again can help (a block, a slow or failing site).

  • error.may_have_runboolean

    A method with side effects failed after its request reached the site: check the site before running it again.

  • error.retry_afterinteger

    Seconds 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.paramstring

    The parameter at fault: input.<name> for an input, method for a method.

  • error.errorsarray of object

    invalid_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.methodstring

    invalid_input: the method whose inputs these are.

  • error.input_schemaobject

    invalid_input: the method’s own input_schema, exactly as stored.

  • error.exampleJSON value

    invalid_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_meanstring

    not_found: the method slug it most likely meant.

  • error.suggestionsarray of object

    not_found: methods close to the name ({id, slug, name, summary}).

  • error.alternativesarray of object

    method_repairing: methods that do the same.

  • error.versioninteger

    method_repairing: the version under repair.

  • error.latest_versioninteger

    method_repairing: the method’s newest version; not_found for a version: the newest one there is.

  • error.repairobject

    method_repairing: when the version is expected back.

    Show child attributes
    • expected_atstring
    • back_in_minutesinteger
  • error.connectobject

    connection_required: the site and connection type to connect, and connection_id when your organization already has a connection for the site.

    Show child attributes
    • sitestring
    • typestring

      sessionapi_key

    • connection_idstring
    • statusstring

      The status of your connection, when you have one.

      pendingactiveneeds_attention

  • error.connect_urlstring

    connection_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_urlstring

    insufficient_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_creditsnumber

    insufficient_credits: the credits the organization has left.

  • error.required_creditsinteger

    insufficient_credits: what the run costs, in credits.

  • error.spend_limitobject

    insufficient_credits with reason spend_limit: the monthly limit, what was spent, in credits, and when it resets.

    Show child attributes
    • limitnumber
    • spentnumber
    • resets_atstring
  • error.limit_creditsnumber

    insufficient_credits with reason spend_limit: spend_limit.limit.

  • error.spent_creditsnumber

    insufficient_credits with reason spend_limit: spend_limit.spent.

  • error.limitobject

    rate_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 attributes
    • kindstring

      requests_per_minuteconcurrent_runssearches_per_minuteloginssitesbuildsapichat_messageschat_per_minuteemail_recipientsconcurrent_builds

    • valueinteger
  • error.run_idstring

    The failed run (failures are free).