Import/Export

Import & Export Agents

Exporting agents

post

Exports the agents by IDs.

Required scopes

This endpoint requires the following scopes:

• : Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Body

agentIdsstring[] · max: 100Required

List of the agents IDs.

Responses

200

The exported agents with components.

application/json

datastringOptional

The base64 encoded JSON value of the exported agents with related tools and MCP servers.

checksumstringOptional

Checksum calculated based on decoded data value. Validates if importing JSON is exactly the same as the exported one.

exportedAtstring · date-timeOptional

Date of the export process.

jobIdstringOptional

ID of the job.

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

post/ai-service/{tenant}/agentic/agents/export

POST /ai-service/{tenant}/agentic/agents/export HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "agentIds": [
    "complaint-agent-id"
  ]
}

{
  "jobId": "job-id-of-export-job",
  "exportedAt": "2025-11-04T11:15:25.903913Z",
  "checksum": "de56cd0c62c234033eced948645c7b458962eaa11611bd1066ef52a61e1b4cb2",
  "data": "ewogICJhZ2VudHMiIDogWyB7CiAgICAiaWQiIDogInByb2R1Y3QtY3JlYXRlZCIsCiAgICAibmFtZSIgOiB7CiAgICAgICJlbiIgOiAicHJvZHVjdC1jcmVhdGVkIgogICAgfSwKICAgICJkZXNjcmlwdGlvbiIgOiB7CiAgICAgICJlbiIgOiAicHJvZHVjdC1jcmVhdGVkIgogICAgfSwKICAgICJyZXF1aXJlZFNjb3BlcyIgOiBbIF0sCiAgICAidXNlclByb21wdCIgOiAiWW91IGFyZSBhbiBhZ2VudCB3aGljaCBoYW5kbGUgcHJvZHVjdCBjcmVhdGlvbiBwcm9jZXNzLlxuQXQgZmlyc3QgZ2V0IHRoZSB3aG9sZSBwcm9kdWN0IG9iamVjdCBmcm9tIHRoZSBhcGkgYW5kIHJldHVybiBpdCBhcyBhIEpTT04iLAogICAgInRyaWdnZXJzIiA6IFsgewogICAgICAidHlwZSIgOiAiZW5kcG9pbnQiCiAgICB9IF0sCiAgICAibGxtQ29uZmlnIiA6IHsKICAgICAgIm1vZGVsIiA6ICJjbGF1ZGUtMy01LWhhaWt1LTIwMjQxMDIyIiwKICAgICAgInRlbXBlcmF0dXJlIiA6IDAuMSwKICAgICAgIm1heFRva2VucyIgOiA0MDAwLAogICAgICAicHJvdmlkZXIiIDogImFudGhyb3BpYyIsCiAgICAgICJ0b2tlbiIgOiB7CiAgICAgICAgImlkIiA6ICJhbnRocm9waWMtdG9rZW4iCiAgICAgIH0KICAgIH0sCiAgICAibWNwU2VydmVycyIgOiBbIHsKICAgICAgInR5cGUiIDogInByZWRlZmluZWQiLAogICAgICAiZG9tYWluIiA6ICJwcm9kdWN0IiwKICAgICAgInRvb2xzIiA6IFsgImdldC1wcm9kdWN0IiBdCiAgICB9IF0sCiAgICAibmF0aXZlVG9vbHMiIDogWyBdLAogICAgImFnZW50Q29sbGFib3JhdGlvbnMiIDogWyBdLAogICAgIm1heFJlY3Vyc2lvbkxpbWl0IiA6IDIwLAogICAgImVuYWJsZU1lbW9yeSIgOiB0cnVlLAogICAgImljb24iIDogInJvYm90IiwKICAgICJ0YWdzIiA6IFsgXSwKICAgICJ0eXBlIiA6ICJnZW5lcmljIgogIH0gXQp9"
}

Importing agents

post

Imports the agents from the base64 encoded data.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Body

datastringRequired

The base64 encoded JSON value of the exported agents with related tools and MCP servers.

checksumstringRequired

Checksum calculated based on decoded data value. Validates if importing JSON is exactly the same as the exported one.

Responses

200

A single agent.

application/json

messagestringOptional

Short summary of the import.

importedAtstring · date-timeOptional

Date of the import process.

jobIdstringOptional

ID of the job.

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

post/ai-service/{tenant}/agentic/agents/import

POST /ai-service/{tenant}/agentic/agents/import HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1321

{
  "checksum": "de56cd0c62c234033eced948645c7b458962eaa11611bd1066ef52a61e1b4cb2",
  "data": "ewogICJhZ2VudHMiIDogWyB7CiAgICAiaWQiIDogInByb2R1Y3QtY3JlYXRlZCIsCiAgICAibmFtZSIgOiB7CiAgICAgICJlbiIgOiAicHJvZHVjdC1jcmVhdGVkIgogICAgfSwKICAgICJkZXNjcmlwdGlvbiIgOiB7CiAgICAgICJlbiIgOiAicHJvZHVjdC1jcmVhdGVkIgogICAgfSwKICAgICJyZXF1aXJlZFNjb3BlcyIgOiBbIF0sCiAgICAidXNlclByb21wdCIgOiAiWW91IGFyZSBhbiBhZ2VudCB3aGljaCBoYW5kbGUgcHJvZHVjdCBjcmVhdGlvbiBwcm9jZXNzLlxuQXQgZmlyc3QgZ2V0IHRoZSB3aG9sZSBwcm9kdWN0IG9iamVjdCBmcm9tIHRoZSBhcGkgYW5kIHJldHVybiBpdCBhcyBhIEpTT04iLAogICAgInRyaWdnZXJzIiA6IFsgewogICAgICAidHlwZSIgOiAiZW5kcG9pbnQiCiAgICB9IF0sCiAgICAibGxtQ29uZmlnIiA6IHsKICAgICAgIm1vZGVsIiA6ICJjbGF1ZGUtMy01LWhhaWt1LTIwMjQxMDIyIiwKICAgICAgInRlbXBlcmF0dXJlIiA6IDAuMSwKICAgICAgIm1heFRva2VucyIgOiA0MDAwLAogICAgICAicHJvdmlkZXIiIDogImFudGhyb3BpYyIsCiAgICAgICJ0b2tlbiIgOiB7CiAgICAgICAgImlkIiA6ICJhbnRocm9waWMtdG9rZW4iCiAgICAgIH0KICAgIH0sCiAgICAibWNwU2VydmVycyIgOiBbIHsKICAgICAgInR5cGUiIDogInByZWRlZmluZWQiLAogICAgICAiZG9tYWluIiA6ICJwcm9kdWN0IiwKICAgICAgInRvb2xzIiA6IFsgImdldC1wcm9kdWN0IiBdCiAgICB9IF0sCiAgICAibmF0aXZlVG9vbHMiIDogWyBdLAogICAgImFnZW50Q29sbGFib3JhdGlvbnMiIDogWyBdLAogICAgIm1heFJlY3Vyc2lvbkxpbWl0IiA6IDIwLAogICAgImVuYWJsZU1lbW9yeSIgOiB0cnVlLAogICAgImljb24iIDogInJvYm90IiwKICAgICJ0YWdzIiA6IFsgXSwKICAgICJ0eXBlIiA6ICJnZW5lcmljIgogIH0gXQp9"
}

{
  "importedAt": "2025-11-04T11:56:55.296335Z",
  "summary": {
    "agents": [
      {
        "id": "346cefda-19be-4603-a471-5d2e990566ba--import-1762257415296",
        "name": "complaint-demo",
        "state": "DISABLED",
        "details": [
          {
            "code": "AGENT_IMPORTED_DISABLED",
            "objectId": "346cefda-19be-4603-a471-5d2e990566ba--import-1762257415296",
            "objectName": "complaint-demo",
            "message": "Imported agents start disabled."
          }
        ]
      }
    ],
    "tools": [
      {
        "id": "80171fb9-a3cc-4441-8235-ced7edd0635d2",
        "name": "Slack Tool",
        "state": "TO_CREATE",
        "details": [
          {
            "code": "NOT_IMPORTABLE",
            "objectId": "80171fb9-a3cc-4441-8235-ced7edd0635d2",
            "objectName": "Slack Tool",
            "message": "Slack/Teams tools cannot be imported. Create them on this tenant."
          }
        ]
      }
    ],
    "mcpServers": [
      {
        "id": "80171fb9-a3cc-4441-8235-ced7edd0635d3",
        "name": "Custom MCP Server",
        "state": "ENABLED",
        "details": []
      }
    ]
  },
  "message": "Successfully imported 1 agents, 0 tools, and 1 MCP servers.",
  "jobId": "6909ea07e0527f327fdead3e"
}