Generate a presigned upload URL

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/media/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "web-app-manifest-512x512.png",
  "fileType": "image/png"
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/media/"

payload = {
    "fileName": "web-app-manifest-512x512.png",
    "fileType": "image/png"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileName: 'web-app-manifest-512x512.png', fileType: 'image/png'})
};

fetch('https://sandboxapi.kelviq.com/api/v1/media/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/media/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fileName' => 'web-app-manifest-512x512.png',
    'fileType' => 'image/png'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/media/"

	payload := strings.NewReader("{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandboxapi.kelviq.com/api/v1/media/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/media/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "https://kelviq-uploads.s3.amazonaws.com/",
  "fields": {
    "Content-Type": "image/png",
    "key": "tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png",
    "AWSAccessKeyId": "AKIA...",
    "policy": "eyJleHBpcmF0aW9uIjogIjIwMjYtMDUtMjFUMTI6MDA6MDBaIiwgImNvbmRpdGlvbnMiOiBbXX0=",
    "signature": "bWFkZS11cC1zaWduYXR1cmU="
  },
  "fileKey": "tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png"
}

Media

Generate a presigned upload URL

Returns a presigned S3 POST policy that lets you upload a single file directly to kelviq’s storage bucket (max 5 GB, expires in 1 hour). Use the returned fileKey as the value of imageKeys / fileKeys on the catalog product/plan endpoints.

Upload flow:

POST /media/ with fileName and fileType.
Build a multipart/form-data request and send every key/value from fields as a form field, plus a final file field containing the binary.
POST that form to the returned url. A 204 No Content response means the upload succeeded.
Pass fileKey to the relevant catalog endpoint (e.g. POST /catalog/products/ with imageKeys: [fileKey]).

POST

media

Generate a presigned upload URL

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/media/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "web-app-manifest-512x512.png",
  "fileType": "image/png"
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/media/"

payload = {
    "fileName": "web-app-manifest-512x512.png",
    "fileType": "image/png"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileName: 'web-app-manifest-512x512.png', fileType: 'image/png'})
};

fetch('https://sandboxapi.kelviq.com/api/v1/media/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/media/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fileName' => 'web-app-manifest-512x512.png',
    'fileType' => 'image/png'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/media/"

	payload := strings.NewReader("{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandboxapi.kelviq.com/api/v1/media/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/media/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileName\": \"web-app-manifest-512x512.png\",\n  \"fileType\": \"image/png\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "https://kelviq-uploads.s3.amazonaws.com/",
  "fields": {
    "Content-Type": "image/png",
    "key": "tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png",
    "AWSAccessKeyId": "AKIA...",
    "policy": "eyJleHBpcmF0aW9uIjogIjIwMjYtMDUtMjFUMTI6MDA6MDBaIiwgImNvbmRpdGlvbnMiOiBbXX0=",
    "signature": "bWFkZS11cC1zaWduYXR1cmU="
  },
  "fileKey": "tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png"
}

Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Body

application/json

Request a presigned S3 POST policy for uploading a single file (max 5 GB). The returned fileKey is a temporary tmp/<uuid>/<fileName> path that can be passed to product/plan endpoints via imageKeys / fileKeys.

fileName

string

required

Name of the file being uploaded. Used as the suffix of the generated S3 object key.

Example:

"web-app-manifest-512x512.png"

fileType

string

required

MIME type of the file. Enforced by the presigned policy on upload.

Example:

"image/png"

Response

Presigned upload URL generated.

S3 presigned POST policy. Upload the file by sending a multipart/form-data POST to url with every key in fields as a form field, plus a final file field containing the binary. The returned fileKey is what you pass back to kelviq.

url

string<uri>

S3 endpoint to POST the upload to.

Example:

"https://kelviq-uploads.s3.amazonaws.com/"

fields

object

Form fields to include in the multipart/form-data POST (policy, signature, content-type, etc.). Send every field exactly as provided.

Show child attributes

Example:

{
  "Content-Type": "image/png",
  "key": "tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png",
  "AWSAccessKeyId": "AKIA...",
  "policy": "eyJleHBpcmF0aW9uIjogIjIwMjYtMDUtMjFUMTI6MDA6MDBaIiwgImNvbmRpdGlvbnMiOiBbXX0=",
  "signature": "bWFkZS11cC1zaWduYXR1cmU="
}

fileKey

string

Temporary S3 key for the uploaded object. Pass this back to kelviq via imageKeys / fileKeys on the relevant catalog endpoint.

Example:

"tmp/108713b0-1f81-42cf-a16c-c83b1d4d4148/web-app-manifest-512x512.png"

Get Started

API Documentation

Generate a presigned upload URL

Authorizations

Body

Response