API Response Format

The Plasticity developer HTTP APIs return JSON-formatted outputs.

Response Header Format

HeaderValue
Content-Typeapplication/json

Response Status Codes

Status CodeValue
200Indicates a successful response.
400Indicates an invalid request error.
401Indicates anauthentication error.
402Indicates the free tier for the API has been reached andpayment information must be entered to continue usage.
404Indicates the path requested at the API endpoint does not exist.
429Indicates anrate limiting error.
5xxIndicates an internal server error.

Success Response Format

1{
2  "error": "false",
3  "data": { ... }
4}

Error Response Format

1{
2  "error": "true",
3  "errorCode": XXX,
4  "message": "A message describing the error will appear here."
5}