Prepare file upload(s)
curl --request POST \
--url http://localhost:8787/v1/upload/prepare \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
[
{
"file_name": "document1.pdf"
},
{
"file_name": "image1.jpg"
},
{}
]
'import requests
url = "http://localhost:8787/v1/upload/prepare"
payload = [{ "file_name": "document1.pdf" }, { "file_name": "image1.jpg" }, {}]
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([{file_name: 'document1.pdf'}, {file_name: 'image1.jpg'}, {}])
};
fetch('http://localhost:8787/v1/upload/prepare', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8787",
CURLOPT_URL => "http://localhost:8787/v1/upload/prepare",
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' => 'document1.pdf'
],
[
'file_name' => 'image1.jpg'
],
[
]
]),
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 := "http://localhost:8787/v1/upload/prepare"
payload := strings.NewReader("[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\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("http://localhost:8787/v1/upload/prepare")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\n]")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8787/v1/upload/prepare")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\n]"
response = http.request(request)
puts response.read_body[
{
"key": "org-id/document1.pdf",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/document1.pdf",
"upload_id": "123e4567-e89b-12d3-a456-426614174000"
},
{
"key": "org-id/image1.jpg",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/image1.jpg",
"upload_id": "223e4567-e89b-12d3-a456-426614174001"
}
]{
"error": "Validation failed",
"fields": {}
}{
"error": "API key required"
}{
"error": "Organization not found"
}{
"error": "Too many requests, please try again later",
"retryAfter": 123
}{
"error": "Internal server error"
}Upload
Prepare file upload(s)
Creates presigned URLs for one or more file uploads to Filejar storage. Processes multiple files in parallel. Requires API key authentication.
POST
/
v1
/
upload
/
prepare
Prepare file upload(s)
curl --request POST \
--url http://localhost:8787/v1/upload/prepare \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
[
{
"file_name": "document1.pdf"
},
{
"file_name": "image1.jpg"
},
{}
]
'import requests
url = "http://localhost:8787/v1/upload/prepare"
payload = [{ "file_name": "document1.pdf" }, { "file_name": "image1.jpg" }, {}]
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([{file_name: 'document1.pdf'}, {file_name: 'image1.jpg'}, {}])
};
fetch('http://localhost:8787/v1/upload/prepare', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8787",
CURLOPT_URL => "http://localhost:8787/v1/upload/prepare",
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' => 'document1.pdf'
],
[
'file_name' => 'image1.jpg'
],
[
]
]),
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 := "http://localhost:8787/v1/upload/prepare"
payload := strings.NewReader("[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\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("http://localhost:8787/v1/upload/prepare")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\n]")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8787/v1/upload/prepare")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"file_name\": \"document1.pdf\"\n },\n {\n \"file_name\": \"image1.jpg\"\n },\n {}\n]"
response = http.request(request)
puts response.read_body[
{
"key": "org-id/document1.pdf",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/document1.pdf",
"upload_id": "123e4567-e89b-12d3-a456-426614174000"
},
{
"key": "org-id/image1.jpg",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/image1.jpg",
"upload_id": "223e4567-e89b-12d3-a456-426614174001"
}
]{
"error": "Validation failed",
"fields": {}
}{
"error": "API key required"
}{
"error": "Organization not found"
}{
"error": "Too many requests, please try again later",
"retryAfter": 123
}{
"error": "Internal server error"
}Authorizations
WorkOS API key for authentication
Body
application/json
Optional file name. If not provided, a random UUID will be used.
Required string length:
1 - 255Example:
"my-file.pdf"
Example:
[
{ "file_name": "document1.pdf" },
{ "file_name": "image1.jpg" },
{}
]
Response
Upload preparation successful
File key/path in storage
Example:
"org-id/filename.pdf"
Proxy URL for uploading files through the API (PUT request to /v1/files/{key})
Example:
"https://core-api.filejar-dev.workers.dev/v1/files/org-id/filename.pdf"
Unique identifier for this upload
Example:
[
{
"key": "org-id/document1.pdf",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/document1.pdf",
"upload_id": "123e4567-e89b-12d3-a456-426614174000"
},
{
"key": "org-id/image1.jpg",
"signed_url": "https://core-api.filejar-dev.workers.dev/v1/files/org-id/image1.jpg",
"upload_id": "223e4567-e89b-12d3-a456-426614174001"
}
]
Was this page helpful?
⌘I