Skip to main content
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"
}
'
{
  "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

​
Authorization
string
header
required

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

Path Parameters

​
namespace
string
required

Namespace of the repository

​
repo_name
string
required

Name of the repository

Body

application/json

Workspace creation details, including base branch and optional name/ID.

​
branch_name
string
required
​
workspace_id
string
required
​
entity_type
string | null
​
force
boolean | null
​
name
string | null
​
resource_path
string | null

Response

Workspace found or created

​
status
string
required
​
status_message
string
required
​
workspace
object
required
​
oxen_version
string | null