List task files

List every file attached to a task.

GET /api/v1/tasks/{task_id}/files

cURL

curl "https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "task_id": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
  "input_files": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "file_name": "Supplier NDA.docx",
      "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "content_length": 48213,
      "sensitivity_label": null
    }
  ],
  "output_files": [
    {
      "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",
      "file_name": "Supplier NDA - redline.docx",
      "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "content_length": 51877,
      "sensitivity_label": null
    }
  ]
}

Returns the task’s files, split the way the task splits them:

• input_files are files people or integrations attached, including attachments that arrived by email or chat with the request.
• output_files are files the task produced, such as an agent’s drafts.

Files added to a comment or a thread message are copied onto the task. The ids in their file_ids normally appear here too.

To read a file, pass its id to Get task file text or Get task file download.

​

Authentication

Send an API key, or an OAuth access token with the tasks:read scope, as a bearer token in the Authorization header.

​

Path parameters

task_id · string · required

The task to read. Accepts a display id like #12 or the task’s UUID.

​

Response

task_id · string (uuid)

The task’s id.

input_files · object[]

Files attached to the task. Each has id, file_name, content_type, content_length and sensitivity_label.

output_files · object[]

Files the task produced, in the same shape as input_files.

cURL

curl "https://api.wordsmith.ai/api/v1/tasks/9f8e7d6c-5b4a-3210-9876-543210fedcba/files" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "task_id": "9f8e7d6c-5b4a-3210-9876-543210fedcba",
  "input_files": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "file_name": "Supplier NDA.docx",
      "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "content_length": 48213,
      "sensitivity_label": null
    }
  ],
  "output_files": [
    {
      "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",
      "file_name": "Supplier NDA - redline.docx",
      "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "content_length": 51877,
      "sensitivity_label": null
    }
  ]
}

​

Errors

See Errors for the error format.

HTTP Status	Error Code	When
401	unauthorized	The API key is missing or invalid.
404	resource_not_found	The task does not exist or you cannot read it.