Files
Manage files used by agents or users. These endpoints support file uploads, previews, and importing files directly from URLs.
Query parameters
tenant_idstring · nullableOptionalExample:
Tenant Id
40d39c4b-9585-4123-8fd4-f1cc23a1184ctenant_unit_idstring · nullableOptionalExample:
Tenant Unit ID
da114de3-d7e6-4161-bc55-0ce85dbee589Body
filestring · binaryRequired
Upload file
Responses
201
Successful Response
application/json
idstringRequired
File id
tenant_idstringRequired
Tenant id
tenant_unit_idstringRequired
Tenant unit id
namestringRequired
File name
sizeintegerRequired
File size
extstringRequired
File ext
file_urlstringRequired
File url
original_urlstringRequired
Original url
422
Validation Error
application/json
post/admin/api/v2/files/upload
POST /admin/api/v2/files/upload HTTP/1.1
Host: api.workfx.ai
Content-Type: multipart/form-data
Accept: */*
Content-Length: 11
{
"file": ""
}{
"id": "text",
"tenant_id": "text",
"tenant_unit_id": "text",
"name": "text",
"size": 1,
"ext": "text",
"file_url": "text",
"original_url": "text"
}Path parameters
file_idstringRequired
File id
Query parameters
expiresstringRequired
Expires
noncestringRequired
Nonce
sigstringRequired
Sig
Responses
200
Successful Response
application/json
objectOptional
422
Validation Error
application/json
get/admin/api/v2/files/{file_id}
GET /admin/api/v2/files/{file_id}?expires=text&nonce=text&sig=text HTTP/1.1
Host: api.workfx.ai
Accept: */*
{}Query parameters
tenant_idstring · nullableOptionalExample:
Tenant Id
40d39c4b-9585-4123-8fd4-f1cc23a1184ctenant_unit_idstring · nullableOptionalExample:
Tenant Unit ID
da114de3-d7e6-4161-bc55-0ce85dbee589Body
The remote url
urlstringRequired
Responses
201
Successful Response
application/json
idstringRequired
File id
tenant_idstringRequired
Tenant id
tenant_unit_idstringRequired
Tenant unit id
namestringRequired
File name
sizeintegerRequired
File size
extstringRequired
File ext
file_urlstringRequired
File url
original_urlstringRequired
Original url
422
Validation Error
application/json
post/admin/api/v2/files/remote-url/upload
POST /admin/api/v2/files/remote-url/upload HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"url": "text"
}{
"id": "text",
"tenant_id": "text",
"tenant_unit_id": "text",
"name": "text",
"size": 1,
"ext": "text",
"file_url": "text",
"original_url": "text"
}Last updated
Was this helpful?