Getting Started
Prerequisites
Before you begin, ensure you have the following:
- An API key from your Pixie Genie app (sign up at Home)
Authentication
API key is passed on as a Bearer token in the Authorization header for any API request that is being made.
Without API key, you will receive a 401 error with Authorization failure message.
1Authorization: Bearer YOUR_API_KEY
Note: Replace YOUR_API_KEY with your api key.
API endpoint
We only accept JSON content in the body to process the image.
| Attribute | Value |
|---|---|
| Method | POST |
| URL | pixiegenie.saasysoup.com/api/v1/image.png |
| Header | Authorization: Bearer YOUR_API_KEY |
| Body | JSON data |
Validation
If the JSON is not as per the API contract for Image template defined in the API reference, you ll recieve a validation error along with an error message to correct the error.
Error Codes with meaning
We use standard error codes to define any error along with the error message.
Use the following reference to understand more about an error.
Note: Error API calls are not counted as a valid api call and is not counted for billing
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 404 | Not Found -- The specified template could not be found. |
| 405 | Method Not Allowed -- You tried to access an endpoint with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 429 | Too Many Requests -- Too many request! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |