Endpoint
Request
curl -X PATCH "http://client-omni-api.argosidentity.com/v1/items/{itemId}" \
-H "x-api-key: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"name": "primary-id.jpg",
"metadata": { "documentType": "passport" }
}'
Request Body
Updated custom metadata (merged with existing)
Updated content (only for text or json type items)
Response
{
"id": "item_abc123",
"folderId": "fld_default001",
"type": "file",
"name": "primary-id.jpg",
"content": null,
"contentType": "image/jpeg",
"sizeBytes": 245678,
"url": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../extracted.txt",
"s3OriginalUrl": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../original.jpg",
"detected": {
"contentType": "image/jpeg",
"extension": "jpg",
"fileCategory": "image"
},
"metadata": { "documentType": "passport" },
"status": "ACTIVE",
"processedAt": "2026-03-15T10:10:05Z",
"createdAt": "2026-03-15T10:10:00Z"
}
For file type items, only name and metadata can be updated. To replace the file itself, delete the item and upload a new one.
Error Codes
| Status | Code | Description |
|---|
| 404 | ITEM_NOT_FOUND | Item not found |