www/docs: Update the VOD docs with the new fields

livepeer · May 19, 2022 · 8af6016 · 8af6016
1 parent 479aa33
commit 8af6016
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/packages/www/docs/api-reference/vod/export.mdx b/packages/www/docs/api-reference/vod/export.mdx
@@ -50,10 +50,10 @@ curl --location --request POST 'https://livepeer.com/api/asset/$ASSET_ID/export'
       description: "Will be added to the `pinata_secret_api_key` header.",
     },
     {
-      parameter: <code>ipfs.erc1155Metadata</code>,
+      parameter: <code>ipfs.nftMetadata</code>,
       type: <code>object</code>,
       description:
-        "Additional data to add to the automatic ERC-1155 default export. Will be deep merged with the default metadata regularly exported.",
+        "Additional data to add to the NFT metadata also exported to IPFS. Will be deep merged with the default metadata regularly exported.",
     },
     {
       parameter: <code>custom</code>,

diff --git a/packages/www/docs/api-reference/vod/list.mdx b/packages/www/docs/api-reference/vod/list.mdx
@@ -59,10 +59,12 @@ curl --location --request GET 'https://livepeer.com/api/asset/$ASSET_ID' \
     ],
     "name": "Example name",
     "size": 52615193,
-    "status": "ready",
+    "status": {
+      "phase": "ready",
+      "updatedAt": 1644546541218
+    },
     "userId": "$USER_ID",
     "createdAt": 1644546528636,
-    "updatedAt": 1644546541218,
     "videoSpec": {
         "format": "mp4",
         "tracks": [

diff --git a/packages/www/docs/api-reference/vod/upload.mdx b/packages/www/docs/api-reference/vod/upload.mdx
@@ -49,15 +49,38 @@ curl --location --request POST 'https://livepeer.com/api/asset/request-upload' \
     "url": "https://origin.livepeer.com/api/asset/upload/aHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL2xwLW55Yy12b2QtbW9uc3Rlci9kaXJlY3RVcGxvYWQvNjI3OHQyZWlrY2JqZXUxNC9zb3VyY2U%2F...",
     "asset": {
         "id": "$ASSET_ID",
+        "name": "Example name",
         "playbackId": "$PLAYBACK_ID",
         "userId": "$USER_ID",
         "createdAt": 1644595454248,
-        "status": "waiting",
-        "name": "Example name"
+        "status": {
+          "phase": "waiting",
+          "updatedAt": 1644595454248
+        }
+    },
+    "task": {
+        "id": "$TASK_ID",
+        "type": "import",
+        "outputAssetId": "$ASSET_ID",
+        "params": {
+          "import": {
+            "uploadedObjectKey": "directUpload/$PLAYBACK_ID/source"
+          }
+        },
+        "createdAt": 1652813126031,
+        "status": {
+            "phase": "pending",
+            "updatedAt": 1652813126031
+        }
     }
 }
 ```
 
+You can use the returned `task` object to monitor the progress of processing the
+asset after the contents have been uploaded. Check the
+[Retrieve a Task](/docs/api-reference/vod/list-tasks#retrieve-a-task) API for
+more information.
+
 ## Step 2: Upload the contents
 
 Now upload (`PUT`) a video file on the exact URL in the `url` field of the