Add page about Studio REST API

content/docs/sidebar.json

@@ -728,7 +728,9 @@
             ]
           }
         ]
-      }
+      },
+      "python-api",
+      "rest-api"
     ]
   },
   {

content/docs/studio/python-api.md

@@ -0,0 +1,35 @@
+# Python API
+
+The purpose of Studio Python API is to give programmatic access to information
+in Studio and executing actions in it.
+
+We provide Studio Python API as a part of DVC python package. To use it, you
+need to [install](/doc/install) DVC with `pip` or `conda`.
+
+This reference provides the details about the functions in the `dvc.studio`
+module, which can be loaded in any regular way, for example:
+
+```py
+import dvc.studio
+```
+
+To use this API, you need to
+[generate](/doc/studio/user-guide/account-management#studio-access-token) and
+[set up](/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots#set-up-an-access-token)
+Studio access token.
+
+## Download model
+
+Download model binaries for a model from Model Registry. Requires the model to
+be stored with DVC with s3 or azure remote. Note, that you need to
+[set up remote cloud credentials](/doc/studio/user-guide/account-management#cloud-credentials)
+for Studio first.
+
+```py
+from dvc.studio.model_registry import download_model
+path = download_model(
+    repo="iterative/demo-bank-customer-churn",
+    model="randomforest-model",
+    version="v2.0.0"
+)
+```

content/docs/studio/rest-api.md

@@ -0,0 +1,60 @@
+# REST API
+
+The purpose of Studio REST API is to give programmatic access to information in
+Studio and executing actions in it.
+
+The API is hosted under the `/api` route on the Studio server:
+https://studio.iterative.ai/api or https://your-domain/api in case of
+[self-hosted Studio](/doc/studio/self-hosting/installation).
+
+To use API, you need to generate
+[Studio access token](/doc/studio/user-guide/account-management#studio-access-token).
+
+## Download model
+
+Get signed url to download the model binaries for a model from Model Registry.
+Requires the model to be stored with DVC with s3 or azure remote. Note, that you
+need to
+[set up remote cloud credentials](/doc/studio/user-guide/account-management#cloud-credentials)
+for Studio have rights to sign urls.
+
+```yaml
+Endpoint: api/model-registry/get-download-uris
+HTTP Method: GET
+```
+
+### Request
+
+| param   | desc          | type   | required | example value                      |
+| ------- | ------------- | ------ | -------- | ---------------------------------- |
+| repo    | Git repo URL  | string | true     | iterative/demo-bank-customer-churn |
+| name    | Model name    | string | true     | randomforest-model                 |
+| version | Model version | string | false    | v2.0.0                             |
+
+If no version specified, the latest one is returned.
+
+When your model is annotated in non-root `dvc.yaml` file (typical for monorepo
+case), model name will be constructed from two parts separated by colon:
+`path/to/dvc/yaml:model_name`. For example, take a loot at this
+[model from example-get-started-experiments repo](https://studio.iterative.ai/user/aguschin/models/VtQdva13kMSPsN_N8004aQ==/pool-segmentation/v1.0.1).
+Its full name that you need to use in API is `results/train:pool-segmentation`.
+
+| header        | desc            | example value |
+| ------------- | --------------- | ------------- |
+| Authorization | Header for auth | token abc123  |
+
+### Response
+
+Response is a json-encoded dict. If the request was successful, keys will be
+paths to files inside the repo, and values will be signed urls you can query to
+actually download the model.
+
+### Example curl
+
+```sh
+$ curl https://studio.iterative.ai/api/model-registry/[email protected]:iterative/demo-bank-customer-churn.git&name=randomforest-model&version=v2.0.0 --header "Authorization:token <TOKEN>"
+
+{
+    ".mlem/model/clf-model": "https://sandbox-datasets-iterative.s3.amazonaws.com/bank-customer-churn/86/bd02376ac675568ba2fac566169ef9?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAU7UXIWDIQFPCO76Q%2F20230706%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230706T134619Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=6807259ddd1f4448ed1e3c5d4503039884f7779381ee556175096b0a884ba1a6"
+}
+```

content/docs/studio/user-guide/account-management.md

@@ -55,7 +55,8 @@ page.
 ### Studio access token
 
 Iterative Studio uses access tokens to authorize [DVC] and [DVCLive] to send
-experiment updates.
+experiment updates, and to authenticate you in Studio
+[REST API](/doc/studio/rest-api).
 
 In the `Studio access token` section of your [Profile] page, you can generate a
 new token as well as regenerate (replace) or delete your access token.