---
title: "Get agent"
method: GET
path: "/api/agents/{id}"
tags: ["Platform API"]
---

# Get agent

`GET /api/agents/{id}`

Get one configured Outlit agent by id. Read-only.

## Path parameters

- `id` string, required

## Response `200`

The configured agent was returned.

- GetAgentCommandSuccess
  - `ok` true, required
  - `commandId` 'agent.get', required
  - `commandVersion` 1, required
  - `correlationId` string, required
  - `result` object, required
    - `operationId` 'agent.get', required
    - `status` 'completed', required
    - `resources` CommandResource[], required
      - `type` string, required
      - `id` string, required
    - `data` object, required
      - `agent` AgentDetail, required
        - `id` string, required
        - `agentKey` string, required
        - `displayName` string, required
        - `status` 'ENABLED' | 'DISABLED', required
        - `templateVersion` string, required
        - `actionKeys` string[], required
        - `schedule` AgentScheduleDetail, required
          - `enabled` boolean, required
          - `nextRunAt` string, date-time, nullable, required
          - `lastRunAt` string, date-time, nullable, required
          - `lastSuccessfulRunAt` string, date-time, nullable, required
          - `cadence` 'daily' | 'weekly' | 'null', nullable, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `destinationSummary` AgentDetailDestinationSummary, required
          - `destinations` object[], required
            - `id` string, uuid, required
            - `provider` 'slack', required
            - `channelId` string, nullable, required
            - `label` string, nullable, required
            - `isDefault` boolean, required
          - `label` string, required
          - `count` integer, required
          - `missing` boolean, required
        - `automationSummary` AgentDetailAutomationRollup, required
          - `activeCount` integer, required
          - `totalCount` integer, required
          - `nextRunAt` string, date-time, nullable, required
          - `primaryDestinationLabel` string, nullable, required
        - `automations` AgentDetailAutomationSummary[], required
          - `id` string, uuid, required
          - `name` string, required
          - `enabled` boolean, required
          - `conditionKind` 'schedule' | 'event_happens' | 'activity_spikes' | 'activity_stops' | 'customer_activity_threshold' | 'customer_activity_drop' | 'related_user_inactivity' | 'unknown', required
          - `conditionLabel` string, required
          - `audienceLabel` string, required
          - `destinationLabel` string, required
          - `destinationCount` integer, required
          - `lastRunStatus` 'PENDING' | 'SKIPPED' | 'RUNNING_PROCESSOR' | 'READY_FOR_DELIVERY' | 'PENDING_DELIVERY' | 'DELIVERED' | 'PARTIAL_FAILURE' | 'FAILED', required
          - `lastRunAt` string, date-time, nullable, required
          - `nextRunAt` string, date-time, nullable, required
        - `lastRun` AgentRunSummary, required
          - `id` string, required
          - `runId` string, required
          - `agentId` string, required
          - `status` 'RUNNING' | 'COMPLETED' | 'FAILED' | 'PARTIAL', required
          - `trigger` 'manual' | 'scheduled' | 'event' | 'signal' | 'null', nullable, required
          - `summary` string, nullable, required
          - `errorSummary` string, nullable, required
          - `sandboxStatus` string, nullable, required
          - `startedAt` string, date-time, required
          - `endedAt` string, date-time, nullable, required
          - `durationMs` integer, nullable, required
          - `counts` AgentRunCounts, required
            - `candidates` integer, required
            - `tools` integer, required
            - `artifacts` integer, required
            - `outputs` integer, required
          - `outputs` AgentRunOutputSummary[], required
            - `id` string, required
            - `status` 'PENDING' | 'VALID' | 'INVALID' | 'PROCESSED', required
            - `deliveryStatus` 'NOT_REQUIRED' | 'PENDING' | 'SENT' | 'FAILED' | 'PARTIAL', required
            - `deliveredAt` string, date-time, nullable, required
            - `createdAt` string, date-time, required
        - `recentRuns` AgentRunSummary[], required
          - `id` string, required
          - `runId` string, required
          - `agentId` string, required
          - `status` 'RUNNING' | 'COMPLETED' | 'FAILED' | 'PARTIAL', required
          - `trigger` 'manual' | 'scheduled' | 'event' | 'signal' | 'null', nullable, required
          - `summary` string, nullable, required
          - `errorSummary` string, nullable, required
          - `sandboxStatus` string, nullable, required
          - `startedAt` string, date-time, required
          - `endedAt` string, date-time, nullable, required
          - `durationMs` integer, nullable, required
          - `counts` AgentRunCounts, required
            - `candidates` integer, required
            - `tools` integer, required
            - `artifacts` integer, required
            - `outputs` integer, required
          - `outputs` AgentRunOutputSummary[], required
            - `id` string, required
            - `status` 'PENDING' | 'VALID' | 'INVALID' | 'PROCESSED', required
            - `deliveryStatus` 'NOT_REQUIRED' | 'PENDING' | 'SENT' | 'FAILED' | 'PARTIAL', required
            - `deliveredAt` string, date-time, nullable, required
            - `createdAt` string, date-time, required
        - `settings` AgentDetailSettings, required
          - `configSchemaKey` string, required
          - `configSchemaVersion` integer, required
          - `custom` CustomAgentSettingsSummary, required
            - `instructions` string, required
            - `maxItemsToSurface` integer, required
            - `outputMode` 'alert' | 'digest' | 'action_list' | 'null', nullable, required
    - `warnings` string[], required
    - `auditId` string

## Other responses

- `401` — Invalid or missing API key.
- `403` — The API key is valid but does not have the required agent read scope.
- `404` — No agent was found for the authenticated organization and requested id.
- `500` — Internal server error.
- `503` — The platform could not get the agent.

## Changes

- **2026-07-01** `69ab63e7045c` — 2 breaking
  - removed the required property `result/allOf[subschema #2]/data/agent/settings/anyOf[#/components/schemas/AgentDetailSettings]/custom/anyOf[#/components/schemas/CustomAgentSettingsSummary]/skipCriteria` from the response with the `200` status
  - removed the required property `result/allOf[subschema #2]/data/agent/settings/anyOf[#/components/schemas/AgentDetailSettings]/custom/anyOf[#/components/schemas/CustomAgentSettingsSummary]/surfaceCriteria` from the response with the `200` status
- **2026-06-30** `891af08cfdc0` — 7 info
  - added the required property `result/allOf[subschema #2]/data/agent/automationSummary` to the response with the `200` status
  - added the required property `result/allOf[subschema #2]/data/agent/automations` to the response with the `200` status
  - added the required property `result/allOf[subschema #2]/data/agent/destinationSummary` to the response with the `200` status
  - added the required property `result/allOf[subschema #2]/data/agent/lastRun` to the response with the `200` status
  - …3 more
- **2026-06-29** `7e4ecacaa07f` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/outlitai/apis/outlit-api/changes/api/agents/:id/get.md)

---

[API](https://skmtc.dev/outlitai/apis/outlit-api.md) · [All operations](https://skmtc.dev/outlitai/apis/outlit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/outlitai/outlit-api/revisions/147173adbb3f/schema)