Get Agent Options
Get the JSON Schema for a built-in agent’s user-facing kwargs.
GET
/
agents
/
{name}
/
options
cURL
curl --request GET \
--url http://127.0.0.1:{port}/agents/{name}/options \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.agents.options("codex")
print(result)
client.close()
{
"additionalProperties": false,
"properties": {
"base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Inference endpoint override (--base-url).",
"title": "Base Url"
},
"disable_web_search": {
"default": false,
"description": "Disable native web search and fetch tools when supported.",
"title": "Disable Web Search",
"type": "boolean"
},
"reasoning_effort": {
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Model reasoning effort.",
"title": "Reasoning Effort"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Agent CLI version to install. Omit for latest, or to use the version the image already has for agents that check for one.",
"title": "Version"
},
"skip_install": {
"default": false,
"description": "Skip installing the agent; the environment must already provide it and its dependencies.",
"title": "Skip Install",
"type": "boolean"
},
"prompt_template_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Jinja2 template path; must include {{ instruction }}.",
"title": "Prompt Template Path"
},
"config": {
"default": null,
"description": "Native config file path or inline JSON.",
"title": "Config"
},
"reasoning_summary": {
"anyOf": [
{
"enum": [
"auto",
"concise",
"detailed",
"none"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "How model reasoning is summarized.",
"title": "Reasoning Summary"
},
"web_search": {
"anyOf": [
{
"enum": [
"disabled",
"cached",
"live"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Web search mode.",
"title": "Web Search"
},
"dangerously_bypass_hook_trust": {
"default": false,
"description": "Run enabled Codex hooks without persisted trust; use only with vetted hook sources.",
"title": "Dangerously Bypass Hook Trust",
"type": "boolean"
}
},
"title": "CodexOptions",
"type": "object"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"_tag": "<string>",
"type": "about:blank"
}Authorizations
Response
Successful Response
The response is of type Response Get Agent Options Agents Name Options Get · object.
Was this page helpful?
⌘I
cURL
curl --request GET \
--url http://127.0.0.1:{port}/agents/{name}/options \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.agents.options("codex")
print(result)
client.close()
{
"additionalProperties": false,
"properties": {
"base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Inference endpoint override (--base-url).",
"title": "Base Url"
},
"disable_web_search": {
"default": false,
"description": "Disable native web search and fetch tools when supported.",
"title": "Disable Web Search",
"type": "boolean"
},
"reasoning_effort": {
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Model reasoning effort.",
"title": "Reasoning Effort"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Agent CLI version to install. Omit for latest, or to use the version the image already has for agents that check for one.",
"title": "Version"
},
"skip_install": {
"default": false,
"description": "Skip installing the agent; the environment must already provide it and its dependencies.",
"title": "Skip Install",
"type": "boolean"
},
"prompt_template_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Jinja2 template path; must include {{ instruction }}.",
"title": "Prompt Template Path"
},
"config": {
"default": null,
"description": "Native config file path or inline JSON.",
"title": "Config"
},
"reasoning_summary": {
"anyOf": [
{
"enum": [
"auto",
"concise",
"detailed",
"none"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "How model reasoning is summarized.",
"title": "Reasoning Summary"
},
"web_search": {
"anyOf": [
{
"enum": [
"disabled",
"cached",
"live"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Web search mode.",
"title": "Web Search"
},
"dangerously_bypass_hook_trust": {
"default": false,
"description": "Run enabled Codex hooks without persisted trust; use only with vetted hook sources.",
"title": "Dangerously Bypass Hook Trust",
"type": "boolean"
}
},
"title": "CodexOptions",
"type": "object"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"_tag": "<string>",
"type": "about:blank"
}
