Upload files

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.

PUT /api/repos/{namespace}/{repo_name}/file/{resource}

Upload files

cURL

curl --request PUT \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/file/{resource} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form email=[e-mail] \
  --form 'files[]=<binary data>' \
  --form 'message=Adding a picture of a cow' \
  --form name=bessie \
  --form files.items='@example-file' \
  --form file.0='@example-file' \
  --form file.1='@example-file'

200

{
  "commit": {
    "author": "ox",
    "email": "[e-mail]",
    "id": "a1b2c3d4e5f67890abcdef1234567890",
    "message": "Refactor data loading pipeline.",
    "parent_ids": [
      "f1e2d3c4b5a67890fedcba9876543210"
    ],
    "timestamp": "2025-01-01T10:00:00Z"
  },
  "status": "success",
  "status_message": "resource_found"
}

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

resource · string · required

Path of the directory to add files in (including branch)

Body

multipart/form-data

Multipart form for uploading files. Use file for a single full-path upload, or files[] for uploading one or more files into a directory.

files · file[] · required

email · string | null

Example:

"[e-mail]"

file · file | null · deprecated

Deprecated: use files[] instead.

message · string | null

Example:

"Adding a new image to the training set"

name · string | null

Example:

"bessie"

Response

200

application/json

Files committed successfully

status · string · required

status_message · string · required

commit · object · required

Show child attributes

Example:

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

oxen_version · string | null