Apply a reviewed push or pull with inline mappings in one transaction. Requires confirmation, the preview fingerprint, and a stable request ID. Unresolved or changed plans return 409 without applying. The receipt distinguishes committed changes from copy and deployment readiness; poll Get Workspace Operation before treating the target as ready. Workspace API keys return 403; use a personal API key or scoped OAuth token.
OAuth scope: api:write.
/api/v2/workspaces/{workspaceId}/fork/pullYour 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
Explicit current workspace scope.
1 <= length <= 128Request Body
application/json
The body for this operation.
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/workspaces/string/fork/pull" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "otherWorkspaceId": "string", "requestId": "string", "previewFingerprint": "string", "confirm": true }'{
"data": {
"operationId": "string",
"requestId": "string",
"workspaceId": "string",
"kind": "workflow_import",
"applied": true,
"status": "processing",
"resourceIds": [
"string"
],
"issues": [
{
"code": "string",
"message": "string",
"workflowId": "string",
"blockId": "string",
"subBlockKey": "string"
}
],
"idMap": {
"property1": "string",
"property2": "string"
},
"deploymentOperationIds": [
"string"
],
"deployments": [
{
"operationId": "string",
"workflowId": "string",
"version": 1,
"status": "preparing",
"ready": true,
"pendingComponents": [
"string"
]
}
],
"triggerUrlChanges": [
{
"workflowName": "string",
"path": "string"
}
],
"backgroundWorkId": "string",
"copyProgress": {
"status": "pending",
"copied": 0,
"failed": 0
}
}
}{
"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"
}
}