---
title: "Read-only catalog: roles, harnesses + models, built-in agents, default sandbox template"
method: GET
path: "/agents/catalog"
tags: ["agents"]
---

# Read-only catalog: roles, harnesses + models, built-in agents, default sandbox template

`GET /agents/catalog`

## Request

- Base URL: `https://api.letsship.ai/v1`
- URL: `https://api.letsship.ai/v1/agents/catalog`
- Auth: none declared

## Response `200`

Catalog

- AgentCatalog
  - `roles` CatalogRole[], required
    - `key` 'researcher' | 'planner' | 'builder' | 'reviewer' | 'deployer' | 'tester', required
    - `name` string, required
    - `roleLabel` string, required
    - `blurb` string, required
  - `harnesses` CatalogHarness[], required
    - `id` 'hermes' | 'pi' | 'kilo-code' | 'open-code' | 'claude-code' | 'codex' | 'copilot', required
    - `label` string, required
    - `executable` boolean, required
    - `models` CatalogModel[], required
      - `id` string, required
      - `label` string, required
  - `builtinAgents` CatalogBuiltinAgent[], required
    - `key` string, required
    - `name` string, required
    - `role` 'researcher' | 'planner' | 'builder' | 'reviewer' | 'deployer' | 'tester', required
    - `harness` 'hermes' | 'pi' | 'kilo-code' | 'open-code' | 'claude-code' | 'codex' | 'copilot', required
    - `model` string, required
    - `userPrompt` string, required: Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.
    - `skillRepos` string[], required: Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.
    - `sandboxTemplateKey` string, required
  - `builtinSandboxTemplate` CatalogSandboxTemplate, required
    - `key` string, required
    - `name` string, required
    - `dockerfile` string, required
  - `instanceTypes` CatalogInstanceType[], required
    - `id` 'lite' | 'basic' | 'standard-1' | 'standard-2' | 'standard-3' | 'standard-4', required
    - `label` string, required
    - `vcpu` string, required
    - `memory` string, required
    - `disk` string, required
  - `customSizeLimits` object, required
    - `minVcpu` integer, required
    - `maxVcpu` integer, required
    - `minMemoryMibPerVcpu` integer, required
    - `maxMemoryMib` integer, required
    - `minDiskMb` integer, required
    - `maxDiskMb` integer, required

---

[API](https://skmtc.dev/letsship/apis/ship-api.md) · [All operations](https://skmtc.dev/letsship/apis/ship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/letsship/apis/ship-api/revisions/e6eac1bcadd4?raw)