curl --request POST \
--url https://{host}/v1/projects/{projectId}/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"files": {},
"layers": [],
"excludedLayers": [],
"conflictStrategy": "merge",
"deleteUnmatched": false,
"importMode": "compatibility",
"bindingResolutions": {},
"authProfileMapping": {},
"portabilityOptions": {},
"conflictBaseFiles": {},
"conflictResolutions": {}
}
'{
"success": true,
"operationId": "imp_01JIMPORT123",
"status": "queued",
"statusUrl": "/v1/projects/proj_123/import/imp_01JIMPORT123"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}Start project import
Start an asynchronous import of project content into an existing project.
curl --request POST \
--url https://{host}/v1/projects/{projectId}/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"files": {},
"layers": [],
"excludedLayers": [],
"conflictStrategy": "merge",
"deleteUnmatched": false,
"importMode": "compatibility",
"bindingResolutions": {},
"authProfileMapping": {},
"portabilityOptions": {},
"conflictBaseFiles": {},
"conflictResolutions": {}
}
'{
"success": true,
"operationId": "imp_01JIMPORT123",
"status": "queued",
"statusUrl": "/v1/projects/proj_123/import/imp_01JIMPORT123"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"stage": "<string>",
"layer": "core",
"path": "<string>",
"line": 2,
"details": {}
}
}operationId and a statusUrl. Poll Get project import status until the import is completed. The request needs the project_io.write scope.
Send the content in files, a map of relative archive paths to UTF-8 file contents. By default, the import detects layers from the content, merges matching records, and deletes nothing. Use layers and excludedLayers to choose layers. Use conflictStrategy (replace, skip, or merge) to resolve conflicts. Use deleteUnmatched to remove target content that the import does not contain. Starting an import while another import runs returns 409. Send an Idempotency-Key header so a retry is safe.Authorizations
Headers
Path Parameters
Body
Optional allowlist of project layers to import. If omitted, layers are detected from the bundle. Values are core, connections, prompts, guardrails, workflows, evals, search, channels, vocabulary, or tables. Required dependencies must also be present or the import fails validation.
Project configuration layer. core=agents/tools/core metadata; connections=connectors; prompts=prompt bundles; guardrails=guardrail policies; workflows=workflows; evals=evaluation data; search=SearchAI configuration; channels=channel definitions; vocabulary=domain vocabulary; tables=Agent Tables definitions.
core, connections, prompts, guardrails, workflows, evals, search, channels, vocabulary, tables Optional list of detected layers to skip. Values are core, connections, prompts, guardrails, workflows, evals, search, channels, vocabulary, or tables. Excluding a referenced dependency can produce a blocking import error.
Project configuration layer. core=agents/tools/core metadata; connections=connectors; prompts=prompt bundles; guardrails=guardrail policies; workflows=workflows; evals=evaluation data; search=SearchAI configuration; channels=channel definitions; vocabulary=domain vocabulary; tables=Agent Tables definitions.
core, connections, prompts, guardrails, workflows, evals, search, channels, vocabulary, tables Response
Import accepted for asynchronous processing.
Current asynchronous operation state. queued=accepted and waiting; validating=checking input and dependencies; staging=writing staged records; activating=making staged records active; packaging=assembling the export artifact; processing=worker is executing the operation; completed=finished successfully; failed=finished with an error; rolling_back=import is undoing partial activation; reverted=import completed with changes reverted.
queued, validating, staging, activating, packaging, processing, completed, failed, rolling_back, reverted Was this page helpful?