Upload an attachment to any supported entity | Comp AI API

Upload an attachment to any supported entity

curl --request POST \
  --url https://api.trycomp.ai/v1/attachments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "fileName": "document.pdf",
  "fileType": "application/pdf",
  "entityId": "tsk_abc123def456",
  "entityType": "task"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileName: 'document.pdf',
    fileType: 'application/pdf',
    entityId: 'tsk_abc123def456',
    entityType: 'task'
  })
};

fetch('https://api.trycomp.ai/v1/attachments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/attachments"

payload = {
    "fileName": "document.pdf",
    "fileType": "application/pdf",
    "entityId": "tsk_abc123def456",
    "entityType": "task"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "att_abc123def456",
  "name": "document.pdf",
  "type": "application/pdf",
  "size": 1024000,
  "downloadUrl": "https://bucket.s3.amazonaws.com/path/to/file.pdf?signature=...",
  "createdAt": "2024-01-15T10:30:00Z"
}

{
  "message": "File size exceeds maximum allowed size of 100MB"
}

{
  "message": "Unauthorized"
}

POST

/

v1

/

attachments

Upload an attachment to any supported entity

curl --request POST \
  --url https://api.trycomp.ai/v1/attachments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "fileName": "document.pdf",
  "fileType": "application/pdf",
  "entityId": "tsk_abc123def456",
  "entityType": "task"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileName: 'document.pdf',
    fileType: 'application/pdf',
    entityId: 'tsk_abc123def456',
    entityType: 'task'
  })
};

fetch('https://api.trycomp.ai/v1/attachments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/attachments"

payload = {
    "fileName": "document.pdf",
    "fileType": "application/pdf",
    "entityId": "tsk_abc123def456",
    "entityType": "task"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "att_abc123def456",
  "name": "document.pdf",
  "type": "application/pdf",
  "size": 1024000,
  "downloadUrl": "https://bucket.s3.amazonaws.com/path/to/file.pdf?signature=...",
  "createdAt": "2024-01-15T10:30:00Z"
}

{
  "message": "File size exceeds maximum allowed size of 100MB"
}

{
  "message": "Unauthorized"
}

Authorizations

X-API-Key

string

header

required

API key for authentication

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"

entityId

string

required

ID of the entity to attach the file to

Example:

"tsk_abc123def456"

entityType

enum<string>

required

Type of entity the attachment belongs to

Available options:

task,

vendor,

risk,

comment,

trust_nda,

task_item,

background_check,

employment_onboard,

employment_offboard,

offboarding_checklist

Example:

"task"

fileData

string

Base64-encoded file contents. For the web UI / direct callers. AI/MCP clients should instead upload via /v1/uploads/presign (purpose=attachment) and pass s3Key — base64 through an LLM is impractically slow and times out. Provide exactly one of fileData or s3Key.

Example:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="

s3Key

string

Key of a file already uploaded via /v1/uploads/presign (purpose=attachment). The server fetches the bytes from storage — no base64 needed. Provide exactly one of fileData or s3Key.

Example:

"org_abc123/uploads/attachment/1700000000000-rbac-matrix.xlsx"

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

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"