Archive Agent

Archive Agent through the OMA API.

POST /v1/agents/{agent_id}/archive

Archive Agent

cURL

curl --request POST \
  --url http://localhost:38080/v1/agents/{agent_id}/archive \
  --header 'X-Api-Key: <api-key>'

200

{
  "id": "agent_011CZkYpogX7uDKUyvBTophP",
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "description": "A general-purpose starter agent.",
  "mcp_servers": [
    {
      "name": "example-mcp",
      "type": "url",
      "url": "https://example-server.modelcontextprotocol.io/sse"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "model": {
    "id": "claude-sonnet-4-6",
    "effort": {
      "type": "low"
    },
    "inference_geo": "inference_geo",
    "speed": "standard"
  },
  "multiagent": {
    "agents": [
      {
        "id": "agent_011CZkYqphY8vELVzwCUpqiQ",
        "type": "agent",
        "version": 1
      }
    ],
    "type": "coordinator"
  },
  "name": "My First Agent",
  "skills": [
    {
      "skill_id": "xlsx",
      "type": "anthropic",
      "version": "1"
    },
    {
      "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx",
      "type": "custom",
      "version": "2"
    }
  ],
  "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.",
  "tools": [
    {
      "configs": [
        {
          "enabled": true,
          "name": "bash",
          "permission_policy": {
            "type": "always_allow"
          }
        }
      ],
      "default_config": {
        "enabled": true,
        "permission_policy": {
          "type": "always_ask"
        }
      },
      "type": "agent_toolset_20260401"
    }
  ],
  "type": "agent",
  "updated_at": "2026-03-15T10:00:00Z",
  "version": 1
}

Every request requires ?beta=true.

Authorizations

omaApiKeyomaBearer

X-Api-Key · string · header · default: sk-ant-local-default · required

OMA workspace API key.

Headers

anthropic-version · string

The OMA API compatibility version to use.

anthropic-beta · string

Beta header that enables the Managed Agents API contract.

Path Parameters

agent_id · string · required

Path parameter agent_id

Query Parameters

beta · enum<boolean> · required

Selects the beta API contract for this endpoint. Must be true.

Available options: true

Response

200

application/json

Successful response (OK)

A Managed Agents agent.

id · string · required

Example:

"agent_011CZkYpogX7uDKUyvBTophP"

archived_at · string<date-time> | null · required

When the agent was archived. Null if not archived.

Example:

null

created_at · string<date-time> · required

A timestamp in RFC 3339 format

Example:

"2026-03-15T10:00:00Z"

description · string | null · required

Example:

"A general-purpose starter agent."

mcp_servers · object[] · required

Show child attributes

Example:

[
  {
    "type": "url",
    "name": "example-mcp",
    "url": "https://example-server.modelcontextprotocol.io/sse"
  }
]

metadata · object · required

Show child attributes

Example:

{ "foo": "bar" }

model · object · required

Model identifier and configuration.

Show child attributes

Example:

{
  "id": "claude-sonnet-4-6",
  "effort": { "type": "low" },
  "inference_geo": "inference_geo",
  "speed": "standard"
}

multiagent · object | null · required

Multiagent orchestration configuration. Null when the agent is single-threaded.

Show child attributes

Example:

{
  "agents": [
    {
      "id": "agent_011CZkYqphY8vELVzwCUpqiQ",
      "type": "agent",
      "version": 1
    }
  ],
  "type": "coordinator"
}

name · string · required

Example:

"My First Agent"

skills · object[] · required

Resolved skill as returned in API responses.

Option 1

Option 2

Show child attributes

Example:

{
  "type": "anthropic",
  "skill_id": "xlsx",
  "version": "1"
}

Example:

[
  {
    "type": "anthropic",
    "skill_id": "xlsx",
    "version": "1"
  },
  {
    "type": "custom",
    "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx",
    "version": "2"
  }
]

system · string | null · required

Example:

"You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end."

tools · object[] · required

Union type for tool configurations returned in API responses.

Option 1

Option 2

Option 3

Show child attributes

Example:

[
  {
    "configs": [
      {
        "enabled": true,
        "name": "bash",
        "permission_policy": { "type": "always_allow" }
      }
    ],
    "default_config": {
      "enabled": true,
      "permission_policy": { "type": "always_ask" }
    },
    "type": "agent_toolset_20260401"
  }
]

type · enum<string> · required

Available options: agent

Example:

"agent"

updated_at · string<date-time> · required

A timestamp in RFC 3339 format

Example:

"2026-03-15T10:00:00Z"

version · integer<int32> · required

The agent's current version. Starts at 1 and increments when the agent is modified.

Example:

1