Attach Files

curl --location --request POST 'https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "attachments": [
    { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
  ]
}'

const response = await fetch("https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "attachments": [
      { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
    ]
  }),
});
const data = await response.json();
console.log(data);

import requests

url = "https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "attachments": [
        {"upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}
    ]
}

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

{
  "id": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
  "display_id": "#12",
  "task_number": 12,
  "title": "Review the Acme NDA",
  "description": "Check the indemnity and termination clauses.",
  "additional_context": "Counterparty has pushed back twice on liability caps.",
  "status": "in_progress",
  "priority": "high",
  "team": {
    "id": "1a2b3c4d-5e6f-7081-9200-aabbccddeeff",
    "name": "Legal"
  },
  "creator": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_to": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_agent": null,
  "assigned_team": null,
  "matter": null,
  "complete_by": "2026-01-01T00:00:00Z",
  "tags": [
    "nda",
    "urgent"
  ],
  "source_channel": "web",
  "visibility": "customer",
  "archived": false,
  "draft": false,
  "involved_people": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "role": "assignee",
      "access_level": "write"
    }
  ],
  "shared_teams": [],
  "linked_items": [],
  "input_files": [],
  "output_files": [],
  "created_at": "2025-12-31T00:00:00Z",
  "updated_at": "2025-12-31T01:00:00Z"
}

POST

api

tasks

{task_id}

files

curl --location --request POST 'https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "attachments": [
    { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
  ]
}'

const response = await fetch("https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "attachments": [
      { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
    ]
  }),
});
const data = await response.json();
console.log(data);

import requests

url = "https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "attachments": [
        {"upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}
    ]
}

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

{
  "id": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
  "display_id": "#12",
  "task_number": 12,
  "title": "Review the Acme NDA",
  "description": "Check the indemnity and termination clauses.",
  "additional_context": "Counterparty has pushed back twice on liability caps.",
  "status": "in_progress",
  "priority": "high",
  "team": {
    "id": "1a2b3c4d-5e6f-7081-9200-aabbccddeeff",
    "name": "Legal"
  },
  "creator": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_to": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_agent": null,
  "assigned_team": null,
  "matter": null,
  "complete_by": "2026-01-01T00:00:00Z",
  "tags": [
    "nda",
    "urgent"
  ],
  "source_channel": "web",
  "visibility": "customer",
  "archived": false,
  "draft": false,
  "involved_people": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "role": "assignee",
      "access_level": "write"
    }
  ],
  "shared_teams": [],
  "linked_items": [],
  "input_files": [],
  "output_files": [],
  "created_at": "2025-12-31T00:00:00Z",
  "updated_at": "2025-12-31T01:00:00Z"
}

Attach a new file in three steps:

Call the file upload endpoint. It returns a job_id and an upload_url.
PUT the file to upload_url with the same Content-Type.
Call this endpoint with {"upload_job_id": "<job_id>"} in attachments.

A file at a public URL needs no upload: pass {"url": "https://..."} in attachments and Wordsmith downloads it. To attach a file that is already in Wordsmith, for example from another task’s input_files, pass its id in file_ids. Returns the updated task. Each new file appears in input_files with its own file id, which differs from the job_id. The task stores a copy of each file, so the file id in input_files differs from the one you passed in file_ids. The original file stays where it was, and the people who could open it still can. A file that is already on this task keeps its id. A job_id expires after 1 hour and can be used once. A job used here cannot also be sent to an agent question, and the other way round. A rejected request uses up no job_id, so you can fix the request and retry.

Body parameters

Pass at least one file, in file_ids or attachments.

array

Ids of files already in Wordsmith. The task gets a copy of each one, with a new file id. A job_id does not go here; use attachments.

array

Up to 10 new files. Each entry has exactly one of:

upload_job_id: the job_id from the file upload endpoint, once the file is uploaded.
url: a public http(s) URL. It must return the file with status 200 within 20 seconds, and the file must be under 256 MB.

curl --location --request POST 'https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "attachments": [
    { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
  ]
}'

const response = await fetch("https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "attachments": [
      { "upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
    ]
  }),
});
const data = await response.json();
console.log(data);

import requests

url = "https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "attachments": [
        {"upload_job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}
    ]
}

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

{
  "id": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
  "display_id": "#12",
  "task_number": 12,
  "title": "Review the Acme NDA",
  "description": "Check the indemnity and termination clauses.",
  "additional_context": "Counterparty has pushed back twice on liability caps.",
  "status": "in_progress",
  "priority": "high",
  "team": {
    "id": "1a2b3c4d-5e6f-7081-9200-aabbccddeeff",
    "name": "Legal"
  },
  "creator": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_to": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "assigned_agent": null,
  "assigned_team": null,
  "matter": null,
  "complete_by": "2026-01-01T00:00:00Z",
  "tags": [
    "nda",
    "urgent"
  ],
  "source_channel": "web",
  "visibility": "customer",
  "archived": false,
  "draft": false,
  "involved_people": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "role": "assignee",
      "access_level": "write"
    }
  ],
  "shared_teams": [],
  "linked_items": [],
  "input_files": [],
  "output_files": [],
  "created_at": "2025-12-31T00:00:00Z",
  "updated_at": "2025-12-31T01:00:00Z"
}

API Documentation

Agents

Assistants (deprecated)

Tasks

Directory

Body parameters

​Body parameters

Body parameters