Add and update cURL examples (#558)

GetStream · May 13, 2024 · bb5eb53 · bb5eb53
2 parents 2f9d785 + fe9c7de
commit bb5eb53
Show file tree

Hide file tree

Showing 21 changed files with 1,313 additions and 96 deletions.
diff --git a/docusaurus/video/docusaurus/docs/api/_common_/broadcast.mdx b/docusaurus/video/docusaurus/docs/api/_common_/broadcast.mdx
@@ -25,9 +25,8 @@ call.start_hls_broadcasting()
 <TabItem value="curl" label="cURL">
 
 ```bash
-curl -X POST "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/start_broadcasting?api_key=${API_KEY}" \
-    -H "Authorization: ${JWT_TOKEN}" \
-    -H "Content-Type: application/json" \
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/start_broadcasting?api_key=${API_KEY}" \
+    -H "Authorization: ${TOKEN}" \
     -H "stream-auth-type: jwt"
 ```
 

diff --git a/docusaurus/video/docusaurus/docs/api/_common_/create-call.mdx b/docusaurus/video/docusaurus/docs/api/_common_/create-call.mdx
@@ -69,19 +69,20 @@ call.create(
 <TabItem value="curl" label="cURL">
 
 ```bash
-curl -X POST "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}?api_key=${API_KEY}" \
-    -H "Authorization: ${JWT_TOKEN}" \
-    -H "Content-Type: application/json" \
-    -H "stream-auth-type: jwt" \
-    -d '{
-      "data": {
-        "created_by_id": "[email protected]",
-        "members": [
-          { "role": "speaker", "user_id": "[email protected]" }
-        ],
-        "custom": { "color": "blue" }
-      }
-    }'
+# Gets or creates a call
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "Content-Type: application/json" \
+  -H "stream-auth-type: jwt" \
+  -d '{
+    "data": {
+      "created_by_id": "[email protected]",
+      "members": [
+        { "role": "admin", "user_id": "[email protected]" }
+      ],
+      "custom": { "color": "blue" }
+    }
+  }'
 ```
 
 </TabItem>

diff --git a/docusaurus/video/docusaurus/docs/api/_common_/go_live.mdx b/docusaurus/video/docusaurus/docs/api/_common_/go_live.mdx
@@ -18,5 +18,22 @@ call.goLive({ start_hls: true, start_recording: true });
 call.go_live(start_hls=True, start_recording=True)
 ```
 
+</TabItem>
+
+<TabItem value="curl" label="cURL">
+
+```bash
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/livestream/${CALL_ID}/go_live?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "stream-auth-type: jwt"
+
+# optionally start HLS broadcast and/or recording
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/livestream/${CALL_ID}/go_live?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "stream-auth-type: jwt" \
+  -H "Content-Type: application/json" \
+  -d '{ "start_hls": true, "start_recording": true }'
+```
+
 </TabItem>
 </Tabs>
diff --git a/docusaurus/video/docusaurus/docs/api/_common_/manage-call-members.mdx b/docusaurus/video/docusaurus/docs/api/_common_/manage-call-members.mdx
@@ -35,16 +35,17 @@ call.update_call_members(
 <TabItem value="curl" label="cURL">
 
 ```bash
-curl -X PUT "https://video.stream-io-api.com/video/call/default/${CALL_ID}/members?api_key=${API_KEY}" \
-    -H "Authorization: ${JWT_TOKEN}" \
-    -H "Content-Type: application/json" \
-    -H "stream-auth-type: jwt" \
-    -d '{
-      "update_members": [
-        { "user_id": "sara" },
-        { "user_id": "emily", "role": "admin" }
-      ]
-    }'
+# You can only add existing members to a call
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/members?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "Content-Type: application/json" \
+  -H "stream-auth-type: jwt" \
+  -d '{
+    "update_members": [
+      { "user_id": "sara" },
+      { "user_id": "john", "role": "admin" }
+    ]
+  }'
 ```
 
 </TabItem>
@@ -68,5 +69,18 @@ call.updateCallMembers({
 call.update_call_members(remove_members=["jack", "sara"])
 ```
 
+</TabItem>
+<TabItem value="curl" label="cURL">
+
+```bash
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/members?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "Content-Type: application/json" \
+  -H "stream-auth-type: jwt" \
+  -d '{
+    "remove_members": ["sara"]
+  }'
+```
+
 </TabItem>
 </Tabs>
diff --git a/docusaurus/video/docusaurus/docs/api/_common_/rtmp.mdx b/docusaurus/video/docusaurus/docs/api/_common_/rtmp.mdx
@@ -45,5 +45,17 @@ rtmp_url = response.data.call.ingress.rtmp.address
 print(rtmp_url, stream_key)
 ```
 
+</TabItem>
+<TabItem value="curl" label="cURL">
+
+```bash
+# RTMP URL is: response.call.rtmp.address
+curl -X GET "https://video.stream-io-api.com/api/v2/video/call/livestream/${CALL_ID}?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "stream-auth-type: jwt"
+
+# Stream key: create a user token
+```
+
 </TabItem>
 </Tabs>
diff --git a/docusaurus/video/docusaurus/docs/api/_common_/storage.mdx b/docusaurus/video/docusaurus/docs/api/_common_/storage.mdx
@@ -68,7 +68,7 @@ client.video.update_call_type(name='allhands', external_storage= "my-s3")
 ```bash
 # 1. create a new storage with all the required parameters
 curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \
-    -H "Authorization: ${JWT_TOKEN}" \
+    -H "Authorization: ${TOKEN}" \
     -H "Content-Type: application/json" \
     -H "stream-auth-type: jwt" \
     -d '{
@@ -84,8 +84,8 @@ curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${AP
     }'
 
 # 2. update the call type to use the new storage
-curl -X PUT https://video.stream-io-api.com/video/calltypes/${CALL_TYPE}?api_key=${API_KEY} \
-    -H "Authorization: ${JWT_TOKEN}" \
+curl -X PUT https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE}?api_key=${API_KEY} \
+    -H "Authorization: ${TOKEN}" \
     -H "Content-Type: application/json" \
     -H "stream-auth-type: jwt" \
     -d '{
@@ -142,17 +142,17 @@ call.start_recording(recording_external_storage="my-storage")
 
 ```bash
 # update the call type to use Stream S3 storage for recordings
-curl -X PUT https://video.stream-io-api.com/video/calltypes/${CALL_TYPE}?api_key=${API_KEY} \
-    -H "Authorization: ${JWT_TOKEN}" \
+curl -X PUT https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE}?api_key=${API_KEY} \
+    -H "Authorization: ${TOKEN}" \
     -H "stream-auth-type: jwt" \
     -H 'Content-Type: application/json' \
 -d '{
   "external_storage": "my-first-storage"
 }'
 
 # specify Stream S3 storage when starting call transcribing
-curl -X POST "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/start_transcription?api_key=${API_KEY}" \
-    -H "Authorization: ${JWT_TOKEN}" \
+curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/start_transcription?api_key=${API_KEY}" \
+    -H "Authorization: ${TOKEN}" \
     -H "stream-auth-type: jwt" \
     -H 'Content-Type: application/json' \
 -d '{
@@ -252,7 +252,7 @@ client.create_external_storage(
 
 ```bash
 curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \
-    -H "Authorization: ${JWT_TOKEN}" \
+    -H "Authorization: ${TOKEN}" \
     -H "stream-auth-type: jwt" \
     -H 'Content-Type: application/json' \
 -d '{
@@ -334,7 +334,7 @@ client.create_external_storage(
 
 ```bash
 curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \
-    -H "Authorization: ${JWT_TOKEN}" \
+    -H "Authorization: ${TOKEN}" \
     -H "stream-auth-type: jwt" \
     -H 'Content-Type: application/json' \
 -d '{

diff --git a/docusaurus/video/docusaurus/docs/api/_common_/update-call.mdx b/docusaurus/video/docusaurus/docs/api/_common_/update-call.mdx
@@ -40,17 +40,18 @@ call.update(
 <TabItem value="curl" label="cURL">
 
 ```bash
-curl -X PUT "https://video.stream-io-api.com/video/call/default/${CALL_ID}?api_key=${API_KEY}" \
-    -H "Authorization: ${JWT_TOKEN}" \
-    -H "Content-Type: application/json" \
-    -H "stream-auth-type: jwt" \
-    -d '{
-      "settings_override": {
-        "audio": {
-          "mic_default_on": true
-        }
+curl -X PATCH "https://video.stream-io-api.com/api/v2/video/call/default/${CALL_ID}?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "stream-auth-type: jwt" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "settings_override": {
+      "audio": {
+        "mic_default_on": true,
+        "default_device": "speaker"
       }
-    }'
+    }
+  }'
 ```
 
 </TabItem>