🚀Quick Start

1. Get your API Key

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

Just contact us at [e-mail] to get your API key and start using our API.

2. Make your first request

To make your first request, send an authenticated request to the /augment endpoint. This will create a new image with annotation preserved, which is nice.

Augments an image

post

Multiply your data preserving annotation

Query parameters

keystringRequired

API Key

modestring · enumOptional

default or high-preserved. Use high-preserved if default doesn't work for you.

Default: defaultPossible values:

pipelinestring · enumOptional

default or customized. Use customized if default doesn't work for you together with strength.

Default: defaultPossible values:

strengthnumber · max: 1Optional

Used with customized pipeline. The greater the value the more an image is augmented.

Default: 0.75

environmentstringOptional

Add some text here like snow on the road, winter to update the environment.

Body

multipart/form-data

imagestring · binaryRequired

Initial image for augmentation

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

422

Validation Error

application/json

post

http://api.kopikat.co/augment

HTTPcURLJavaScriptPython

POST http://api.kopikat.co/augment?key=text HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

{
  "b64image": "text"
}

See Examples to explore the various methods of generating images with Kopikat.