Create a CSV import. Upload sources receive signed transfer instructions; workspace-file sources start processing directly.
OAuth scope: api:write.
/api/v2/tables/importsYour 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
Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.
curl -X POST "https://www.sim.ai/api/v2/tables/imports" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "source": { "type": "upload", "name": "customers.csv", "contentType": "text/csv", "size": 2048 }, "target": { "type": "new", "name": "ImportedCustomers", "folderPath": "/Imports" }, "timezone": "America/Los_Angeles" }'{
"data": {
"session": {
"id": "string",
"workspaceId": "string",
"status": "uploading",
"source": {
"type": "upload",
"name": "string",
"contentType": "string",
"size": 1
},
"target": {
"type": "new",
"name": "string",
"folderPath": "string"
},
"tableId": "string",
"rowsProcessed": 0,
"rowsRejected": 0,
"cellsRejected": 0,
"rejectedSamples": [
{
"code": "string",
"line": 0,
"message": "string"
}
],
"error": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z"
},
"uploadToken": "string",
"transfer": {
"method": "put",
"url": "http://example.com",
"headers": {
"property1": "string",
"property2": "string"
},
"expiresAt": "2019-08-24T14:15:22Z"
}
}
}{
"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 current table state"
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Request body must be sent as application/json"
}
}{
"error": {
"code": "LOCKED",
"message": "A table lock prevents this operation.",
"details": {
"lock": "insert"
}
}
}{
"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"
}
}Request body
application/json
Workspace, CSV source, target table, optional mapping, and timezone.
TypeScript definitions
Use the request body type in TypeScript.
Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json