Skip to main content
PUT
Update agent (CLI/SDK)

Path Parameters

id
string
required

Agent UUID

Body

application/json
name
string

Agent name

Required string length: 2 - 100
Example:

"Customer Support Bot"

description
string

Agent description

Required string length: 10 - 500
Example:

"AI-powered customer support agent"

category
enum<string>

Agent category

Available options:
SALES,
CUSTOMER_SUPPORT,
VOICE,
OPERATIONS,
FINANCIAL_PREVENTION,
FINANCIAL_RECOVERY,
MARKETING,
ANALYTICS
Example:

"CUSTOMER_SUPPORT"

subcategory
enum<string>

Agent subcategory for more specific classification

Available options:
SDR_OUTBOUND,
SDR_INBOUND,
ACCOUNT_MANAGER,
SALES_CLOSER,
LEAD_QUALIFIER,
TIER_1_SUPPORT,
TECHNICAL_SUPPORT,
ESCALATION_HANDLER,
CHAT_SUPPORT,
COLD_CALLING,
CUSTOMER_SERVICE_VOICE,
APPOINTMENT_SETTER,
SURVEY_CALLER,
DATA_PROCESSOR,
WORKFLOW_AUTOMATOR,
QUALITY_CHECKER,
REPORT_GENERATOR,
FRAUD_DETECTOR,
RISK_ASSESSOR,
COMPLIANCE_MONITOR,
DEBT_COLLECTOR,
PAYMENT_NEGOTIATOR,
RECOVERY_SPECIALIST,
CONTENT_CREATOR,
CAMPAIGN_MANAGER,
SOCIAL_MEDIA_MANAGER,
EMAIL_MARKETER,
DATA_ANALYST,
PERFORMANCE_TRACKER,
INSIGHT_GENERATOR,
DASHBOARD_CREATOR
Example:

"TIER_1_SUPPORT"

status
enum<string>
default:INACTIVE

Agent status

Available options:
ACTIVE,
INACTIVE,
ERROR,
DEPLOYING
Example:

"INACTIVE"

Agent logo URL

Maximum string length: 500
Example:

"https://example.com/logo.png"

repositoryUrl
string

Repository URL

Maximum string length: 500
Example:

"https://github.com/user/agent-repo"

endpointUrl
string

Agent endpoint URL

Maximum string length: 500
Example:

"https://api.example.com/agent/endpoint"

code
string

Agent source code

Example:

"export function main() { return \"Hello World\"; }"

fileTree
object

File tree structure for IDE-like interface

Example:
language
string
default:typescript

Programming language

Maximum string length: 50
Example:

"typescript"

branch
string
default:main

Git branch

Maximum string length: 100
Example:

"main"

commit
string

Git commit hash

Maximum string length: 100
Example:

"abc123def456"

tags
string[]

Agent tags

Example:
templateId
enum<string>

Template ID for project initialization (from /public/templates)

Available options:
starter,
rag-agent,
webhook-handler
Maximum string length: 50
Example:

"starter"

lastDeploy
string<date-time>

Last deployment timestamp

Example:

"2025-01-01T00:00:00.000Z"

newEngine
boolean

Use new executor-engine (Go) instead of legacy execution-engine (NestJS)

Example:

true

Response

200 - application/json

Agent updated successfully.

id
string
required

Agent unique identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string
required

Agent name

Example:

"Customer Support Bot"

description
string
required

Agent description

Example:

"AI-powered customer support agent"

category
enum<string>
required

Agent category

Available options:
SALES,
CUSTOMER_SUPPORT,
VOICE,
OPERATIONS,
FINANCIAL_PREVENTION,
FINANCIAL_RECOVERY,
MARKETING,
ANALYTICS
Example:

"CUSTOMER_SUPPORT"

status
enum<string>
required

Agent status

Available options:
ACTIVE,
INACTIVE,
ERROR,
DEPLOYING
Example:

"ACTIVE"

code
string
required

Agent source code

Example:

"export function main() { return \"Hello World\"; }"

language
string
required

Programming language

Example:

"typescript"

branch
string
required

Git branch

Example:

"main"

tags
string[]
required

Agent tags

Example:
createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-01-01T00:00:00.000Z"

tenantId
string
required

Tenant ID that the agent belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

userId
string
required

User ID that owns the agent

Example:

"123e4567-e89b-12d3-a456-426614174000"

subcategory
enum<string>

Agent subcategory for more specific classification

Available options:
SDR_OUTBOUND,
SDR_INBOUND,
ACCOUNT_MANAGER,
SALES_CLOSER,
LEAD_QUALIFIER,
TIER_1_SUPPORT,
TECHNICAL_SUPPORT,
ESCALATION_HANDLER,
CHAT_SUPPORT,
COLD_CALLING,
CUSTOMER_SERVICE_VOICE,
APPOINTMENT_SETTER,
SURVEY_CALLER,
DATA_PROCESSOR,
WORKFLOW_AUTOMATOR,
QUALITY_CHECKER,
REPORT_GENERATOR,
FRAUD_DETECTOR,
RISK_ASSESSOR,
COMPLIANCE_MONITOR,
DEBT_COLLECTOR,
PAYMENT_NEGOTIATOR,
RECOVERY_SPECIALIST,
CONTENT_CREATOR,
CAMPAIGN_MANAGER,
SOCIAL_MEDIA_MANAGER,
EMAIL_MARKETER,
DATA_ANALYST,
PERFORMANCE_TRACKER,
INSIGHT_GENERATOR,
DASHBOARD_CREATOR
Example:

"TIER_1_SUPPORT"

lastDeploy
string<date-time>

Last deployment timestamp

Example:

"2025-01-01T00:00:00.000Z"

Agent logo URL

Example:

"https://example.com/logo.png"

repositoryUrl
string

Repository URL

Example:

"https://github.com/user/agent-repo"

endpointUrl
string

Agent endpoint URL (populated by provisioning service)

Example:

"https://chatbot.acme.runflow.ai"

fileTree
object

File tree structure for IDE-like interface

Example:
commit
string

Git commit hash

Example:

"abc123def456"

stagingCommit
string

Staging commit hash (latest deploy to staging)

Example:

"2025-01-01T00-00-00-000Z"

stagingEndpointUrl
string

Staging endpoint URL

Example:

"https://staging.runflow.ai/agent/abc123"

_count
object

Agent related statistics

Example:
repositoryName
string

Repository name

Example:

"agent-repo"

scheduleArn
string

AWS Scheduler ARN

Example:

"arn:aws:scheduler:us-east-1:123456789012:schedule/default/my-schedule"

newEngine
boolean

Use new executor-engine (Go) instead of legacy execution-engine (NestJS)

Example:

true