Create presigned URL for request file upload to S3

import requests
url = "https://backend.composio.dev/api/v3/files/upload/request"
payload = {
    "toolkit_slug": "slack",
    "tool_slug": "SLACK_UPLOAD_FILE",
    "filename": "meeting_notes.docx",
    "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "md5": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "req_file_9mZn4qR8sXwT",
  "key": "projects/prj_xyz789/requests/slack/SLACK_UPLOAD_FILE/meeting_notes_9mZn4q.docx",
  "new_presigned_url": "https://storage.composio.dev/projects/prj_xyz789/requests/slack/meeting_notes_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "metadata": {
    "storage_backend": "s3"
  },
  "newPresignedUrl": "https://storage.composio.dev/projects/prj_xyz789/requests/slack/meeting_notes_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "type": "new"
}

Generates a presigned URL for uploading a file to S3. This endpoint handles deduplication by checking if a file with the same MD5 hash already exists.

Authentication

x-api-keystring

API key authentication

Request

This endpoint expects an object.

toolkit_slugstringRequired

Slug of the app where this file belongs to. Example: “gmail”, “slack”, “github”

tool_slugstringRequired

Slug of the action where this file belongs to. Example: “GMAIL_SEND_EMAIL”, “SLACK_UPLOAD_FILE”

filenamestringRequired

Name of the original file. Example: “quarterly_report.pdf”

mimetypestringRequired

Mime type of the original file. Example: “application/pdf”, “image/png”

md5stringRequired

MD5 hash of the file for deduplication and integrity verification. Example: “a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6”

Response

Successfully created upload URL for request file

idstring

ID of the request file. Example: “req_file_9mZn4qR8sXwT”

keystring

Object storage upload location. Example: “projects/prj_xyz789/requests/slack/SLACK_UPLOAD_FILE/document_9mZn4q.docx”

new_presigned_urlstring

Presigned URL for upload. Example: “https://storage.composio.dev/projects/prj_xyz789/requests/slack/document_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600…”

Presigned URL for upload. Example: "https://storage.composio.dev/projects/prj_xyz789/requests/slack/document_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600..."

metadataobject

newPresignedUrlstringDeprecated

[DEPRECATED] Use new_presigned_url instead. Presigned URL for upload. Example: “https://storage.composio.dev/projects/prj_xyz789/requests/slack/document_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600…”

[DEPRECATED] Use new_presigned_url instead. Presigned URL for upload. Example: "https://storage.composio.dev/projects/prj_xyz789/requests/slack/document_9mZn4q.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600..."

typeenumDeprecated

[DEPRECATED] Indicates this is a new file that needs to be uploaded

Allowed values:

Authentication

Request

Response

Errors