Returns a file of the specified agent thread.

GET

https://api.awork.com/api/v1/agents/threads/:threadId/files/:fileId

GET

/api/v1/agents/threads/:threadId/files/:fileId

curl https://api.awork.com/api/v1/agents/threads/threadId/files/fileId \
     -H "Authorization: Bearer <token>"

{
  "name": "Final project report",
  "description": "The client requested a cost overview and timeline",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "taskId": "123e4567-e89b-12d3-a456-426614174000",
  "taskTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "Final project report.xlsx",
  "entityType": "project",
  "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "fileVersions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fileInfoId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 13,
      "size": 13590,
      "width": 1920,
      "height": 1200,
      "createdOn": "2024-01-15T09:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedOn": "2024-01-15T09:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "isCommentFile": false,
  "externalProvider": null,
  "externalFileUrl": null,
  "isHiddenForConnectUsers": true,
  "entityId": "123e4567-e89b-12d3-a456-426614174000"
}

Returns file metadata for a file attached to the specified agent thread. Both the thread id and file id must match the attachment. Returns not found if the file is not attached to that thread.

Required Permissions

The user must have read access to the agent thread.

Returns file metadata for a file attached to the specified agent thread. Both the thread id and file id must match the attachment. Returns not found if the file is not attached to that thread. <Check title="Required Permissions" icon="key">The user must have `read` access to the agent thread.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

threadIdstringRequiredformat: "uuid"

The agent thread id.

fileIdstringRequiredformat: "uuid"

The file id.

Response

namestring or nullOptional

The user-specified name of the file.

descriptionstring or nullOptional

The description of the file.

idstringOptionalformat: "uuid"

The id of the file info.

projectIdstring or nullOptionalformat: "uuid"

projectTemplateIdstring or nullOptionalformat: "uuid"

companyIdstring or nullOptionalformat: "uuid"

taskIdstring or nullOptionalformat: "uuid"

taskTemplateIdstring or nullOptionalformat: "uuid"

userIdstring or nullOptionalformat: "uuid"

documentIdstring or nullOptionalformat: "uuid"

fileNamestring or nullOptional

The name of the file.

entityTypestring or nullOptional

The name of the linked entity type.

mimeTypestring or nullOptional

The MIME type of the file.

createdOnstringOptionalformat: "date-time"

The date this file was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this file.

updatedOnstringOptionalformat: "date-time"

The date this file was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this file.

fileVersionslist of objects or nullOptional

List of all versions.

isCommentFilebooleanOptional

Whether the file is related to a comment.

externalProviderstring or nullOptional

The external provider for the file. Like 'google' or 'onedrive'.

externalFileUrlstring or nullOptional

The file url of the external provider.

isHiddenForConnectUsersbooleanOptional

Whether the file is hidden for connect users.

entityIdstring or nullOptionalformat: "uuid"Deprecated

Deprecated. The id of the linked entity derived from entity specific owner ids.

Errors

401

Unauthorized Error

404

Not Found Error