Add documentation for API.chunked_upload_append
authorHarmon <Harmon758@gmail.com>
Sat, 20 Feb 2021 01:09:29 +0000 (19:09 -0600)
committerHarmon <Harmon758@gmail.com>
Sat, 20 Feb 2021 01:09:29 +0000 (19:09 -0600)
docs/api.rst

index 7cde4ea044a3a09c1a0e1e3ab2ceba8948bc1248..d2392fb8b3ee2bd86396d2c4a8f3c53f708ec485 100644 (file)
@@ -1377,6 +1377,19 @@ Media methods
    :rtype: :class:`Media` object
 
 
+.. method:: API.chunked_upload_append(media_id, media, segment_index)
+
+   Use this endpoint to upload a chunk (consecutive byte range) of the media
+   file.
+
+   :param media_id: The ``media_id`` returned from the initialization.
+   :param media: The raw binary file content being uploaded. It must be <= 5
+                 MB.
+   :param segment_index: An ordered index of file chunk. It must be between
+                         0-999 inclusive. The first segment has index 0, second
+                         segment has index 1, and so on.
+
+
 .. method:: API.create_media_metadata(media_id, alt_text)
 
    This endpoint can be used to provide additional information about the