🚀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 · enum · default: "default"optional

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

Available options:

pipelinestring · enum · default: "default"optional

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

Available options:

strengthnumber · max: 1 · default: 0.75optional

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

environmentstringoptional

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

Body

imagestring · binaryrequired

Initial image for augmentation

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://api.kopikat.co/augment?key=text' \
  --header 'Content-Type: multipart/form-data' \
  --form 'image=binary'

200

401

422

200

{
  "b64image": "text"
}

Successful Response

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