Agents ~ SHIP

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

Response Body

`application/json`

curl -X GET "https://example.com/agents/catalog"

{  "roles": [    {      "key": "researcher",      "name": "string",      "roleLabel": "string",      "blurb": "string"    }  ],  "harnesses": [    {      "id": "hermes",      "label": "string",      "executable": true,      "models": [        {          "id": "string",          "label": "string"        }      ]    }  ],  "builtinAgents": [    {      "key": "string",      "name": "string",      "role": "researcher",      "harness": "hermes",      "model": "string",      "userPrompt": "string",      "skillRepos": [        "string"      ],      "sandboxTemplateKey": "string"    }  ],  "builtinSandboxTemplate": {    "key": "string",    "name": "string",    "dockerfile": "string"  },  "instanceTypes": [    {      "id": "lite",      "label": "string",      "vcpu": "string",      "memory": "string",      "disk": "string"    }  ]}

List the caller's org agents

Response Body

`application/json`

curl -X GET "https://example.com/agents"

{  "data": [    {      "id": "string",      "orgId": "string",      "name": "string",      "role": "researcher",      "harness": "hermes",      "model": "string",      "effort": "string",      "sandboxTemplateId": "string",      "userPrompt": "string",      "skillRepos": [        "string"      ],      "isBuiltin": true,      "createdAt": 0,      "updatedAt": 0    }  ],  "nextCursor": "string"}

Create an agent config

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

role*AgentRoleKey

Value in

"researcher"
"planner"
"builder"
"reviewer"
"deployer"
"tester"

harness*HarnessId

Value in

"hermes"
"pi"
"kilo-code"
"open-code"
"claude-code"
"codex"
"copilot"

model*string

Length1 <= length

effort?string

Length1 <= length

sandbox*|

userPrompt?string

Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.

Lengthlength <= 20000

skillRepos?array<>

Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.

Itemsitems <= 50

Response Body

`application/json`

curl -X POST "https://example.com/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "role": "researcher",    "harness": "hermes",    "model": "string",    "sandbox": {      "kind": "existing",      "templateId": "string"    }  }'

{  "id": "string",  "orgId": "string",  "name": "string",  "role": "researcher",  "harness": "hermes",  "model": "string",  "effort": "string",  "sandboxTemplateId": "string",  "userPrompt": "string",  "skillRepos": [    "string"  ],  "isBuiltin": true,  "createdAt": 0,  "updatedAt": 0}

Fetch an agent by id

Path Parameters

agentId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/agents/string"

{  "id": "string",  "orgId": "string",  "name": "string",  "role": "researcher",  "harness": "hermes",  "model": "string",  "effort": "string",  "sandboxTemplateId": "string",  "userPrompt": "string",  "skillRepos": [    "string"  ],  "isBuiltin": true,  "createdAt": 0,  "updatedAt": 0}

Update an agent config

Path Parameters

agentId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 120

role?AgentRoleKey

Value in

"researcher"
"planner"
"builder"
"reviewer"
"deployer"
"tester"

harness?HarnessId

Value in

"hermes"
"pi"
"kilo-code"
"open-code"
"claude-code"
"codex"
"copilot"

model?string

Length1 <= length

effort?|

Length1 <= length

sandboxTemplateId?string

Length1 <= length

userPrompt?|

Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.

Lengthlength <= 20000

skillRepos?array<>

Deprecated: not read by the pipeline; agent instructions and skills are configured in the target repo.

Itemsitems <= 50

Response Body

`application/json`

curl -X PATCH "https://example.com/agents/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "orgId": "string",  "name": "string",  "role": "researcher",  "harness": "hermes",  "model": "string",  "effort": "string",  "sandboxTemplateId": "string",  "userPrompt": "string",  "skillRepos": [    "string"  ],  "isBuiltin": true,  "createdAt": 0,  "updatedAt": 0}

Delete an agent config

Path Parameters

agentId*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/agents/string"

{  "ok": true,  "id": "string"}

Agents

200application/json

200application/json

401application/json

200application/json

400application/json

403application/json

404application/json

200application/json

404application/json

200application/json

400application/json

403application/json

404application/json

200application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`