Update file metadata
curl --request PATCH \
--url https://api.poelis.com/v1/public/files/{file_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userTitle": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.poelis.com/v1/public/files/{file_id}"
payload = {
"userTitle": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({userTitle: '<string>', description: '<string>'})
};
fetch('https://api.poelis.com/v1/public/files/{file_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"content_type": "application/pdf",
"deleted": false,
"description": "Specification document for compressor performance and operating constraints.",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "compressor-spec-v3.pdf",
"originalFileName": "compressor-spec-v3.pdf",
"size_bytes": 245612,
"uploadedBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"uploaded_at": "2026-04-01T10:11:12.123Z",
"used_in": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"product_id": "660e8400-e29b-41d4-a716-446655440000",
"target_id": "770e8400-e29b-41d4-a716-446655440000",
"target_type": "item"
}
],
"userTitle": "Compressor specification"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Files
Update file metadata
Update editable file metadata fields.
userTitleupdates independently.descriptionupdates user-provided text. Empty string clears it.- A description change sets
description_statustodismissed; unchanged text leaves status as-is.
PATCH
/
v1
/
public
/
files
/
{file_id}
Update file metadata
curl --request PATCH \
--url https://api.poelis.com/v1/public/files/{file_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userTitle": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.poelis.com/v1/public/files/{file_id}"
payload = {
"userTitle": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({userTitle: '<string>', description: '<string>'})
};
fetch('https://api.poelis.com/v1/public/files/{file_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"content_type": "application/pdf",
"deleted": false,
"description": "Specification document for compressor performance and operating constraints.",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "compressor-spec-v3.pdf",
"originalFileName": "compressor-spec-v3.pdf",
"size_bytes": 245612,
"uploadedBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"uploaded_at": "2026-04-01T10:11:12.123Z",
"used_in": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"product_id": "660e8400-e29b-41d4-a716-446655440000",
"target_id": "770e8400-e29b-41d4-a716-446655440000",
"target_type": "item"
}
],
"userTitle": "Compressor specification"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Authorizations
Enter your API key. Example: Bearer poelis_api_...
Path Parameters
Body
application/json
Response
Updated file metadata and current usage links.
Public representation of a stored file.
File ID
Original file name (legacy compatibility field)
Original file name
Whether the file is soft-deleted
Optional editable file title
MIME type
File description
File size in bytes
ISO 8601 upload timestamp
User who uploaded the file
Show child attributes
Show child attributes
Example:
{
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
}
Current file link placements for this file
Show child attributes
Show child attributes