Upload attachment to task

Upload a file attachment to a specific task

POST /v1/tasks/{taskId}/attachments

Upload attachment to task

cURL

curl --request POST \
  --url http://localhost:3333/v1/tasks/{taskId}/attachments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "fileName": "document.pdf",
  "fileType": "application/pdf",
  "fileData": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==",
  "description": "Meeting notes from Q4 planning session",
  "userId": "usr_abc123def456"
}
'

201

{
  "id": "att_abc123def456",
  "entityId": "tsk_abc123def456",
  "entityType": "task",
  "fileName": "evidence.pdf",
  "fileType": "application/pdf",
  "fileSize": 123456,
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "usr_abc123def456"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

taskId · string · required

Unique task identifier

Example:

"tsk_abc123def456"

Body

application/json

fileName · string · required

Name of the file

Maximum string length: 255

Example:

"document.pdf"

fileType · string · required

MIME type of the file

Example:

"application/pdf"

fileData · string · required

Base64 encoded file data

Example:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="

description · string

Description of the attachment

Maximum string length: 500

Example:

"Meeting notes from Q4 planning session"

userId · string

User ID of the user uploading the attachment (required for API key auth, ignored for JWT auth)

Example:

"usr_abc123def456"

Response

201

application/json

Attachment uploaded successfully

id · string · required

Unique identifier for the attachment

Example:

"att_abc123def456"

name · string · required

Original filename

Example:

"document.pdf"

type · string · required

File type/MIME type

Example:

"application/pdf"

size · number · required

File size in bytes

Example:

1024000

downloadUrl · string · required

Signed URL for downloading the file (temporary)

Example:

"https://bucket.s3.amazonaws.com/path/to/file.pdf?signature=..."

createdAt · string<date-time> · required

Upload timestamp

Example:

"2024-01-15T10:30:00Z"