Updated Rest API home page (#1188)

comet-ml · Feb 1, 2025 · 4eadcf3 · 4eadcf3
1 parent 1e9170c
commit 4eadcf3
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/apps/opik-backend/src/main/resources/openapi_template.yml b/apps/opik-backend/src/main/resources/openapi_template.yml
@@ -19,6 +19,15 @@ info :
       }
       ```
 
+      The full payload would therefore look like:
+      
+      ```
+      curl -X GET 'https://www.comet.com/opik/api/v1/private/projects' \
+      -H 'Accept: application/json' \
+      -H 'Comet-Workspace: <your-workspace-name>' \
+      -H 'authorization: <your-api-key>'
+      ```
+
       Do take note here that the authorization header value does not include the `Bearer ` prefix. To switch to using the Opik Cloud in the documentation, you can
       click on the edit button displayed when hovering over the `Base URL` displayed on the right hand side of the docs.
 

diff --git a/apps/opik-documentation/documentation/rest_api/opik.yaml b/apps/opik-documentation/documentation/rest_api/opik.yaml
@@ -20,6 +20,15 @@ info:
       }
       ```
 
+      The full payload would therefore look like:
+      
+      ```
+      curl -X GET 'https://www.comet.com/opik/api/v1/private/projects' \
+      -H 'Accept: application/json' \
+      -H 'Comet-Workspace: <your-workspace-name>' \
+      -H 'authorization: <your-api-key>'
+      ```
+
       Do take note here that the authorization header value does not include the `Bearer ` prefix. To switch to using the Opik Cloud in the documentation, you can
       click on the edit button displayed when hovering over the `Base URL` displayed on the right hand side of the docs.
   contact: