API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Agent Configs

Create Agent Config

client.agentConfigs.create(AgentConfigCreateParams { harness, model, name, 5 more } body, RequestOptionsoptions?): AgentConfigCreateResponse { id, allowed_tools, created_at, 9 more }

POST/v5/agent_configs

List Agent Configs

client.agentConfigs.list(AgentConfigListParams { ending_before, limit, sort_by, 2 more } query?, RequestOptionsoptions?): CursorPage<AgentConfigListResponse { id, allowed_tools, created_at, 9 more } >

GET/v5/agent_configs

List MCP Tool Names

client.agentConfigs.listMcpTools(RequestOptionsoptions?): AgentConfigListMcpToolsResponse { , , , 21 more }

GET/v5/agent_configs/mcp_tools

Get Agent Config

client.agentConfigs.retrieve(stringagentConfigID, RequestOptionsoptions?): AgentConfigRetrieveResponse { id, allowed_tools, created_at, 9 more }

GET/v5/agent_configs/{agent_config_id}

Update Agent Config

client.agentConfigs.update(stringagentConfigID, AgentConfigUpdateParams { task_id, allowed_tools, description, 6 more } params, RequestOptionsoptions?): AgentConfigUpdateResponse { id, allowed_tools, created_at, 9 more }

PATCH/v5/agent_configs/{agent_config_id}

Delete Agent Config (hard delete)

client.agentConfigs.delete(stringagentConfigID, RequestOptionsoptions?): AgentConfigDeleteResponse { id, deleted, object }

DELETE/v5/agent_configs/{agent_config_id}

ModelsExpand Collapse

RepoSpec { url, depth, path }

A single repo the agent should clone into its workspace.

Mirrors the per-entry shape the golden agent’s _validate_repos accepts: url is required, the rest are optional passthrough hints. Sent verbatim as task.params.repos so provisioning clones these instead of the deployment-global default.

url: string

maxLength2048

minLength1

depth?: number

minimum1

path?: string

maxLength1024

AgentConfigCreateResponse { id, allowed_tools, created_at, 9 more }

id: string

allowed_tools: Array<string>

created_at: string

formatdate-time

harness: string

model: string

name: string

system_prompt: string

updated_at: string

formatdate-time

description?: string

object?: "agent_config"

persistent_workspace?: boolean

repos?: Array<RepoSpec { url, depth, path } >

url: string

maxLength2048

minLength1

depth?: number

minimum1

path?: string

maxLength1024

AgentConfigListResponse { id, allowed_tools, created_at, 9 more }

id: string

allowed_tools: Array<string>

created_at: string

formatdate-time

harness: string

model: string

name: string

system_prompt: string

updated_at: string

formatdate-time

description?: string

object?: "agent_config"

persistent_workspace?: boolean

repos?: Array<RepoSpec { url, depth, path } >

url: string

maxLength2048

minLength1

depth?: number

minimum1

path?: string

maxLength1024

AgentConfigListMcpToolsResponse = Array<"Slack" | "Linear" | "GitHub" | 21 more>

One of the following:

"Slack"

"Linear"

"GitHub"

"Confluence"

"Notion"

"Datadog"

"PagerDuty"

"Salesforce"

"Figma"

"Granola"

"Jira"

"Gmail"

"GoogleCalendar"

"GoogleDrive"

"GoogleDocs"

"GoogleSheets"

"GoogleSlides"

"Snowflake"

"Redash"

"Tableau"

"Metabase"

"Gong"

"ZoomInfo"

"Clay"

AgentConfigRetrieveResponse { id, allowed_tools, created_at, 9 more }

id: string

allowed_tools: Array<string>

created_at: string

formatdate-time

harness: string

model: string

name: string

system_prompt: string

updated_at: string

formatdate-time

description?: string

object?: "agent_config"

persistent_workspace?: boolean

repos?: Array<RepoSpec { url, depth, path } >

url: string

maxLength2048

minLength1

depth?: number

minimum1

path?: string

maxLength1024

AgentConfigUpdateResponse { id, allowed_tools, created_at, 9 more }

id: string

allowed_tools: Array<string>

created_at: string

formatdate-time

harness: string

model: string

name: string

system_prompt: string

updated_at: string

formatdate-time

description?: string

object?: "agent_config"

persistent_workspace?: boolean

repos?: Array<RepoSpec { url, depth, path } >

url: string

maxLength2048

minLength1

depth?: number

minimum1

path?: string

maxLength1024

AgentConfigDeleteResponse { id, deleted, object }

id: string

deleted: boolean

object?: "agent_config"