Upload File

Upload a file to a workspace. Send the file as multipart/form-data with a `file` field and a `workspaceId` field. Maximum file size is 100MB. Duplicate filenames within a workspace are not allowed.

POST/api/v1/files

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST \  "https://www.sim.ai/api/v1/files" \  -H "X-API-Key: YOUR_API_KEY" \  -F "workspaceId=YOUR_WORKSPACE_ID" \  -F "file=@/path/to/file.csv"
{
  "success": true,
  "data": {
    "file": {
      "id": "file_abc123",
      "name": "data.csv",
      "size": 1024,
      "type": "text/csv",
      "key": "files/wsp_abc123/data.csv",
      "uploadedBy": "user_abc123",
      "uploadedAt": "2026-01-15T10:30:00Z"
    },
    "message": "File uploaded successfully"
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}