Upload Asset

Upload an asset file and get signed URL for direct upload to cloud storage. Use the returned sign_url to upload your file with a PUT request.

POST /v2/upload/asset

Upload asset file

cURL

curl --request POST \
  --url https://api.jogg.ai/v2/upload/asset \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filename": "product-image.jpg",
  "content_type": "image/jpeg",
  "file_size": 1024000
}
'

import requests

url = "https://api.jogg.ai/v2/upload/asset"

payload = {
    "filename": "product-image.jpg",
    "content_type": "image/jpeg",
    "file_size": 1024000
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({filename: 'product-image.jpg', content_type: 'image/jpeg', file_size: 1024000})
};

fetch('https://api.jogg.ai/v2/upload/asset', 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://api.jogg.ai/v2/upload/asset",
  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' => 'product-image.jpg',
    'content_type' => 'image/jpeg',
    'file_size' => 1024000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.jogg.ai/v2/upload/asset"

	payload := strings.NewReader("{\n  \"filename\": \"product-image.jpg\",\n  \"content_type\": \"image/jpeg\",\n  \"file_size\": 1024000\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://api.jogg.ai/v2/upload/asset")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"product-image.jpg\",\n  \"content_type\": \"image/jpeg\",\n  \"file_size\": 1024000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/upload/asset")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filename\": \"product-image.jpg\",\n  \"content_type\": \"image/jpeg\",\n  \"file_size\": 1024000\n}"

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

200

{
  "code": 0,
  "msg": "Success",
  "data": {
    "sign_url": "<string>",
    "asset_url": "<string>"
  }
}

Upload custom images, videos, or audio files to use in your video projects.

Example Usage

curl --request POST \
  --url 'https://api.jogg.ai/v2/upload/asset' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@/path/to/your/image.jpg' \
  --form 'asset_type=image' \
  --form 'name=Product Photo'

Related Guides

Upload Media Guide

Learn about media uploads

Authorizations

x-api-key · string · header · required

API key for authentication. Obtain your key from the JoggAI dashboard.

Body

application/json

filename · string · required

Name of the file to upload

Example:

"product-image.jpg"

content_type · string · required

MIME type of the file

Example:

"image/jpeg"

file_size · integer

File size in bytes (optional)

Required range: x >= 1

Example:

1024000

Response

200 - application/json

Success

code · integer · required

Business status code:

• 0 - Success
• 10104 - Record not found
• 10105 - Invalid API key
• 18020 - Insufficient credit
• 18025 - No permission to call APIs
• 40000 - Parameter error
• 50000 - System error

Example:

0

msg · string · required

Response message

Example:

"Success"

data · object

Show child attributes