zulip/templates/zerver/api/upload-file.md

944 B

Upload a file

Upload a single file and get the corresponding URI.

POST {{ api_url}}/v1/user_uploads

Usage examples

  • Python

{generate_code_example(python)|upload-file|example}

Arguments

{generate_api_arguments_table|arguments.json|upload-file.md}

Maximum file size

The maximum file size for uploads can be configured by the administrator of the Zulip server by setting MAX_FILE_UPLOAD_SIZE in the server's settings. MAX_FILE_UPLOAD_SIZE defaults to 25MB.

Response

Return values

  • uri: The URI of the uploaded file.

Example response

A typical successful JSON response may look like:

{generate_code_example|upload-file|fixture}