Documentation

For any endpoint you want to use, you must find the effects you like from our list. Once you have the ids for the effects you want, you can call one of our many APIs.

Realtime API

Somatic's image conversion system has been made to easily integrate into your workflow and software, in as lightweight a way as possible.

If you are using image conversion in a website or web enabled tool, you don't need to code anything to convert an image.

For example, on a website your images are displayed with the html tag img:

<img src="https://media-api.theknot.com/images/37b5db94-520d-4a34-b294-0f280190652c">

If you wanted to transform those images with our effects, all you would do is change the image url to our site and we convert the image in real time:

<img src="http://convert.somatic.io/api/v1.2/cdn-query?id=MZJPOVkY&api_key=YOUR_API_KEY&--input=https://media-api.theknot.com/images/37b5db94-520d-4a34-b294-0f2 80190652c">

That is all it takes.

Implementation is as lightweight as possible — and should eliminate or greatly reduce the typical headache associated with building out 3rd party features.

If you want to integrate our image effects at a deeper level, we have APIs that integrate with any programming language that supports http calls.

For example, from the command line, to do an image transformation, you could just run:


Asynchronous API

We have APIs that integrate with somatic in a async way, any programming language that supports http calls can use this API.

You can pass webhook=URL as a parameter and when the processing is a complete, we will send you a webhook notification

For example, from the command line, to do an image transformation, you could just run:

  curl --fail -X POST \
     -F --input=@/PATH/TO/IMAGE/HERE \
     -F -image_size=1200 \
     -F id=7ZxlV2Z9 \
     -F api_key=YOUR_API_KEY \
  http://www.somatic.io/api/v1/models/async_query
Remember image_size can be set to as high as 2560
We recommend you use numbers 1200 or lower for previews and mobile experiences
Use higher numbers for final preview and actual submission for custom printing

We have other APIs to do image processing in batch mode. We are in the process of making native SDKs for iOS and Android, but web calls should satisfy most use cases.

Integrations

We have many integrations with different frameworks and libraries, you can see them here

Make your own special effects

We can help you create your own special effects in several ways, Read more here

Browse all of our effects