Initiate Upload

POST

storage

upload

initiate

Initiate Upload

curl --request POST \
  --url https://api.modelrunner.run/storage/upload/initiate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "<string>",
  "content_type": "<string>",
  "size": 123,
  "relay": true
}
'

import requests

url = "https://api.modelrunner.run/storage/upload/initiate"

payload = {
    "file_name": "<string>",
    "content_type": "<string>",
    "size": 123,
    "relay": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({file_name: '<string>', content_type: '<string>', size: 123, relay: true})
};

fetch('https://api.modelrunner.run/storage/upload/initiate', 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.modelrunner.run/storage/upload/initiate",
  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([
    'file_name' => '<string>',
    'content_type' => '<string>',
    'size' => 123,
    'relay' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.modelrunner.run/storage/upload/initiate"

	payload := strings.NewReader("{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}")

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

	req.Header.Add("Authorization", "<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.modelrunner.run/storage/upload/initiate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modelrunner.run/storage/upload/initiate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}"

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

{
  "upload_url": "<string>",
  "file_url": "<string>",
  "relay_upload_url": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Use the format: Key modelrunner_key

Headers

X-Modelrunner-Object-Lifecycle-Preference

string

JSON object setting an expiry for the stored object, e.g. {"expiration_duration_seconds": 3600}. The countdown starts at upload time. See the data retention guide.

Body

application/json

file_name

string

required

Original filename. Preserved, with a random prefix.

content_type

string

required

MIME type. Send the same value as Content-Type on the PUT.

size

integer

Byte size, for validation.

relay

boolean

Also mint relay_upload_url — a first-party PUT URL on this API host that streams to the same object server-side. For clients whose egress allowlist rejects the raw AWS S3 host.

Response

Presigned upload.

upload_url

string

Presigned S3 PUT URL. Valid 5 minutes. Send no Authorization header — the URL carries its own credentials.

file_url

string

Canonical public URL. Usable as model input once the bytes land.

relay_upload_url

string

Present only when relay: true. Same 5-minute window; PUT the raw bytes here instead if the S3 host is blocked.

Initiate Upload

curl --request POST \
  --url https://api.modelrunner.run/storage/upload/initiate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "<string>",
  "content_type": "<string>",
  "size": 123,
  "relay": true
}
'

import requests

url = "https://api.modelrunner.run/storage/upload/initiate"

payload = {
    "file_name": "<string>",
    "content_type": "<string>",
    "size": 123,
    "relay": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({file_name: '<string>', content_type: '<string>', size: 123, relay: true})
};

fetch('https://api.modelrunner.run/storage/upload/initiate', 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.modelrunner.run/storage/upload/initiate",
  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([
    'file_name' => '<string>',
    'content_type' => '<string>',
    'size' => 123,
    'relay' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.modelrunner.run/storage/upload/initiate"

	payload := strings.NewReader("{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}")

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

	req.Header.Add("Authorization", "<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.modelrunner.run/storage/upload/initiate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modelrunner.run/storage/upload/initiate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"size\": 123,\n  \"relay\": true\n}"

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

{
  "upload_url": "<string>",
  "file_url": "<string>",
  "relay_upload_url": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>"
}

API documentation

Queue API

Platform APIs

Authorizations

Headers

Body

Response