curl --request POST \
--url https://{host}/v1/projects/{projectId}/export \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"format": "zip",
"layers": [],
"dslFormat": "source",
"includeDeployments": false,
"includeVersionHistory": false,
"includeKnowledgeBaseDocuments": false,
"environments": [
"<string>"
],
"maxKnowledgeBaseDocumentBytes": 2,
"maxTotalKnowledgeBaseDocumentBytes": 2
}
'{
"success": true,
"operationId": "exp_01JEXPORT123",
"status": "queued",
"statusUrl": "/v1/projects/proj_123/export/exp_01JEXPORT123"
}{
"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 export
Export a project.
curl --request POST \
--url https://{host}/v1/projects/{projectId}/export \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"format": "zip",
"layers": [],
"dslFormat": "source",
"includeDeployments": false,
"includeVersionHistory": false,
"includeKnowledgeBaseDocuments": false,
"environments": [
"<string>"
],
"maxKnowledgeBaseDocumentBytes": 2,
"maxTotalKnowledgeBaseDocumentBytes": 2
}
'{
"success": true,
"operationId": "exp_01JEXPORT123",
"status": "queued",
"statusUrl": "/v1/projects/proj_123/export/exp_01JEXPORT123"
}{
"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": {}
}
}Authorizations
Headers
Path Parameters
Body
Optional export layer selection. core is always included. The exporter adds recognized required dependency layers for SearchAI, workflow, and table tools, or returns an error if an explicit selection cannot satisfy dependencies.
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
Export 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?