Stage files to workspace

Stage file nodes to a workspace. Do not upload file contents to the repository.

POST /api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}

Stage files to workspace

cURL

curl --request POST \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "path": "images/train/dog.jpg"
  }
]
'

import requests

url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}"

payload = [
    {
        "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "path": "images/train/dog.jpg"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      hash: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
      path: 'images/train/dog.jpg'
    }
  ])
};

fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}', 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}/workspaces/{workspace_id}/files/batch/{directory}",
  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([
    [
        'hash' => 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
        'path' => 'images/train/dog.jpg'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}"

	payload := strings.NewReader("[\n  {\n    \"hash\": \"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\",\n    \"path\": \"images/train/dog.jpg\"\n  }\n]")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"hash\": \"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\",\n    \"path\": \"images/train/dog.jpg\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/{workspace_id}/files/batch/{directory}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"hash\": \"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\",\n    \"path\": \"images/train/dog.jpg\"\n  }\n]"

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

200

{
  "status": "<string>",
  "status_message": "<string>",
  "oxen_version": "<string>",
  "err_files": [
    {
      "error": "<string>",
      "hash": "<string>",
      "path": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

namespace · string · required

The namespace of the repository

repo_name · string · required

The name of the repository

workspace_id · string · required

The UUID of the workspace

directory · string · required

The directory to stage the files into

Query Parameters

update_timestamp · boolean

Force staging even if file content has not changed, updating the file timestamp

Body

application/json

List of files and their pre-calculated hashes (must exist in version store).

hash · string · required

path · string · required

Response

200

application/json

Files staged successfully

status · string · required

status_message · string · required

oxen_version · string | null

err_files · object[]

Show child attributes