Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​

Publishing & Operations

​

Publish an Agent

​

Create Agent Versions

1. Open your project in Studio.
2. Select the agent you want to version.
3. Click Create Version in the toolbar.
4. Enter a version label (e.g., 1.0.0) and optional changelog.
5. Click Save Version.

​

Deploy via Studio

1. Navigate to Project Settings > Deployments.
2. Click New Deployment.
3. Configure the deployment:

4. Click Deploy.

​

Deploy via API

curl -X POST /api/projects/:projectId/deployments \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "environment": "production",
    "entryAgentName": "Airlines_Supervisor",
    "agentVersionManifest": {
      "Airlines_Supervisor": "1.0.0",
      "Flight_Search": "1.0.0",
      "Policy_Advisor": "1.0.0"
    },
    "label": "v1.0 - Initial release"
  }'

{
  "agentVersionManifest": {
    "Airlines_Supervisor": "auto",
    "Flight_Search": "auto"
  }
}

​

Deployment Lifecycle

​

Rollback a Deployment

1. Navigate to Deployments.
2. Find the problematic deployment.
3. Click Rollback.

curl -X POST /api/projects/:projectId/deployments/:deploymentId/rollback \
  -H "Authorization: Bearer $TOKEN"

​

Deploy with Model Overrides

{
  "environment": "production",
  "entryAgentName": "Supervisor",
  "agentVersionManifest": { "Supervisor": "1.0.0" },
  "modelOverrides": {
    "Supervisor": {
      "model": "claude-sonnet-4-5-20250929",
      "temperature": 0.3
    }
  }
}

​

Deploy with Workflow Versions

{
  "workflowVersionManifest": {
    "order_processing": "1.0.0",
    "refund_workflow": "auto"
  }
}

​

Troubleshooting

• “Agent not found” error: Verify all agent names in the manifest match the exact names in your project (case-sensitive).
• “Version not found” error: Create the version first or use "auto" to version from the current working copy.
• Missing environment variables warning: The deployment succeeds but warns about unresolved {{env.KEY}} references. Add the missing variables in the target environment’s settings.
• Channels not updating: Verify channels are configured with auto-follow enabled for the target environment.

​

Set Up Environments

​

Understand the Environment Model

​

Configure Environment Variables

1. Open Project Settings > Environment Variables.
2. Select the target environment tab (dev, staging, or production).
3. Click Add Variable.
4. Enter the key, value, and optional description.
5. Toggle Secret if the value is sensitive (secrets are write-only after saving).
6. Click Save.

Environment: production
+----------------------+-------------------------------+--------+
| Key                  | Value                         | Secret |
+----------------------+-------------------------------+--------+
| API_BASE_URL         | https://api.example.com       | No     |
| SUPPORT_EMAIL        | support@example.com           | No     |
| PAYMENT_API_KEY      | ********                      | Yes    |
| FEATURE_NEW_FLOW     | true                          | No     |
+----------------------+-------------------------------+--------+

TOOLS:
  process_payment:
    description: "Process a payment"
    type: http
    endpoint: "{{env.API_BASE_URL}}/payments"
    auth: bearer

​

Set Up Environment-Specific Deployments

# Deploy to dev with auto-versioning
curl -X POST /api/projects/:projectId/deployments \
  -d '{"environment": "dev", "entryAgentName": "Supervisor", "agentVersionManifest": {"Supervisor": "auto"}}'

# Deploy to staging with pinned versions
curl -X POST /api/projects/:projectId/deployments \
  -d '{"environment": "staging", "entryAgentName": "Supervisor", "agentVersionManifest": {"Supervisor": "1.2.0"}}'

# Promote staging to production
curl -X POST /api/projects/:projectId/deployments/:stagingDeploymentId/promote \
  -d '{"targetEnvironment": "production"}'

​

Route Channels to Environments

1. Open Project Settings > Channels.
2. Select a channel.
3. Set its Environment to dev, staging, or production.
4. Enable Auto-follow to automatically update the channel when a new deployment is created for its environment.

​

Feature Flags via Environment Variables

FLOW:
  steps:
    - check_feature

check_feature:
  REASONING: false
  THEN:
    - IF: "{{env.FEATURE_NEW_FLOW}}" == "true"
      THEN: new_flow_step
    - ELSE:
      THEN: legacy_flow_step

​

Copy Variables Between Environments

1. Open the source environment tab.
2. Click Copy to… and select the target environment.
3. Review and modify values as needed (secrets are not copied — re-enter them).

​

Troubleshooting

• “Missing environment variable” warning on deploy: The deployment detects {{env.KEY}} references in your agents that do not have corresponding variables defined for the target environment. Add the missing variables before deploying.
• Variable changes not taking effect: Environment variables are resolved at session start. Existing sessions use the values from when they were created. New sessions pick up the latest values.
• Cannot read secret value: Secret variables are write-only after saving. You can update or delete them but cannot view the stored value.

​

Git Integration

​

Connect a Git Repository

1. Open Project Settings > Git Integration.
2. Click Connect Repository.
3. Select your Git provider:

4. Authorize access to your repository.
5. Configure the connection:

6. Click Connect.

​

Sync Project to Git

1. Click Push to Git in the Git Integration panel.
2. Review the files that will be pushed (agent definitions, tool files, project manifest).
3. Enter a commit message.
4. Click Push.

agents/
  supervisor.agent.abl
  booking_manager.agent.abl
  flight_search.agent.abl
tools/
  payment_api.tools.abl
project.yaml          # Project manifest
project-lock.yaml     # Dependency lockfile

​

Pull Changes from Git

1. Click Pull from Git.
2. Review the incoming changes (added, modified, removed agents).
3. Click Apply.

​

Configure Auto-Sync

1. Open the Git integration settings.
2. Toggle Auto-sync on.
3. Choose a conflict strategy:

​

Set Up Auto-Deploy from Git

1. In the Git integration settings, expand Auto-Deploy.
2. Toggle it on.
3. Configure:

​

Branch-Per-Environment Workflow

• develop branch auto-deploys to dev
• staging branch auto-deploys to staging
• main branch auto-deploys to production

​

Troubleshooting

• “Authentication failed” on connect: Verify your access token has repository read/write permissions. For GitHub Apps, check the installation has access to the specific repository.
• Sync conflicts: When both Studio and the repository have changes to the same agent, a conflict occurs. Resolve manually by choosing which version to keep, or set a conflict strategy.
• Webhook not firing: Verify the webhook URL is reachable from your Git provider. Check the webhook secret matches. Review webhook delivery logs in your Git provider’s settings.
• Auto-deploy failing: Check that agents compile cleanly in the repository. The auto-deploy aborts if any agent has compilation errors.

​

Export & Import Projects

​

Preview Before Exporting

curl -X GET /api/projects/:projectId/project-io/export/preview \
  -H "Authorization: Bearer $TOKEN"

​

Run the Full Export

curl -X GET /api/projects/:projectId/project-io/export \
  -H "Authorization: Bearer $TOKEN"

{
  "files": {
    "agents/supervisor.agent.abl": "SUPERVISOR: Airlines_Supervisor\n...",
    "agents/flight_search.agent.abl": "AGENT: Flight_Search\n...",
    "tools/payment_api.tools.abl": "TOOL: Payment_API\n...",
    "project.yaml": "name: Airlines Support\n..."
  }
}

​

Include Deployments

curl -X GET "/api/projects/:projectId/project-io/export?include_deployments=true" \
  -H "Authorization: Bearer $TOKEN"

​

Export from Studio

1. Open your project.
2. Navigate to Project Settings > Import / Export.
3. Click Export Project.
4. Choose the export format and download.

​

Preview Import Changes

curl -X POST /api/projects/:projectId/project-io/import/preview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "files": {
      "agents/supervisor.agent.abl": "SUPERVISOR: Airlines_Supervisor\n...",
      "agents/new_agent.agent.abl": "AGENT: New_Agent\n..."
    }
  }'

​

Apply the Import

curl -X POST /api/projects/:projectId/project-io/import \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "files": {
      "agents/supervisor.agent.abl": "SUPERVISOR: Airlines_Supervisor\n...",
      "agents/flight_search.agent.abl": "AGENT: Flight_Search\n..."
    }
  }'

{
  "success": true,
  "applied": {
    "created": 1,
    "updated": 2,
    "deleted": 0
  }
}

​

Import from Studio

1. Open your project.
2. Navigate to Project Settings > Import / Export.
3. Click Import Project.
4. Upload your export file or paste file contents.
5. Review the preview of changes.
6. Click Apply.

​

Migrate Between Workspaces

1. Export from the source workspace using the API or Studio.
2. Create a new project in the target workspace.
3. Import the exported files into the new project.

​

Use Import for CI/CD

# Build your agents from source
# ...

# Preview changes
PREVIEW=$(curl -s -X POST .../import/preview -d @agents.json)
echo "Changes: $(echo $PREVIEW | jq '.preview.changes')"

# Apply if preview looks good
curl -X POST .../import -d @agents.json

​

Troubleshooting

• “Another import is in progress”: Only one import can run per project at a time. Wait for the current import to complete (timeout: 2 minutes).
• “File too large” error: Individual files are limited to 1 MB and total import content to 50 MB. Split large projects if needed.
• Import validation errors: The import validates ABL syntax for all files. Fix parse errors before importing.
• Path traversal error: File paths cannot contain .., start with /, or use backslashes. Use forward-slash relative paths like agents/my_agent.agent.abl.
• Rollback on failure: If the import fails during application, newly created agents are automatically rolled back. Partially updated agents may need manual review.

​

Monitor Performance

​

Per-Session Metrics

​

Aggregated Metrics

curl -X GET "/api/projects/:projectId/sessions/:id/metrics" \
  -H "Authorization: Bearer $TOKEN"

​

Monitor Active Deployments

1. Navigate to Project Settings > Deployments.
2. View the status of each deployment:
   • Active sessions — how many sessions are currently using this deployment.
   • Channel count — how many channels are bound to this deployment.
   • Status — active, draining, or retired.

# List all deployments for a project
curl -X GET /api/projects/:projectId/deployments \
  -H "Authorization: Bearer $TOKEN"

# Filter by environment and status
curl -X GET "/api/projects/:projectId/deployments?environment=production&status=active" \
  -H "Authorization: Bearer $TOKEN"

​

Track LLM Usage

1. Open Workspace Settings > Usage.
2. View usage broken down by time period, project, model, and environment.

​

Set Up Alerts

1. Open Project Settings > Alerts.
2. Click New Alert.
3. Configure the alert condition:

4. Set the notification channel (email, webhook).
5. Click Save.

​

Feedback Collection

# Submit feedback for a session
curl -X POST /api/projects/:projectId/sessions/:id/feedback \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"rating": 4, "comment": "Helpful but slow"}'

​

Trace Analysis

curl -X GET /api/projects/:projectId/sessions/:id/analysis \
  -H "Authorization: Bearer $TOKEN"

​

Export Session Data

curl -X GET "/api/projects/:projectId/sessions/export?format=csv" \
  -H "Authorization: Bearer $TOKEN"

​

Monitor Across Environments

• Use environment filters on the sessions list.
• Compare latency and error rates between staging and production deployments.
• Run the same eval set against both environments and compare scores.

​

Natural Language Analytics

curl -X POST /api/projects/:projectId/nl-analytics \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "What are the top 5 reasons users abandon sessions this week?"}'

​

Troubleshooting

• Metrics not appearing: Metrics require an active ClickHouse connection. In development without ClickHouse, the platform falls back to in-memory metrics that reset on restart.
• Latency spikes after deployment: Check if the new deployment uses a different model or has additional tool calls. Compare traces between the old and new deployments.
• Token usage higher than expected: Review agent instructions for verbosity. Check if tools are being called unnecessarily. Consider using smaller models for simple tasks.

​

Further Reading

• Testing & Evaluation — Test agents before publishing
• Channels — Connect deployments to user-facing channels
• Quickstart — Getting started with Agent Platform