Errors

HTTP status codes used by the API.

Ploi uses standard HTTP status codes to indicate the success or failure of requests.

CodeDescription
200Success - Request completed successfully
201Created - Resource was successfully created
422Validation Error - Request parameters failed validation
429Too Many Requests - Rate limit exceeded
500Server Error - An internal error occurred
503Maintenance - We are performing maintenance

Subscription Error

If you are not on a paid subscription, you will receive the following response:

Subscription Required

{
  "error": "You are on a free plan, therefore you cannot use this API.",
  "links": [
    "https://ploi.io/profile/subscription",
    "https://ploi.io/pricing"
  ]
}