Upload files
curl --request PUT \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form email=bessie@oxen.ai \
--form 'files[]=<binary data>' \
--form 'message=Adding a picture of a cow' \
--form name=bessie \
--form files.items='@example-file' \
--form file.0='@example-file' \
--form file.1='@example-file'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}"
files = {
"files.items": ("example-file", open("example-file", "rb")),
"file.0": ("example-file", open("example-file", "rb")),
"file.1": ("example-file", open("example-file", "rb"))
}
payload = {
"email": "bessie@oxen.ai",
"files[]": "<binary data>",
"message": "Adding a picture of a cow",
"name": "bessie"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('email', 'bessie@oxen.ai');
form.append('files[]', '<binary data>');
form.append('message', 'Adding a picture of a cow');
form.append('name', 'bessie');
form.append('files.items', '{
"fileName": "example-file"
}');
form.append('file.0', '{
"fileName": "example-file"
}');
form.append('file.1', '{
"fileName": "example-file"
}');
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}', 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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"status": "success",
"status_message": "resource_found"
}Files
Upload files
Upload files via multipart form and commit them. Use files[] for directory uploads, or file for a single full-path upload. For backward compatibility, file also uploads into the target directory when {resource} already resolves to a directory.
PUT
/
api
/
repos
/
{namespace}
/
{repo_name}
/
file
/
{resource}
Upload files
curl --request PUT \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form email=bessie@oxen.ai \
--form 'files[]=<binary data>' \
--form 'message=Adding a picture of a cow' \
--form name=bessie \
--form files.items='@example-file' \
--form file.0='@example-file' \
--form file.1='@example-file'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}"
files = {
"files.items": ("example-file", open("example-file", "rb")),
"file.0": ("example-file", open("example-file", "rb")),
"file.1": ("example-file", open("example-file", "rb"))
}
payload = {
"email": "bessie@oxen.ai",
"files[]": "<binary data>",
"message": "Adding a picture of a cow",
"name": "bessie"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('email', 'bessie@oxen.ai');
form.append('files[]', '<binary data>');
form.append('message', 'Adding a picture of a cow');
form.append('name', 'bessie');
form.append('files.items', '{
"fileName": "example-file"
}');
form.append('file.0', '{
"fileName": "example-file"
}');
form.append('file.1', '{
"fileName": "example-file"
}');
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}', 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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbessie@oxen.ai\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D\"\r\n\r\n<binary data>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nAdding a picture of a cow\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nbessie\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"status": "success",
"status_message": "resource_found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Namespace of the repository
Name of the repository
Path of the directory to add files in (including branch)
Body
multipart/form-data
Multipart form for uploading files. Use file for a single full-path upload, or files[] for uploading one or more files into a directory.
Response
Files committed successfully
Show child attributes
Show child attributes
Example:
{
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": ["f1e2d3c4b5a67890fedcba9876543210"],
"timestamp": "2025-01-01T10:00:00Z"
}
⌘I