Products

Ouch API v1.0.0

This is a public version of the Ouch API.

#

Security definitions

You can authenticate using one of the following methods:

  • An Api-Key header. For example, Api-Key: YOUR_API_KEY.
  • A token query parameter. For example, if you want to make a request to a resource with URL /endpoint, you can specify your key as /endpoint?token=YOUR_API_KEY

Make sure that each request you perform includes your API key in one of the specified formats. Otherwise, the request will fail.

#

Search illustrations



Get list of illustrations by query

#

Parameters

query required string

Text search query


styles optional array of string

Coma separated styles


type optional string one of illustration​component​


mediaFormat optional string one of png​svg​

Filter by media resources


orderBy optional string default relevant one of relevant​random​


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


fields optional string default id,mediaResources,urls

Return only specified fields. Example: "id,mediaResources,urls(thumb)". Please request only needed fields.


#

Responses

200 - Search illustrations
#

Body

total optional integer


illustrations optional array of object


id optional string


free optional boolean


type optional string


heading optional string


description optional string


author optional object


icons8_id optional string


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


mediaResources optional string


urls optional object


thumb optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



small optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



medium optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



large optional



created_at optional integer



#

List illustrations



Get list of illustrations

#

Parameters

type optional string one of illustration​component​


mediaFormat optional string one of png​svg​

Filter by media resources


author optional string


styles optional array of string

Coma separated styles


categories optional array of string

Coma separated categories


tags optional array of string

Coma separated tags


orderBy optional string default latest one of latest​oldest​random​


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


fields optional string default id,mediaResources,urls

Return only specified fields. Example: "id,mediaResources,urls(thumb)". Please request only needed fields.


#

Responses

200 - List illustrations
#

Body

total optional integer


illustrations optional array of object


id optional string


free optional boolean


type optional string


heading optional string


description optional string


author optional object


icons8_id optional string


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


mediaResources optional string


urls optional object


thumb optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



small optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



medium optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



large optional



created_at optional integer



#

High-resolution illustration



Get a link to a high resolution asset of illustration

#

Parameters

id required string

ID


mediaFormat optional string default png one of png​svg​png-hd​


#

Responses

200 - High-resolution illustration
#

Body

width optional integer


height optional integer


url optional string


filesize optional integer


#

Illustration by id



Get illustration by id

#

Parameters

id required string

ID


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


fields optional string default id,mediaResources,urls

Return only specified fields. Example: "id,mediaResources,urls(thumb)". Please request only needed fields.


#

Responses

200 - Illustration by id
#

Body

id optional string


free optional boolean


type optional string


heading optional string


description optional string


author optional object


icons8_id optional string


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


mediaResources optional string


urls optional object


thumb optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



small optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



medium optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



large optional



created_at optional integer


#

List styles



Get list of styles

#

Parameters

fields optional string default id,mediaResources,urls

Return only specified fields. Example: "id,mediaResources,urls(thumb)". Please request only needed fields.


#

Responses

200 - List styles
#

Body

total optional integer


styles optional array of object


id optional string


pretty_id optional string


title optional string


primaryColor optional string


secondaryColor optional string


backgroundColor optional string


description optional string


icon optional object

Asset model


width optional integer


height optional integer


url optional string


filesize optional integer



animated optional boolean


allow_request optional boolean


free_distribution optional boolean


generator optional boolean


totalIllustrationCount optional integer


thumb1x optional


thumb2x optional



#

List tags



Get list of tags

#

Parameters

locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


fields optional string default id,mediaResources,urls

Return only specified fields. Example: "id,mediaResources,urls(thumb)". Please request only needed fields.


#

Responses

200 - List tags
#

Body

total optional integer


tags optional array of object


title optional string


illustrationsCount optional integer



#

Get categories tree



Get full tree of categories

#

Parameters

locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


#

Responses

200 - Get categories tree
#

Body

categories optional array of object


title optional string


illustrationsCount optional integer


children optional array of