# Oxen.ai > Oxen.ai is the platform for building AI on your own data. Use 200+ models through one API, version your datasets at scale, and fine-tune custom models. ## Docs - [Model API References](https://oxenai-regenerate-model-docs.mintlify.site/inference-api/reference/model-references.md): Browse the full list of models available in the Oxen.AI inference API. - [Merge a commit into a branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/merge-a-commit-into-a-branch.md): Merge a client commit into a branch during push. Returns merge commit on success, or original server commit if conflicts occur. - [Get an existing branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/get-an-existing-branch.md): Get a branch by name, returning its details and current commit. - [Update a branch to a new commit](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/update-a-branch-to-a-new-commit.md): Update a branch to point to a different commit ID. - [Delete a branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/delete-a-branch.md): Force delete a branch by name. - [Get all versions of a file on a branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/get-all-versions-of-a-file-on-a-branch.md): List paginated historical versions of a file across commits on a branch, including schema hash for tabular files. - [List all branches](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/list-all-branches.md): List all branches in the repository with their current commit information. - [Create a new branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/branches/create-a-new-branch.md): Create a new branch from another branch name or commit ID. Returns existing branch if name already exists. - [Upload commits DB](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/upload-commits-db.md): Upload the commits database tarball to the server during push. - [Download commits DB](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/download-commits-db.md): Download the commits database as a compressed tarball for cloning. - [Upload data chunk](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/upload-data-chunk.md): Upload a chunk of file data for use in large file uploads. - [Notify upload complete](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/notify-upload-complete.md): Notify the server that the commit has finished uploading. - [Mark commits as synced](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/mark-commits-as-synced.md): DEPRECATED - This operation is a no-op that echoes the hashes from the request. Removed in 0.59.0; the Oxen client stopped calling it in 0.54.0. - [Get root commit](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/get-root-commit.md): Get the root (initial) commit of the repository, or None if empty. - [Get commit](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/get-commit.md): Get details of a specific commit by its ID. - [Download commit entries DB](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/download-commit-entries-db.md): Download the commit entries database for a specific commit as a tarball. - [Upload commit](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/upload-commit.md): Upload a commit to a branch on the server. This creates an empty commit. Its merkle tree nodes are uploaded separately through the tree nodes endpoint. - [List commit history](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/list-commit-history.md): List paginated commit history for a revision or file path. Supports revision ranges (base..head) and path-specific history. - [List missing commits](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/list-missing-commits.md): From a list of commit hashes, list the ones not present on the server - [List missing files from commits](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/list-missing-files-from-commits.md): List files that are referenced in a commit but not present on the server. Accept a commit range. - [List all commits](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/list-all-commits.md): List all commits in a repository - [Download dir hashes DB](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/download-dir-hashes-db.md): Download directory hashes database for a commit range as a tarball. - [Get a commit's parents](https://oxenai-regenerate-model-docs.mintlify.site/http-api/commits/get-a-commits-parents.md): Get the parent commits of a specific commit or the tip of a branch. - [Get Derived Data Frame](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/get-derived-data-frame.md): Get the derived diff data frame rows with pagination and optional filtering. - [List changed files](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/list-changed-files.md): List the files and sub-directories within a directory that have changed within a provided commit range. - [Get file diff](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/get-file-diff.md): Get the detailed diff for a specific file between two revisions. - [Get diff tree](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/get-diff-tree.md): Get a tree structure of directories that have changed between two revisions. - [List file and directory entries changed between base and head](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/list-file-and-directory-entries-changed-between-base-and-head.md): List paginated entries (files and directories) that changed between two revisions with change counts. - [List commits between two revisions](https://oxenai-regenerate-model-docs.mintlify.site/http-api/compare/list-commits-between-two-revisions.md): List commits between a 'base' and 'head' commit. Two dots list what head added; three dots list the commits on either side but not both, each tagged with the side it came from. - [Export resource as a zip](https://oxenai-regenerate-model-docs.mintlify.site/http-api/export/export-resource-as-a-zip.md): Download a directory as a zip archive. Subject to size limits. - [Get repository stats](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/get-repository-stats.md): Get the total number of files, the total size of the files, and the number of different file types. - [List repositories](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/list-repositories.md): List all repositories in a namespace. - [Transfer repository namespace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/transfer-repository-namespace.md): Transfer a repository to a different namespace. - [Get repository size](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/get-repository-size.md): Get the cached size of the repository in bytes. - [Update repository size](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/update-repository-size.md): Recalculate and update the cached repository size. - [Get repository details](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/get-repository-details.md): Get repository details including size and data types from the main branch. - [Delete repository](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/delete-repository.md): Delete a repository. Deletion runs in the background. - [Create repository](https://oxenai-regenerate-model-docs.mintlify.site/http-api/repositories/create-repository.md): Create a new repository, optionally with initial files via JSON or multipart form. - [Clear workspaces for repo](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/clear-workspaces-for-repo.md): Deletes all workspaces for the repo - [Check workspace mergeability](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/check-workspace-mergeability.md): Checks if a workspace can be committed and merged onto a branch - [Merge workspace into branch](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/merge-workspace-into-branch.md): Commit and merge workspace into the specified branch - [Get workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/get-workspace.md): Get an existing workspace by ID - [Delete workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/delete-workspace.md): Delete a workspace by ID - [Get or create workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/get-or-create-workspace.md): Create a workspace. If the workspace exists, return it - [List workspaces](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspaces/list-workspaces.md): List workspaces in the repository - [Batch download files (Tarball)](https://oxenai-regenerate-model-docs.mintlify.site/http-api/version-files/batch-download-files-tarball.md): Download multiple files as a gzipped tarball by providing their hashes. - [Download version file](https://oxenai-regenerate-model-docs.mintlify.site/http-api/version-files/download-version-file.md): Download a file by its resource path, with optional image resizing. - [Get version file metadata](https://oxenai-regenerate-model-docs.mintlify.site/http-api/version-files/get-version-file-metadata.md): Get metadata for a specific file version by its hash. - [Batch upload files (Multipart)](https://oxenai-regenerate-model-docs.mintlify.site/http-api/version-files/batch-upload-files-multipart.md): Upload multiple files via multipart form, identified by their content hashes. - [Get data frame slice](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/get-data-frame-slice.md): Get a paginated slice of a tabular data frame with optional filtering and transformations. - [Create a tabular data frame diff](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/create-a-tabular-data-frame-diff.md): Create and cache a tabular diff comparing two data frames with configurable keys and target columns. - [Get a cached tabular data frame diff](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/get-a-cached-tabular-data-frame-diff.md): Retrieve a previously cached tabular diff by its comparison ID. - [Update tabular data frame diff](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/update-tabular-data-frame-diff.md): Update an existing cached tabular diff comparison with new configuration. - [Delete DF Diff](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/delete-df-diff.md): Delete a cached tabular diff comparison by its ID. - [Create data frame from directory](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/create-data-frame-from-directory.md): Create a data frame by scanning directory contents and commit it to a branch. - [Start data frame indexing](https://oxenai-regenerate-model-docs.mintlify.site/http-api/data-frames/start-data-frame-indexing.md): Start indexing a tabular file for queryable access. Creates a workspace if the file is not already indexed. - [Import file from URL](https://oxenai-regenerate-model-docs.mintlify.site/http-api/import/import-file-from-url.md): Import a file from a remote URL and commit it to the repository. - [Upload zip archive](https://oxenai-regenerate-model-docs.mintlify.site/http-api/import/upload-zip-archive.md): Upload and decompress a zip archive into the repository and commit the contents. - [Get namespace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/namespaces/get-namespace.md): Get details of a specific namespace by name. - [List namespaces](https://oxenai-regenerate-model-docs.mintlify.site/http-api/namespaces/list-namespaces.md): List all namespaces on the server. - [Get file from workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/get-file-from-workspace.md): Get a file from a workspace. - [Add files to workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/add-files-to-workspace.md): Upload and stage files to a workspace. Accept a multipart with either gzipped or uncompressed file parts. Use the filename from the file part and compute the file hash from the content. - [List staged changes under a directory in a workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/list-staged-changes-under-a-directory-in-a-workspace.md): List the staged changes (added, modified, and removed files) under a directory in a workspace. The added, modified, and removed lists are each paginated independently, with the same page and page_size applied to each list. - [Unstage a file from the workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/unstage-a-file-from-the-workspace.md): Unstage a file from workspace staging - [List staged changes in a workspace](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/list-staged-changes-in-a-workspace.md): List the staged changes (added, modified, and removed files) in a workspace. The added, modified, and removed lists are each paginated independently, with the same page and page_size applied to each list. - [Unstage files](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/unstage-files.md): Unstage files from a workspace. Accepts both files and directories. - [Stage files for removal](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-files/stage-files-for-removal.md): Stage files for removal from the repository. Accepts both files and directories. - [Set the metadata on a data frame's schema itself — the file-level counterpart to the per-column metadata endpoint. Staged into the workspace, so no commit is required.](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-data-frames/set-the-metadata-on-a-data-frames-schema-itself-—-the-file-levelcounterpart-to-the-per-column-metadata-endpoint-staged-into-theworkspace-so-no-commit-is-required.md): Set the metadata on a data frame's schema itself, the HTTP equivalent of `oxen schemas add -m '{...}'`. Staged into the workspace, so no commit is required. Replaces any existing schema metadata wholesale. - [Post apirepos workspaces data framescolumnsschemametadata](https://oxenai-regenerate-model-docs.mintlify.site/http-api/workspace-data-frames/post-apirepos-workspaces-data_framescolumnsschemametadata.md): Set the metadata on a single column of a data frame, the HTTP equivalent of `oxen schemas add -c -m '{...}'`. Staged into the workspace, so no commit is required. Replaces that column's existing metadata wholesale. - [Get file metadata](https://oxenai-regenerate-model-docs.mintlify.site/http-api/metadata/get-file-metadata.md): Get metadata for a file or directory entry, with optional workspace support. - [Update file metadata](https://oxenai-regenerate-model-docs.mintlify.site/http-api/metadata/update-file-metadata.md): Update metadata for a file version in the version store. - [Check if branches are mergeable](https://oxenai-regenerate-model-docs.mintlify.site/http-api/merge/check-if-branches-are-mergeable.md): Check if two branches can be merged and list any conflicts. - [Merge branches](https://oxenai-regenerate-model-docs.mintlify.site/http-api/merge/merge-branches.md): Merge the head branch into the base branch, creating a merge commit. - [Download File](https://oxenai-regenerate-model-docs.mintlify.site/http-api/files/download-file.md): Download a file from the repository. Supports image resizing and video thumbnail generation via query parameters. - [Upload files](https://oxenai-regenerate-model-docs.mintlify.site/http-api/files/upload-files.md): 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. - [Delete file](https://oxenai-regenerate-model-docs.mintlify.site/http-api/files/delete-file.md): Remove a file from the repository. Stage the file as removed to a workspace and commit the removal. Can remove files or directories. - [Move/Rename file](https://oxenai-regenerate-model-docs.mintlify.site/http-api/files/moverename-file.md): Move or rename a file within the repository and commit the change. - [Check Oxen server status](https://oxenai-regenerate-model-docs.mintlify.site/http-api/health/check-oxen-server-status.md): Check if the Oxen server is running and responsive. - [List directory contents](https://oxenai-regenerate-model-docs.mintlify.site/http-api/directories/list-directory-contents.md): List paginated contents of a directory at a specific revision, with optional workspace support. - [Generate audio](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/generate-audio.md): Creates audio (e.g. speech) from a text prompt. - [Create chat completion](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/create-chat-completion.md): Generates a model response for the given conversation. Compatible with the OpenAI chat completions API. - [List past generations](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/list-past-generations.md): Paginated browse view of completed and in-flight generations for a namespace. Use `/api/ai/queue` for the lean polling view of in-flight rows. - [Get generation details](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/get-generation-details.md): Full metadata for a single generation, including cost and the user who triggered it. - [Edit image](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/edit-image.md): Edits an image given a prompt and source image. - [Generate image](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/generate-image.md): Creates an image from a text prompt. - [List models](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/list-models.md): Lists all available models. OpenAI-compatible. - [List favorite models](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/list-favorite-models.md) - [List featured models](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/list-featured-models.md) - [Search models](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/search-models.md) - [Retrieve model](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/retrieve-model.md): Retrieves a model by ID or name. OpenAI-compatible. - [Update model](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/update-model.md) - [Delete custom model](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/delete-custom-model.md) - [Activate model deployment](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/activate-model-deployment.md): Activates an inactive model deployment. - [Deactivate model deployment](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/deactivate-model-deployment.md) - [Favorite a model](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/favorite-a-model.md) - [Unfavorite a model](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/unfavorite-a-model.md) - [List in-flight queue items](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/list-in-flight-queue-items.md): Lean polling view of the workbench render queue. Returns active generations (status queued or processing) by default; pass an explicit `status=` filter to include terminal rows. For paginated history with cost aggregates, use `/api/ai/generations`. - [Enqueue generation](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/enqueue-generation.md): Enqueues an async image or video generation job. - [Get generation status](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/get-generation-status.md): Retrieves metadata for a single queued generation. - [Cancel generation](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/cancel-generation.md): Cancels a generation. The row is retained with status set to cancelled. - [Generate video](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/generate-video.md): Creates a video from a text prompt. - [List fine-tunes for an organization](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/list-fine-tunes-for-an-organization.md): Return all fine-tune jobs in repositories belonging to the given organization. Requires the authenticated user to be a member of the organization. - [List fine-tunes in a repository](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/list-fine-tunes-in-a-repository.md): Return the fine-tune jobs associated with a given repository. - [Create a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/create-a-fine-tune-job.md): Start a new fine-tune for a given repository. - [Get a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/get-a-fine-tune-job.md): Fetch a single fine-tune job by ID within a repository. - [Delete a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/delete-a-fine-tune-job.md): Delete a fine-tune job and any associated model metadata. - [Update a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/update-a-fine-tune-job.md): Partially update a fine-tune job's attributes. - [Run a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/run-a-fine-tune-job.md): Kick off a run for an existing fine-tune. The job must be in a runnable state (created or tokenizing). - [Stop a running fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/stop-a-running-fine-tune-job.md): Stop a fine-tune if it is currently running or queued. - [List checkpoints for a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/list-checkpoints-for-a-fine-tune-job.md): Retrieve all saved checkpoints for a fine-tune training run. Returns an empty list if the model branch has not been created yet (e.g. before training has produced checkpoints). - [Deploy a checkpoint from a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/deploy-a-checkpoint-from-a-fine-tune-job.md): Deploy a specific training checkpoint to make it available for inference. Pass `retry=true` to tear down any existing deployment for this checkpoint before creating a new one. - [Get logs for a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/get-logs-for-a-fine-tune-job.md): Fetch aggregated logs for a specific fine-tune run. - [Tokenize data for a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/tokenize-data-for-a-fine-tune-job.md): Trigger tokenization for a fine-tune that is in created state. - [Get training status for a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/get-training-status-for-a-fine-tune-job.md): Retrieve the current training status of a fine-tune job. - [Update training status for a fine-tune job](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/update-training-status-for-a-fine-tune-job.md): Update the training status of a fine-tune job. - [List all fine-tunes accessible to the current user](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/list-all-fine-tunes-accessible-to-the-current-user.md): Return all fine-tune jobs the authenticated user has access to, including their own repositories and repositories in organizations they belong to. - [List fine-tunes for a user](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/fine_tunes/list-fine-tunes-for-a-user.md): Return all fine-tune jobs in repositories belonging to the given user. Only the user themselves can access this endpoint. - [Create an evaluation](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/evaluations/create-an-evaluation.md): Run model inference over a dataset in the repository. The resource path (branch and file) is encoded in the URL, e.g. `POST /api/repos/{ns}/{repo}/evaluations/main/datasets/training.parquet`. - [Get evaluation status](https://oxenai-regenerate-model-docs.mintlify.site/fine-tuning-api/evaluations/get-evaluation-status.md): Fetch a single evaluation by ID. Use this to poll for progress (`evaluation.progress.processed` / `evaluation.progress.total`) and completion (`evaluation.status`). ## OpenAPI Specs - [oxen_server_openapi](https://hub.oxen.ai/api/_spec/oxen_server_openapi.json) - [oxen_hub_api](https://hub.oxen.ai/api/_spec/oxen_hub_api.json) ## Optional - [Documentation](https://docs.oxen.ai) - [Blog](https://blog.oxen.ai) - [GitHub](https://github.com/Oxen-AI/Oxen)