Get or create workspace
curl --request PUT \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"branch_name": "main",
"name": "bessie_workspace",
"workspace_id": "b3f27f05-0955-4076-805f-39575853b27b"
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create"
payload = {
"branch_name": "main",
"name": "bessie_workspace",
"workspace_id": "b3f27f05-0955-4076-805f-39575853b27b"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
branch_name: 'main',
name: 'bessie_workspace',
workspace_id: 'b3f27f05-0955-4076-805f-39575853b27b'
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create', 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/get_or_create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'branch_name' => 'main',
'name' => 'bessie_workspace',
'workspace_id' => 'b3f27f05-0955-4076-805f-39575853b27b'
]),
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/get_or_create"
payload := strings.NewReader("{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
},
"oxen_version": "<string>"
}Workspaces
Get or create workspace
Create a workspace. If the workspace exists, return it
PUT
/
api
/
repos
/
{namespace}
/
{repo_name}
/
workspaces
/
get_or_create
Get or create workspace
curl --request PUT \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"branch_name": "main",
"name": "bessie_workspace",
"workspace_id": "b3f27f05-0955-4076-805f-39575853b27b"
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create"
payload = {
"branch_name": "main",
"name": "bessie_workspace",
"workspace_id": "b3f27f05-0955-4076-805f-39575853b27b"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
branch_name: 'main',
name: 'bessie_workspace',
workspace_id: 'b3f27f05-0955-4076-805f-39575853b27b'
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create', 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/get_or_create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'branch_name' => 'main',
'name' => 'bessie_workspace',
'workspace_id' => 'b3f27f05-0955-4076-805f-39575853b27b'
]),
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/get_or_create"
payload := strings.NewReader("{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/workspaces/get_or_create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"branch_name\": \"main\",\n \"name\": \"bessie_workspace\",\n \"workspace_id\": \"b3f27f05-0955-4076-805f-39575853b27b\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
},
"oxen_version": "<string>"
}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
Body
application/json
Workspace creation details, including base branch and optional name/ID.
⌘I