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": {}
}
}Project export API
Starts an asynchronous export. The server checks project readiness, discovers agent/tool dependencies, includes required dependency layers, assembles the archive, and generates its manifest and lockfile.
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
Project-bound Platform Key supplied in the x-api-key header. The key must include the operation's required scope: project_io.read for export operations or project_io.write for import operations. A pipeline that promotes changes normally requires both scopes.
Headers
Client-generated key used to safely retry operation creation.
1 - 128Path Parameters
Project identifier. The project must belong to the authenticated tenant.
1Body
Output archive representation. zip is the recommended public download format; folder returns a folder-style file map; tar.gz returns a gzip-compressed tar archive.
zip, folder, tar.gz 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 Agent definition serialization format. source preserves authored DSL; yaml requests compiled YAML where compiler context is available.
source, yaml Include deployment records and deployment configuration in the export. Environment credentials are not included.
Include non-deleted agent and workflow version history when supported. Disabled by default to keep exports configuration-focused.
Include extracted Knowledge Base document text in the search layer. Disabled by default because document content can be large.
Optional environment names used to scope environment-specific export data.
Maximum extracted-text size for an individual exported Knowledge Base document, in bytes.
x >= 1Aggregate extracted-text size limit for all exported Knowledge Base documents, in bytes.
x >= 1Response
Export accepted for asynchronous processing.
Indicates that the operation request was accepted for processing.
Stable identifier for polling this operation.
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 Relative URL that can be polled for the operation status.
Was this page helpful?