Message Format

The Fast API uses JSON-formatted messages for all communication.

All requests follow a consistent structure:

Code
 
{
  "id": "1",
  "method": "METHOD_NAME",
  "params": {...}
}

Field	Type	Required	Description
`id`	string	Yes	Unique identifier for matching request/response
`method`	string	Yes	The method to invoke
`params`	object \| array	No	Method parameters (varies by method)

Successful responses include the request ID and result:

Code
 
{
  "id": "1",
  "status": 200,
  "result": {...}
}

Field	Type	Description
`id`	string	Matches the request ID
`status`	number	HTTP status code
`result`	any	Method-specific response data

Error responses include error details:

Code
 
{
  "id": "1",
  "status": 401,
  "error": {
    "code": -1002,
    "msg": "Authentication required"
  }
}

Field	Type	Description
`id`	string	Matches the request ID
`status`	number	HTTP status code
`error.code`	string	Internal error code
`error.msg`	string	Human-readable error message

Last modified on October 1, 2025