Validate destination mappings and dependent choices without creating a workflow. Returns unresolved fields, discovery instructions, and a fingerprint required by mapped import. No source workspace is queried from imported provenance.
OAuth scope: api:write.
POST
/api/v2/workflows/import/previewX-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
Request Body
application/json
Portable workflow data and destination metadata for an import.
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
curl -X POST "https://www.sim.ai/api/v2/workflows/import/preview" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "string", "workflow": "string" }'{
"data": {
"previewFingerprint": "stringstringstringstringstringstringstringstringstringstringstri",
"ready": true,
"bindings": [
{
"kind": "credential",
"sourceId": "string",
"targetId": "string",
"required": true,
"occurrence": {
"blockId": "string",
"subBlockKey": "string",
"valuePath": [
"string"
],
"positions": [
0
],
"encoding": "scalar"
}
}
],
"unresolvedBindings": [
{
"kind": "credential",
"sourceId": "string",
"targetId": "string",
"required": true,
"occurrence": {
"blockId": "string",
"subBlockKey": "string",
"valuePath": [
"string"
],
"positions": [
0
],
"encoding": "scalar"
}
}
],
"configuration": [
{
"blockId": "string",
"subBlockKey": "string",
"title": "string",
"required": true,
"configured": true,
"multiSelect": true,
"selectorKey": "string",
"context": {
"property1": "string",
"property2": "string"
},
"requiresAuthentication": true
}
],
"unresolvedConfiguration": [
{
"blockId": "string",
"subBlockKey": "string",
"title": "string",
"required": true,
"configured": true,
"multiSelect": true,
"selectorKey": "string",
"context": {
"property1": "string",
"property2": "string"
},
"requiresAuthentication": true
}
],
"discovery": [
{
"kind": "string",
"command": "string",
"humanAuthorizationMayBeRequired": 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": "CONFLICT",
"message": "Webhook path already in use"
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"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"
}
}