POST /user_uploads

Upload a single file and get the corresponding URL.

Initially, only you will be able to access the link. To share the uploaded file, you'll need to send a message containing the resulting link. Users who can already access the link can reshare it with other users by sending additional Zulip messages containing the link.

The maximum allowed file size is available in the max_file_upload_size_mib field in the POST /register response. Note that large files (25MB+) may fail to upload using this API endpoint due to network-layer timeouts, depending on the quality of your connection to the Zulip server.

For uploading larger files, /api/v1/tus is an endpoint implementing the tus resumable upload protocol, which supports uploading arbitrarily large files limited only by the server's max_file_upload_size_mib (Configured via MAX_FILE_UPLOAD_SIZE in /etc/zulip/settings.py). Clients which send authenticated credentials (either via browser-based cookies, or API key via Authorization header) may use this endpoint to upload files.

Changes: The api/v1/tus endpoint supporting resumable uploads was introduced in Zulip 10.0 (feature level 296). Previously, max_file_upload_size_mib was typically 25MB.

Servers

• https://{subdomain}.zulipchat.com/api/v1
• {server}/api/v1
• https://chat.zulip.org/api/v1

How to start integrating

1. Add HTTP Task to your workflow definition.
2. Search for the API you want to integrate with and click on the name.
   • This loads the API reference documentation and prepares the Http request settings.
3. Click Test request to test run your request to the API and see the API's response.