RevoEngine Documentation

curl --request POST \ --url https://api.revoengine.com/api/v1/agents \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "On-call incident triage", "serviceAccountUserId": "11111111-1111-4111-8111-111111111111" } '

{ "agentId": "99999999-9999-4999-8999-999999999999", "name": "Release Reporter", "status": "ACTIVE", "serviceAccountUserId": "11111111-1111-4111-8111-111111111111", "config": { "model": "configured-model", "maxTicks": 24 }, "policy": { "maxTicks": 24, "toolNames": [ "ref_search" ] }, "createdBy": "44444444-4444-4444-8444-444444444444", "createdAt": "2026-06-13T10:00:00.000Z", "lastUpdateAt": "2026-06-13T10:15:00.000Z", "lastUpdateBy": "44444444-4444-4444-8444-444444444444", "version": 3, "desc": "Summarizes release status and creates operator updates.", "ownerId": "22222222-2222-4222-8222-222222222222", "ownerType": "USER", "rootStorageEntryId": "33333333-3333-4333-8333-333333333333", "metadata": { "team": "operations" }, "avatar": "https://storage.example/avatar.png", "summary": { "activeRunCount": 1, "queuedInboxCount": 3 } }

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Body

application/json

name

string

required

Stable display name of the agent.

Minimum string length: 1

Example:

"On-call incident triage"

serviceAccountUserId

string<uuid>

required

User id of the service account used as the execution principal.

Example:

"11111111-1111-4111-8111-111111111111"

desc

string

Optional operator-facing description.

Example:

"Investigates production alerts and prepares escalation notes."

ownerId

string<uuid>

Owning user or group id used for visibility and management.

Example:

"22222222-2222-4222-8222-222222222222"

ownerType

string

Owner type, typically USER or GROUP.

Example:

"USER"

metadata

object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:

{ "costCenter": "ops" }

config

object

Persisted Agent identity and runtime defaults, including work mode, persona, instructions, memory policy, and execution limits.

Show child attributes

Example:

{
  "model": "configured-model",
  "reasoningEffort": "medium",
  "workMode": "operator",
  "persona": "pragmatic",
  "maxActiveRootRuns": 2,
  "maxChildRuns": 4,
  "maxConcurrentChildRuns": 2,
  "maxTicks": 80
}

policy

object

Persisted policy constraints such as tool allowlists, agent plugins, and delegation ceilings. Runtime-only route metadata is not configured here.

Show child attributes

Example:

{
  "toolNames": ["slack.send_message", "storage.read"],
  "maxChildRuns": 4,
  "maxConcurrentChildRuns": 2
}

Response

200 - application/json

agentId

string

required

Stable agent id.

Example:

"99999999-9999-4999-8999-999999999999"

name

string

required

Agent display name.

Example:

"Release Reporter"

status

enum<string>

required

Agent lifecycle status.

Available options:

ACTIVE,

PAUSED,

DISABLED

Example:

"ACTIVE"

serviceAccountUserId

string

required

Service account user id used as execution principal.

Example:

"11111111-1111-4111-8111-111111111111"

config

object

required

Persisted agent runtime defaults and identity inputs.

Example:

{
  "model": "configured-model",
  "maxTicks": 24
}

policy

object

required

Persisted execution constraints and role gates.

Example:

{
  "maxTicks": 24,
  "toolNames": ["ref_search"]
}

createdBy

string

required

User id that created the agent.

Example:

"44444444-4444-4444-8444-444444444444"

createdAt

string<date-time>

required

Creation timestamp.

Example:

"2026-06-13T10:00:00.000Z"

lastUpdateAt

string<date-time>

required

Last update timestamp.

Example:

"2026-06-13T10:15:00.000Z"

lastUpdateBy

string

required

User id that last updated the agent.

Example:

"44444444-4444-4444-8444-444444444444"

version

number

required

Optimistic locking version.

Example:

3

desc

string

Operator-facing description.

Example:

"Summarizes release status and creates operator updates."

ownerId

string

Owning user or group id.

Example:

"22222222-2222-4222-8222-222222222222"

ownerType

string

Owner type, typically USER or GROUP.

Example:

"USER"

rootStorageEntryId

string

Agent workspace root storage entry id.

Example:

"33333333-3333-4333-8333-333333333333"

metadata

object

Resource metadata.

Example:

{ "team": "operations" }

avatar

string

Signed avatar URL, when an avatar is configured.

Example:

"https://storage.example/avatar.png"

summary

object

Per-agent operational summary when requested by list or overview endpoints.

Show child attributes

Example:

{
  "activeRunCount": 1,
  "queuedInboxCount": 3
}

Before you start

Platform API

Create an Agent

Authorizations

Body

Response