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 by query

Parameters

query required string

Text search query

styles optional array of string

Coma separated styles

type optional string one of illustrationcomponent

mediaFormat optional string one of pngsvg

Filter by media resources

orderBy optional string default relevant one of relevantrandom

locale optional string default en one of enrufrdeitjpesbrcnko

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

total optional integer

Total number of illustrations matching the query

illustrations optional array of object

List illustrations with filters

Parameters

type optional string one of illustrationcomponent

mediaFormat optional string one of pngsvg

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 latestoldestrandom

locale optional string default en one of enrufrdeitjpesbrcnko

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

total optional integer

Total number of illustrations matching the query

illustrations optional array of object

Get illustration by ID

Parameters

id required string

locale optional string default en one of enrufrdeitjpesbrcnko

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

id optional string

free optional boolean

Whether the illustration is free to use

type optional string

Type of content (illustration, component)

heading optional string

description optional string

author optional object

styles optional array of string

List of style identifiers

categories optional array of string

List of category identifiers

tags optional array of string

List of tag identifiers

mediaResources optional array of string

Available media resources

urls optional object

createdAt optional integer

Unix timestamp of creation

Get high-resolution illustration asset

Parameters

id required string

mediaFormat optional string default png one of pngsvgpng-hd

Responses

200 - High-resolution asset response

Body

url optional string

width optional integer

height optional integer

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

total optional integer

Total number of styles

styles optional array of object

Get paginated tag collection

Parameters

locale optional string default en one of enrufrdeitjpesbrcnko

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

total optional integer

Total number of tags

tags optional array of object

Get hierarchical categories tree

Parameters

locale optional string default en one of enrufrdeitjpesbrcnko

Query and result language

parent_id optional string

Parent category pretty ID

style_pretty_ids optional array of string

Comma separated style pretty IDs

Responses

200 - Hierarchical categories structure

Body

categories optional array of object

Hierarchical list of categories

Ouch API Public v1.0.0

Security definitions

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

Search illustrations

Parameters

Responses

Body

List illustrations

Parameters

Responses

Body

Illustration by id

Parameters

Responses

Body

High-resolution illustration

Parameters

Responses

Body

List styles

Parameters

Responses

Body

List tags

Parameters

Responses

Body

Get categories tree

Parameters

Responses

Body