Complete File Upload

Finalize an upload and register its workspace file. Repeating a completed upload returns the existing file.

OAuth scope: api:write.

POST/api/v2/files/uploads/{uploadId}/complete

Authorization

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

uploadId*string

Upload session identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the upload session.

Length1 <= length <= 128

Header Parameters

upload-token*string

Signed upload control token returned when the upload session was created.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.sim.ai/api/v2/files/uploads/string/complete?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY" \  -H "upload-token: string"
{
  "data": {
    "id": "string",
    "status": "uploading",
    "name": "string",
    "contentType": "string",
    "size": 0,
    "expiresAt": "2019-08-24T14:15:22Z",
    "error": "string",
    "file": {
      "id": "wf_V1StGXR8z5jdHi6BmyT91",
      "webUrl": "http://example.com",
      "name": "data.csv",
      "size": 1024,
      "type": "text/csv",
      "key": "workspace/example/data.csv",
      "folderPath": "string",
      "uploadedByEmail": "jane@example.com",
      "uploadedAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "deletedAt": "2026-01-16T09:00:00Z"
    }
  }
}
{
  "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": "CONFLICT",
    "message": "The request conflicts with the current resource state"
  }
}
{
  "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"
  }
}
GETBulk Download FilesPOSTCreate File