OXoxen
Repositories

Create repository

Create a new repository, optionally with initial files via JSON or multipart form.

post/api/repos

Request

Request body

descriptionstring nullable
hoststring nullable
is_publicboolean nullable
namestring required

The name of the repository. When cloned locally, this is the name of the directory. This name uniquely identifies it in the namespace.

namespacestring required

The namespace that the repository lives in: dictates application-level repository ownership. A namespace can be e.g. a user, a team, or an entire organization. Namespaces must be unique.

namespace_namestring nullable

What the namespace is called, where namespace addresses it by UUID instead. Recorded as a hint beside the identity, ignored by a server that owns its own namespaces, and refused when it is not a valid namespace name.

repo_namestring nullable

What the repository is called, where name addresses it by UUID instead. Recorded as a hint beside the identity, ignored by a server that owns its own namespaces, and refused when it is not a valid repository name.

repo_uuidstring uuid nullable

The immutable UUID to address the new repo's storage by. Supplied by an external control plane that owns repository identity; None leaves the choice to the server.

schemestring nullable
storage_kind'local' | 's3'

Storage backend kind. Serializes as "local" / "s3" on the wire and on disk.

Example request

{
  "root_commit": {
    "author": "ox",
    "email": "ox@example.com",
    "id": "a1b2c3d4e5f67890abcdef1234567890",
    "message": "Refactor data loading pipeline.",
    "parent_ids": [
      "f1e2d3c4b5a67890fedcba9876543210"
    ],
    "timestamp": "2025-01-01T10:00:00Z"
  }
}

Response

Repository created

statusstring required
status_messagestring required

Example response

{
  "repository": {
    "latest_commit": {
      "author": "ox",
      "email": "ox@example.com",
      "id": "a1b2c3d4e5f678902e41",
      "message": "Initial dataset import.",
      "parent_ids": [
        "f1e2d3c4b5a67890fedc"
      ],
      "timestamp": "2025-01-01T10:00:00Z"
    },
    "name": "ImageNet-1k",
    "namespace": "ox"
  },
  "status": "success",
  "status_message": "resource_created"
}

Changes

No recorded changes to this operation across all 1 revision of this API.