> ## Documentation Index > Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Project import API ## OpenAPI ````yaml agent-platform/api-specs/project-import-export.yaml get /v1/projects/{projectId}/import/{importId} openapi: 3.1.0 info: title: Project Import / Export API version: 1.0.0 summary: >- Project-scoped APIs for importing and exporting platform project configuration. description: | Starts asynchronous project import and export operations and exposes their status. The operations use the same dependency discovery, validation, staging, activation, and rollback flow as the Studio Builder experience. Warnings are informational and do not block completion. Errors are blocking, are preserved on the operation, and must be propagated to the caller. servers: - url: https://{host} description: Replace with your base URL of the platform. security: - apiKey: [] tags: - name: Project Import description: Import project configuration into an existing project. - name: Project Export description: Export project configuration as a portable archive. paths: /v1/projects/{projectId}/import/{importId}: get: tags: - Project Import summary: Get project import status operationId: getProjectImportStatus parameters: - $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/ImportId' responses: '200': description: Current import operation status. content: application/json: schema: $ref: '#/components/schemas/ImportStatusResponse' example: success: true data: id: imp_01JIMPORT123 type: import status: completed phase: completed progressPercent: 100 layers: core: activated connections: activated workflows: activated dependencyValidation: valid: true missing: [] circular: [] applied: created: 3 updated: 2 deleted: 0 toolsCreated: 1 toolsUpdated: 1 toolsDeleted: 0 warnings: [] errors: [] createdAt: '2026-09-01T09:00:00Z' completedAt: '2026-09-01T09:00:14Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: ProjectId: name: projectId in: path required: true description: Project identifier. The project must belong to the authenticated tenant. schema: type: string minLength: 1 ImportId: name: importId in: path required: true description: Identifier returned when the import operation is created. schema: type: string minLength: 1 schemas: ImportStatusResponse: type: object required: - success - data properties: success: type: boolean const: true description: >- Indicates that the status request was read successfully. The operation itself may still be running or may have failed; inspect data.status and data.errors. data: $ref: '#/components/schemas/ImportOperation' description: >- Import operation record and its current validation, dependency, progress, result, warning, and error state. ImportOperation: allOf: - $ref: '#/components/schemas/BaseOperation' - type: object required: - type - dependencyValidation properties: type: type: string const: import description: Identifies this operation as a project import. dependencyValidation: $ref: '#/components/schemas/DependencyValidation' description: Dependency graph result for the imported project content. applied: $ref: '#/components/schemas/AppliedCounts' description: Counts of records changed after a successful import. preview: $ref: '#/components/schemas/ImportPreview' description: >- Calculated import changes and preview digest, when preview data is available. ErrorResponse: type: object required: - success - error properties: success: type: boolean const: false error: $ref: '#/components/schemas/Diagnostic' BaseOperation: type: object required: - id - type - status - progressPercent - warnings - errors - createdAt properties: id: type: string description: Stable identifier for the import or export operation. type: type: string description: Operation kind. Values are import or export. enum: - import - export status: $ref: '#/components/schemas/OperationStatus' phase: type: string description: >- Current high-level processing phase. Import values are validating, staging, activating, rolling_back, completed, failed, or reverted. Export values are queued, processing, packaging, completed, or failed. enum: - queued - validating - staging - activating - processing - packaging - rolling_back - completed - failed - reverted nullable: true progressPercent: type: integer description: >- Estimated completion percentage from 0 to 100. This is progress reporting, not a guarantee of remaining duration. minimum: 0 maximum: 100 layers: type: object description: >- Per-layer import progress. Keys are layer names and values use the LayerOperationStatus enum. additionalProperties: $ref: '#/components/schemas/LayerOperationStatus' type: string warnings: type: array description: >- Non-blocking diagnostics. Warnings are retained for visibility and do not make the operation fail. items: $ref: '#/components/schemas/Diagnostic' errors: type: array description: >- Blocking diagnostics. Any error means the operation did not complete successfully and must be propagated to the caller. items: $ref: '#/components/schemas/Diagnostic' createdAt: type: string format: date-time description: Time at which the operation was created. completedAt: type: string format: date-time nullable: true description: >- Time at which the operation reached a terminal state; null while it is running. DependencyValidation: type: object required: - valid - missing - circular properties: valid: type: boolean description: >- True when all discovered dependencies were resolved and no circular dependencies were detected. missing: type: array description: >- Dependencies referenced by the bundle but not found in the bundle or target project. items: $ref: '#/components/schemas/DependencyIssue' circular: type: array description: Circular agent dependency paths detected during validation. items: type: array items: type: string AppliedCounts: type: object additionalProperties: false properties: created: type: integer description: Number of records created by the import. minimum: 0 updated: type: integer description: Number of records updated by the import. minimum: 0 deleted: type: integer description: Number of records deleted by the import. minimum: 0 toolsCreated: type: integer description: Number of tool records created by the import. minimum: 0 toolsUpdated: type: integer description: Number of tool records updated by the import. minimum: 0 toolsDeleted: type: integer description: Number of tool records deleted by the import. minimum: 0 ImportPreview: type: object properties: previewDigest: type: string description: Digest identifying the exact preview input and calculated changes. changes: type: object description: >- Per-entity or per-layer create, update, delete, and unchanged counts calculated during preview. additionalProperties: true dependencyValidation: $ref: '#/components/schemas/DependencyValidation' Diagnostic: type: object required: - code - message properties: code: type: string description: Stable machine-readable diagnostic code. message: type: string description: Human-readable explanation of the diagnostic. stage: type: string description: >- Processing stage that produced the diagnostic, such as request, validation, staging, activation, or packaging. layer: $ref: '#/components/schemas/LayerName' path: type: string description: Archive file path associated with the diagnostic, when available. line: type: integer minimum: 1 description: >- One-based source line associated with a syntax diagnostic, when available. details: type: object description: >- Additional structured diagnostic context. Contents depend on the diagnostic code. additionalProperties: true OperationStatus: type: string description: >- 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. enum: - queued - validating - staging - activating - packaging - processing - completed - failed - rolling_back - reverted LayerOperationStatus: type: string description: >- State of one requested import layer. pending=not started; staged=validated and staged; activated=visible in the target project; skipped=excluded or not requested; failed=layer processing failed; rolled_back=layer changes were reverted. enum: - pending - staged - activated - skipped - failed - rolled_back DependencyIssue: type: object required: - source - target - type properties: source: type: string description: Name or path of the content that declares the dependency. target: type: string description: Name, path, or identifier of the referenced dependency. type: type: string description: >- Dependency relationship, such as handoff, delegate, inline_handoff, tool_import, profile_use, workflow, searchai, or table. sourceLayer: $ref: '#/components/schemas/LayerName' description: Layer containing the content that declares the dependency. targetLayer: $ref: '#/components/schemas/LayerName' description: Layer expected to contain the referenced dependency. path: type: string description: Archive file path containing the reference, when available. LayerName: type: string description: >- 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. enum: - core - connections - prompts - guardrails - workflows - evals - search - channels - vocabulary - tables responses: Unauthorized: description: Authentication required or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: Authenticated principal lacks the required project scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: >- Project or operation was not found in the authenticated tenant/project scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: | 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. ````