Archive a workspace file, retaining its stored bytes and removing API read access. List Files with scope=archived finds it; Restore File recovers it. Archiving an already archived file returns 404.
OAuth scope: api:write.
DELETE
/api/v2/files/{fileId}X-API-Key<token>
Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.
In: header
Path Parameters
fileId*string
File identifier.
Match
^[A-Za-z0-9_-]+$Length
1 <= length <= 128Query Parameters
workspaceId*string
Workspace that owns the file.
Length
1 <= length <= 128Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://www.sim.ai/api/v2/files/string?workspaceId=string" \ -H "X-API-Key: YOUR_API_KEY"{
"data": {
"id": "string",
"deleted": true
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient workspace permissions",
"details": {
"code": "INSUFFICIENT_WORKSPACE_ROLE"
}
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "API rate limit exceeded",
"details": {
"retryAfter": "2026-01-01T00:00:30.000Z"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}