Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oxen.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
🔒 Authentication & Authorization

At Oxen.ai we take your data security and privacy seriously. Every action performed on an Oxen.ai repository needs to be authenticated and authorized. You must provide an API_KEY to perform any actions on an Oxen.ai repository. You must also have the correct permissions to perform the action.

​
Public vs Private Repositories

On Oxen.ai you can choose if you want your repositories to be public or private. Private repositories limit access to the public internet, and can have viewers, editors, or admin roles.

​
Obtain Auth Token

Before you can write to a remote repository, you must have permissions to do so. Permissions are handled through an auth_token that is passed in with the request. You can obtain an API Key by creating an account on Oxen.ai and going to your profile. Oxen.ai authentication key

​
Set Auth Token

To set your auth token, you can either set it through the command line interface or directly in python. 
from oxen.auth import config_auth
config_auth("YOUR_AUTH_TOKEN")
This will write the auth token to a file in ~/.config/oxen/auth_config.toml for future use. If you set up your own oxen-server you can generate custom auth tokens there.

​
Setup User

In order for Oxen to know who is committing and where to sync to by default, you must call config_user and pass in the name and email you would like to use in your commit messages. 
from oxen.user import config_user
config_user("YOUR NAME", "YOUR EMAIL")
This will save a file in ~/.config/oxen/user_config.toml that contains your user configuration.