Products

Ouch API Public v1.0.0

Public API for accessing illustrations, styles, tags, and categories

#

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



Search 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 - Paged illustrations response
#

Body

body optional


#

List illustrations



List illustrations with filters

#

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 - Paged illustrations response
#

Body

body optional


#

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 - Single illustration response
#

Body

body optional


#

High-resolution illustration



Get high-resolution illustration asset

#

Parameters

id required string

ID


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


#

Responses

200 - High-resolution asset response
#

Body

body optional


#

List styles



Get available illustration 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 - Paged styles response
#

Body

body optional


#

List tags



Get paginated tag collection

#

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 - Paged tags response
#

Body

body optional


#

Get categories tree



Get hierarchical categories tree

#

Parameters

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

Query and result language


#

Responses

200 - Hierarchical categories structure
#

Body

body optional