Response envelope - Fibery API

Every call to /api/commands returns a JSON envelope with two keys: success (boolean) and result (the command’s payload on success, the error on failure).

{"success": true, "result": [{"fibery/id": "7dcf4730-82d2-11e9-8a28-82a9c787ee9d", "user/name": "Arthur Dent"}]}

Errors

When success is false, result holds the error:

Key	Description
`name`	Stable error code, safe to switch on.
`message`	Human-readable explanation.
`data`	Error-specific context (e.g. the query, offending field, schema version).

{
  "success": false,
  "result": {
    "name": "entity.error/schema-type-not-found",
    "message": "\"Cricket/Nope\" database was not found.",
    "data": {
      "error/schema-version": 15738,
      "type": "Cricket/Nope",
      "query": {"q/from": "Cricket/Nope", "q/select": ["fibery/id"], "q/limit": 1},
      "params": {},
      "param-types": {},
      "param-collections": null
    }
  }
}

Transport errors

Returned without the success/result envelope — the command never reached the dispatcher.

HTTP	When	Body
`401`	Missing or invalid API token	Plain text `Unauthorized`
`429`	Rate limit exceeded (see Request limits)	Plain text
`500`	Unknown command name, malformed JSON body, or unexpected server error	`{"name": "...", "message": "...", "data": ...}`

​Errors

​Transport errors

Errors

Transport errors