API Reference
The Supportivekoala API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Log in to see docs customized to your version of the API
https://api.supportivekoala.com
Authentication
You can register your account or use a request to a server in order to obtain the API KEY
Supportivekoala uses API keys to authenticate requests. You can view and manage your API keys in the your profile page
POST /v1/auth/register
1curl --request POST 'https://api.supportivekoala.com/v1/auth/register' \
2--header 'Content-Type: application/json' \
3--data-raw '{"email": "Your email", "password": "your password"}'
Images
This object is the result after manipulation of the template
Images
Attributes
template required
Template ID - how image will be created. You can seeall public templates here
Paramsoptional
List of parameters that will populate template's object
formatoptional
Image file formats
Possible values. PNG is a default format for all requests
png
jpeg
webp
The image object
1{
2 "_id": "61191cc2b37c2d973424f319",
3 "template": "61155339498bb719fdad3650",
4 "imageUrl": "https://cloud.supportivekoala.com/3361663f-d1fd-4a26-a1aa-75aa155e5fa7.png",
5 "createdAt": "2021-08-15T13:55:14.712Z",
6 "updatedAt": "2021-08-15T13:55:14.712Z",
7}
Create an image
Create an images based of parameters
Parameters
template required
Template ID - how image will be created. You can seeall templates here
Paramsoptional
List of parameters that will populate template's object
formatoptional
Image file formats
Possible values. PNG is a default format for all requests
png
jpeg
webp
Returns
The newly created Image
object, if the call succeeded. If the attempted fails, error message will return
POST /v1/images/
1curl --location --request POST 'https://api.supportivekoala.com/v1/images/' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer 'Your bearer token'\
4--data-raw '{"template":"61ce63fe5bbbc920d0038182"}'
Response
1{
2 "_id": "61158cbcb18087773138fc55",
3 "template": "61ce63fe5bbbc920d0038182",
4 "imageUrl": "https://cloud.supportivekoala.com/3361663f-d1fd-4a26-a1aa-75aa155e5fa7.png",
5 "createdAt": "2021-08-12T21:03:56.769Z",
6 "updatedAt": "2021-08-12T21:03:56.769Z",
7 "__v": 0
8}
Retrieve an image
Retrieves the image with the given ID.
Parameters
No parameters.
Returns
Returns the image object.
GET /v1/images/:id
1curl --location --request GET 'https://api.supportivekoala.com/v1/images/:id' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer 'Your bearer token'\
4
Response
1{
2 "_id": "61158cbcb18087773138fc55",
3 "template": "61ce63fe5bbbc920d0038182",
4 "imageUrl": "https://cloud.supportivekoala.com/3361663f-d1fd-4a26-a1aa-75aa155e5fa7.png",
5 "createdAt": "2021-08-12T21:03:56.769Z",
6 "updatedAt": "2021-08-12T21:03:56.769Z",
7 "__v": 0
8}
Retrieve images
Retrieves all the image that user have.
Parameters
No parameters.
Returns
Returns the image object.
GET /v1/images
1curl --location --request GET 'https://api.supportivekoala.com/v1/images' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer 'Your bearer token'\
4
Response
1[{
2 "_id": "61158cbcb18087773138fc55",
3 "template": "61ce63fe5bbbc920d0038182",
4 "imageUrl": "https://cloud.supportivekoala.com/3361663f-d1fd-4a26-a1aa-75aa155e5fa7.png",
5 "createdAt": "2021-08-12T21:03:56.769Z",
6 "updatedAt": "2021-08-12T21:03:56.769Z",
7 "__v": 0
8}]
Templates
This object describes how an image will look like and what kind of transformation you can do
Create an template
Parameters
name
Template name
Paramsoptional
List of parameters how images can be generated
Widthoptional, default is 1000
Width of the template
Heightoptional, default is 1000
Height of the template
Returns
The newly created Template
object, if the call succeeded. If the attempted fails, error message will return
POST /v1/templates/
1curl --location --request POST 'https://api.supportivekoala.com/v1/templates/' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer 'Your bearer token'\
4--data-raw '{"template":"61ce63fe5bbbc920d0038182"}'
Response
1{
2 "generatedImages": [],
3 "width": 1000,
4 "height": 1000,
5 "params": [],
6 "_id": "6145cb523b21e9a89906fa21",
7 "owner": "6114ffec9c7eabb164873cda",
8 "ownerEmail": "maxmax@gmail.com",
9 "imageUrl": "https://cloud.supportivekoala.com/b4bc28ca-f0ac-41c4-b090-756494648d51.png",
10 "createdAt": "2021-09-18T11:19:47.469Z",
11 "updatedAt": "2021-09-18T11:19:47.469Z",
12 "__v": 0
13}