---
url: /en/api/api-index.md
---
# API Docs

## Develop

* [Open API](./py-api.md)
* [Environment Variables](./environment-variable.md)

## REST API

* [REST API overview](./rest/index.md): Endpoint catalog, base URLs and authentication
* [OAuth2 authorization](./rest/index.md#oauth2-authorization): Fetch the current user's profile and API Key with an Access Token (Public Cloud only)
* [Self-hosted administration](./rest/index.md#self-hosted-administration): Users, organizations, project collaboration and SSO binding (Self-Hosted Commercial Edition only)

## CLI

* [swanlab ping](./cli-swanlab-ping.md): Connectivity and environment diagnostics
* [swanlab api](./cli-swanlab-api.md): Manage cloud workspaces/projects/experiments via CLI
* [swanlab watch](./cli-swanlab-watch.md): Start offline experiment board
* [swanlab login](./cli-swanlab-login.md): Login to SwanLab
* [swanlab logout](./cli-swanlab-logout.md): Logout from SwanLab
* [swanlab verify](./cli-swanlab-verify.md): Verify login status
* [swanlab convert](./cli-swanlab-convert.md): Convert external logs to SwanLab project
* [swanlab sync](./cli-swanlab-sync.md): Sync local logs to SwanLab cloud/private deployment
* [swanlab local](./cli-swanlab-local.md): Set SwanLab to local mode
* [swanlab online](./cli-swanlab-online.md): Set SwanLab to cloud mode
* [swanlab offline](./cli-swanlab-offline.md): Set SwanLab to offline mode
* [swanlab disabled](./cli-swanlab-disabled.md): Set SwanLab to disabled mode

## Python SDK

* [init](./py-init.md)
* [log](./py-log.md)
* [async_log](./py-async-log.md)
* [define_metric](./py-define_metric.md)
* [Settings](./py-settings.md)
* [Image](./py-Image.md)
* [Audio](./py-Audio.md)
* [Text](./py-Text.md)
* [Video](./py-video.md)
* [ECharts](./py-echarts.md)
* [Html](./py-html.md)
* [Object3D](./py-object3d.md)
* [Molecule](./py-molecule.md)
* [Histogram](./py-Histogram.md)
* [pr_curve](./py-pr_curve.md)
* [roc_curve](./py-roc_curve.md)
* [confusion_matrix](./py-confusion_matrix.md)
* [run](./py-run.md)
* [login](./py-login.md)
* [save](./py-save.md)
* [integration](./py-integration.md)
* [converter](./py-converter.md)
* [sync_wandb](./py-sync-wandb.md)
* [sync_tensorboard](./py-sync-tensorboard.md)
* [sync_mlflow](./py-sync-mlflow.md)
* [merge_callbacks](./py-merge-callback.md)
* [register_callbacks](./py-register-callback.md)
* [Other](./py-other.md)
