Direct upload

Upload a file with multipart/form-data using an API key.

POST /api/v1/uploads

Direct upload

cURL

curl --request POST \
  --url https://upload.autorender.io/api/v1/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'file_name=<string>' \
  --form 'folder=<string>' \
  --form 'tags=<string>' \
  --form 'transform=<string>' \
  --form 'metadata=<string>' \
  --form 'custom_id=<string>' \
  --form 'random_prefix=<string>'

200

{
  "success": true,
  "data": {
    "id": "<string>",
    "file_no": "<string>",
    "name": "<string>",
    "url": "<string>",
    "path": "<string>",
    "width": 123,
    "height": 123,
    "format": "<string>",
    "file_size": 123,
    "workspace_no": "<string>"
  }
}

Overview

POST /api/v1/uploads is the primary upload endpoint for backend services.

Required request

Headers

Header	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	multipart/form-data

Form fields

Field	Required	Description
file	Yes	Binary file payload
file_name	Yes	Final filename in your workspace

Minimal example

curl -X POST \
  https://upload.autorender.io/api/v1/uploads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@./image.jpg" \
  -F "file_name=image.jpg"

Common optional fields

Field	Description
folder	Organize destination path (products/shoes)
tags	Comma-separated labels for filtering
transform	Apply transformation during upload
metadata	JSON object string with custom fields
custom_id	Internal reference ID from your app
random_prefix	Add random suffix to reduce name collisions

Success response shape

{
  "success": true,
  "data": {
    "file_no": "1234567890",
    "name": "image.jpg",
    "url": "https://assets.autorender.io/...",
    "path": "products/image.jpg",
    "format": "jpg",
    "file_size": 102400
  }
}

Error pattern

{
  "success": false,
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

File upload with optional settings

file · file · required

The file to upload (binary data)

file_name · string · required

File name for the uploaded file (e.g., my-image.jpg)

folder · string

Folder path where the file will be stored (e.g., uploads/my-folder)

tags · string

Comma-separated tags (e.g., tag1,tag2,tag3)

transform · string

Image transformation string (e.g., w_800,h_600,q_90)

metadata · string

JSON string for custom metadata (e.g., {"key": "value"})

custom_id · string

Custom identifier for the file

random_prefix · string

Set to "true" to add a random suffix to filename

Response

200

application/json

Upload successful

success · boolean · required

Indicates if the upload was successful

data · object · required

Show child attributes