python-sdk/docs/agents/reference/agent-schema.json at bc756a30f8a1e8c3493a2fcde3aff3e1c683ee31 · conductor-oss/python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/conductor-oss/python-sdk/blob/main/docs/agents/reference/agent-schema.json",
  "title": "Conductor Python AgentConfig",
  "description": "The public wire shape emitted by AgentConfigSerializer under agentConfig.",
  "$ref": "#/$defs/agentConfig",
  "$defs": {
    "jsonValue": {
      "anyOf": [
        { "type": "string" }, { "type": "number" }, { "type": "integer" },
        { "type": "boolean" }, { "type": "null" },
        { "type": "array", "items": { "$ref": "#/$defs/jsonValue" } },
        { "type": "object", "additionalProperties": { "$ref": "#/$defs/jsonValue" } }
      ]
    },
    "taskReference": {
      "type": "object",
      "required": ["taskName"],
      "properties": { "taskName": { "type": "string", "minLength": 1 } },
      "additionalProperties": false
    },
    "tool": {
      "type": "object",
      "required": ["name"],
      "properties": {
        "name": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "toolType": { "type": "string" },
        "taskName": { "type": "string" },
        "inputSchema": { "type": "object" },
        "outputSchema": { "type": "object" },
        "credentials": { "type": "array", "items": { "type": "string" } },
        "approvalRequired": { "type": "boolean" }
      },
      "additionalProperties": true
    },
    "agentConfig": {
      "type": "object",
      "required": ["name"],
      "properties": {
        "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*$" },
        "model": { "type": ["string", "null"] },
        "baseUrl": { "type": ["string", "null"] },
        "strategy": { "type": ["string", "null"] },
        "maxTurns": { "type": ["integer", "null"], "minimum": 0 },
        "timeoutSeconds": { "type": ["integer", "null"], "minimum": 0 },
        "external": { "type": ["boolean", "null"] },
        "instructions": { "anyOf": [{ "type": "string" }, { "type": "object" }, { "type": "null" }] },
        "tools": { "type": "array", "items": { "$ref": "#/$defs/tool" } },
        "agents": { "type": "array", "items": { "$ref": "#/$defs/agentConfig" } },
        "router": { "anyOf": [{ "$ref": "#/$defs/taskReference" }, { "$ref": "#/$defs/agentConfig" }] },
        "outputType": { "type": "object" },
        "guardrails": { "type": "array", "items": { "type": "object" } },
        "memory": { "type": "object" },
        "maxTokens": { "type": "integer", "minimum": 0 },
        "contextWindowBudget": { "type": "integer", "minimum": 0 },
        "temperature": { "type": "number" },
        "reasoningEffort": { "type": "string" },
        "stopWhen": { "$ref": "#/$defs/taskReference" },
        "termination": { "type": "object" },
        "handoffs": { "type": "array", "items": { "type": "object" } },
        "allowedTransitions": { "type": "array", "items": { "type": "string" } },
        "introduction": { "type": "string" },
        "metadata": { "type": "object" },
        "enablePlanning": { "type": "boolean" },
        "planner": { "$ref": "#/$defs/agentConfig" },
        "fallback": { "$ref": "#/$defs/agentConfig" },
        "callbacks": { "type": "array", "items": { "type": "object" } },
        "includeContents": { "type": "boolean" },
        "thinkingConfig": { "type": "object" },
        "requiredTools": { "type": "array", "items": { "type": "string" } },
        "prefillTools": { "type": "array", "items": { "type": "object" } },
        "fallbackMaxTurns": { "type": "integer", "minimum": 0 },
        "planSource": { "type": "string" },
        "plannerContext": { "type": "array", "items": { "type": "object" } },
        "synthesize": { "type": "boolean" },
        "maskedFields": { "type": "array", "items": { "type": "string" } },
        "gate": { "type": "object" },
        "codeExecution": { "type": "object" },
        "cliConfig": { "type": "object" },
        "credentials": { "type": "array", "items": { "type": "string" } },
        "_framework": { "type": "string" }
      },
      "additionalProperties": false
    }
  }
}