Get Agent Config

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

GET/v5/agent_configs/{agent_config_id}

Fetch a single stored agent configuration by id, including its persistent_workspace flag and any repos override.

This returns the saved record as-is and does not compute task params; use {agent_config_id}/resolve when you need the config projected into the params a task would run with. A user caller can only read a config they created unless fine-grained access control grants access, while a service account can read any config under the account; a missing or out-of-scope id returns a 404.

ParametersExpand Collapse

agentConfigID: string

ReturnsExpand Collapse

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

Get Agent Config

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const agentConfig = await client.agentConfigs.retrieve('agent_config_id');

console.log(agentConfig.id);

{
  "id": "id",
  "allowed_tools": [
    "string"
  ],
  "created_at": "2019-12-27T18:11:19.117Z",
  "harness": "harness",
  "model": "model",
  "name": "name",
  "system_prompt": "system_prompt",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "agent_config",
  "persistent_workspace": true,
  "repos": [
    {
      "url": "x",
      "depth": 1,
      "path": "path"
    }
  ]
}

Returns Examples

{
  "id": "id",
  "allowed_tools": [
    "string"
  ],
  "created_at": "2019-12-27T18:11:19.117Z",
  "harness": "harness",
  "model": "model",
  "name": "name",
  "system_prompt": "system_prompt",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "agent_config",
  "persistent_workspace": true,
  "repos": [
    {
      "url": "x",
      "depth": 1,
      "path": "path"
    }
  ]
}