Preview workflow import

Validate destination mappings and configuration with workspace write access, without creating a workflow. The result reports readiness, unresolved fields, discovery instructions, and a fingerprint for mapped import with the same choices. Imported provenance never authorizes or queries a source workspace.

OAuth scope: api:write.

POST/api/v2/workflows/import/preview

Authorization

X-API-Key<token>

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their 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/workflows/import/preview" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "folderPath": "/Operations",    "workflow": {      "blocks": {},      "edges": []    }  }'

const body = JSON.stringify({  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "folderPath": "/Operations",  "workflow": {    "blocks": {},    "edges": []  }})fetch("https://www.sim.ai/api/v2/workflows/import/preview", {  method: "POST",  headers: {    "Content-Type": "application/json",    "X-API-Key": "YOUR_API_KEY"  },  body})

package mainimport (  "fmt"  "net/http"  "io/ioutil"  "strings")func main() {  url := "https://www.sim.ai/api/v2/workflows/import/preview"  body := strings.NewReader(`{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "folderPath": "/Operations",    "workflow": {      "blocks": {},      "edges": []    }  }`)  req, _ := http.NewRequest("POST", url, body)  req.Header.Add("X-API-Key", "YOUR_API_KEY")  req.Header.Add("Content-Type", "application/json")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}

import requestsurl = "https://www.sim.ai/api/v2/workflows/import/preview"body = """{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "folderPath": "/Operations",  "workflow": {    "blocks": {},    "edges": []  }}"""response = requests.request("POST", url, data = body, headers = {  "Content-Type": "application/json",   "X-API-Key": "YOUR_API_KEY"})print(response.text)

import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "folderPath": "/Operations",  "workflow": {    "blocks": {},    "edges": []  }}""");HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://www.sim.ai/api/v2/workflows/import/preview"))  .header("X-API-Key", "YOUR_API_KEY")  .header("Content-Type", "application/json")  .POST(body)  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}

using System;using System.Net.Http;using System.Text;var body = new StringContent("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "folderPath": "/Operations",  "workflow": {    "blocks": {},    "edges": []  }}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PostAsync("https://www.sim.ai/api/v2/workflows/import/preview", body);var responseBody = await response.Content.ReadAsStringAsync();

{
  "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": "The request conflicts with current resource state"
  }
}

{
  "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"
  }
}

Request body

application/json

Portable workflow data and destination metadata for an import.

TypeScript definitions

Use the request body type in TypeScript.

workspaceId*string

Workspace in which to import the workflow.

Length1 <= length <= 128

workflow*|

Workflow export object, bare workflow state, or JSON string containing either form.

folderPath?Folder path input

Destination folder path; omit for the workspace root.

Lengthlength <= 4096

name?string

Override for the imported workflow name.

Length1 <= length <= 200

description?string

Override for the imported workflow description.

Lengthlength <= 2000

mappings?array<>

Mapping entries addressed by resource kind and source identifier.

Itemsitems <= 5000

bindings?array<>

Resolved and unresolved source occurrences with their destination selections.

Itemsitems <= 5000

dependentValues?array<>

Destination-specific values addressed by the source block ID and field key, before imported IDs are regenerated.

Itemsitems <= 2000

Response body

application/json

Sunbelt Computer Software

PL/B Language Development and Support

Preview workflow import

Authorization

Request body

Response body

Sunbelt Computer Software

PL/B Language Development and Support

Preview workflow import

Authorization

Request body

Response body

200

400

401

403

404

409

413

429

500

503