The resources returned in this page, in the requested sort order.
One of the following: PeriodicAutomation { id, created_at, created_by, 9 more } Fields shared by periodic and one-time automations.
id: string The automation ID.
minLength0 created_at: integer The creation time as a Unix timestamp in seconds.
formatint64 created_by: AutomationCreatedBy Service-recorded provenance; callers cannot supply this field.
One of the following: Developer { type } type: "developer" (default: "developer") The type of the object. Always developer.
Agent { session_id, tool_call_id, type } session_id: string The creator session, which is also the automation’s target.
minLength0 tool_call_id: string The tool call that created the automation.
minLength0 type: "agent" (default: "agent") The type of the object. Always agent.
expression: string The cron expression determining scheduled occurrences.
minLength0 metadata: map[string] Custom string key-value pairs attached to the automation.
name: string The automation’s display name.
minLength0 object: "agent.automation" (default: "agent.automation") Always agent.automation.
status: "active" or "paused" Whether scheduled delivery is active or paused.
One of the following: "active" "paused" target: AutomationTarget The session configuration or existing session receiving invocations.
One of the following: NewSession { agent, agent_id, environment, 4 more } agent: AutomationAgentConfig or null The inline agent configuration, or null when agent_id is configured.
instructions: string or null Custom instructions, or null when absent.
minLength0 model: string The requested model name.
minLength0 multi_agent: MultiAgentConfig { enabled, max_concurrent_subagents } The configuration for creating and coordinating subagents.
enabled: boolean Whether subagent tools are enabled. Defaults to false.
max_concurrent_subagents: integer or null Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.
formatint64 minimum1 maximum4294967295 reasoning: AgentReasoning { effort, summary } The configured reasoning policy.
effort: "none" or "minimal" or "low" or 4 more or null The requested reasoning effort, or null when the model selects its own default.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" summary: "concise" or "detailed" or "auto" or null The requested reasoning summary format, or null when summaries are disabled.
One of the following: "concise" Returns a concise reasoning summary when supported.
"detailed" Returns a detailed reasoning summary when supported.
"auto" Automatically selects the most detailed summary supported by the model.
service_tier: "auto" or "default" or "flex" or 3 more The configured service-tier policy.
One of the following: "auto" "default" "flex" "priority" "fast" "ultrafast" text: AgentText { format, verbosity } The configured output format and verbosity.
format: TextFormat The effective output format. Defaults to ordinary text.
One of the following: Text { type } Generates ordinary text without a structured-output constraint.
type: "text" (default: "text") The type of the object. Always text.
JSONSchema { schema, type } Constrains generated text to a JSON Schema.
schema: map[unknown] The JSON Schema that generated text must match.
type: "json_schema" (default: "json_schema") The type of the object. Always json_schema.
verbosity: "low" or "medium" or "high" The amount of text produced by the agent. Defaults to medium.
One of the following: "low" "medium" "high" tools: array of AgentTool Configured tools, excluding confidential credentials.
minItems0 maxItems2000 One of the following: Function { defer_loading, description, name, 3 more } A function defined by the application.
defer_loading: boolean Whether the function is deferred and discovered through tool search.
description: string A description of what the function does.
minLength0 name: string The name of the function.
minLength0 parameters: map[unknown] A JSON Schema object describing the function’s arguments.
type: "function" (default: "function") The type of the object. Always function.
async: optional boolean Whether the agent continues without waiting for the function result.
ProgrammaticToolCalling { enabled, type } Enables calling tools from model-generated code.
enabled: boolean Whether tools can be called from model-generated code.
type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the object. Always programmatic_tool_calling.
Mcp { allowed_tools, connection_origin, credential_id, 5 more } Tools provided by a remote MCP server.
allowed_tools: array of string or null The MCP tools the agent may call.
minItems0 maxItems2000 connection_origin: "service" or "environment" Where outbound MCP HTTP connections originate.
One of the following: "service" "environment" credential_id: string or null The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.
minLength0 request_metadata: map[unknown] Metadata included with requests to this MCP server.
required: boolean Whether this MCP server must initialize before the first turn.
server_label: string A label used to identify the MCP server in tool calls.
minLength0 transport: McpTransport The transport used to connect to the MCP server.
One of the following: HTTP { server_url, type } Connects to an MCP server over HTTP.
server_url: string The URL of the MCP server.
minLength0 type: "http" (default: "http") The type of the object. Always http.
Stdio { args, command, cwd, 2 more } Starts an MCP server as a local process.
args: array of string Arguments passed to the MCP server command.
minItems0 maxItems2000 command: string The command used to start the MCP server.
minLength0 cwd: string The working directory used to start the MCP server.
minLength0 env_vars: array of string Environment variable names inherited from the execution environment.
minItems0 maxItems2000 type: "stdio" (default: "stdio") The type of the object. Always stdio.
type: "mcp" (default: "mcp") The type of the object. Always mcp.
WebSearch { allowed_domains, context_size, location, 2 more } Web search.
allowed_domains: array of string or null Allowed search domains, or null when the search is unrestricted.
minItems0 maxItems2000 context_size: "low" or "medium" or "high" The amount of search context made available to the model. Defaults to medium.
One of the following: "low" "medium" "high" location: object or null Approximate location used to localize search results, if provided.
city: string or null The city name.
minLength0 country: string or null The two-letter ISO country code, such as US.
minLength0 region: string or null The region or state name.
minLength0 timezone: string or null The IANA timezone, such as America/Los_Angeles.
minLength0 mode: "disabled" or "cached" or "live" The source used for web search results.
One of the following: "disabled" "cached" "live" type: "web_search" (default: "web_search") The type of the object. Always web_search.
ComputerUse { include_screenshots, type } Browser use in an OpenAI-hosted session.
include_screenshots: boolean Whether computer tool outputs include screenshots.
type: "computer_use" (default: "computer_use") The type of the object. Always computer_use.
Automations { type } Lets the agent manage its own scheduled wakeups.
type: "automations" (default: "automations") The type of the object. Always automations.
compaction: optional { async } The effective context compaction settings.
async: boolean Whether context is compacted in the background. Defaults to false.
experimental: optional { time_awareness } The effective experimental settings for the agent.
time_awareness: boolean Whether the model receives periodic current-time reminders.
agent_id: string or null The saved agent reference, or null when an inline agent is configured.
minLength0 environment: AutomationEnvironment Configuration or references used to select the execution environment.
One of the following: None { type } type: "none" (default: "none") The type of the object. Always none.
OpenAIHosted { capability_directories, container_size, desktop, 8 more } Hosted environment selection with confidential setup commands and variables omitted.
capability_directories: array of string or null Directory overrides, or null to inherit the template or creation default.
minItems0 maxItems2000 container_size: "small" or "medium" or "large" or null The configured container size, or null to use the creation default.
One of the following: "small" "medium" "large" desktop: object or null Desktop overrides, or null to inherit the template or creation default.
enabled: boolean Whether the environment provisions a desktop and browser proxy.
environment_id: string or null An existing environment reference, or null when provisioning a new environment.
minLength0 environment_template_id: string or null A template reference, or null when no template is selected.
minLength0 files: array of FileID or Inline or null File overrides, excluding contents, or null to inherit.
minItems0 maxItems2000 One of the following: FileID { file_id, path, type } A project-scoped Files API reference resolved separately for each session.
file_id: string The ID of the uploaded file.
minLength0 path: string The file’s absolute path inside the environment.
minLength0 type: "file_id" (default: "file_id") The type of the object. Always file_id.
Inline { path, size_bytes, type } Metadata for confidential inline file contents.
path: string The file’s absolute path inside the environment.
minLength0 size_bytes: integer The decoded size of the inline file in bytes.
formatint64 minimum0 type: "inline" (default: "inline") The type of the object. Always inline.
network: object or null Network overrides, or null to inherit the template or creation default.
access: "enabled" or "disabled" or "restricted" The environment’s network access mode.
One of the following: "enabled" Allows unrestricted network access.
"disabled" Disables network access.
"restricted" Applies the configured domain restrictions.
allowed_domains: array of string Domains the environment may access when network access is restricted.
minItems0 maxItems2000 packages: object or null Package overrides, or null to inherit the template or creation default.
npm: array of string npm packages installed globally in the environment.
minItems0 maxItems16384 python: array of string Python packages installed in the environment.
minItems0 maxItems16384 system: array of string System packages installed in the environment.
minItems0 maxItems16384 plugins: array of HostedPlugin or null Plugin overrides, excluding archive contents, or null to inherit.
minItems0 maxItems2000 description: string The installed plugin description.
minLength0 name: string The installed plugin name.
minLength0 type: "inline" (default: "inline") The type of the object. Always inline.
skills: array of SkillReference or Inline or null Skill overrides, excluding archive contents, or null to inherit.
minItems0 maxItems2000 One of the following: SkillReference { skill_id, type, version } A skill resolved afresh from the Skills API whenever a session starts.
skill_id: string The referenced skill ID.
minLength0 type: "skill_reference" (default: "skill_reference") The type of the object. Always skill_reference.
version: string or null The requested version selector, including latest.
minLength0 Inline { description, name, type } Safe metadata for an inline skill archive.
description: string The skill description declared in SKILL.md.
minLength0 name: string The skill name declared in SKILL.md.
minLength0 type: "inline" (default: "inline") The type of the object. Always inline.
type: "openai_hosted" (default: "openai_hosted") The type of the object. Always openai_hosted.
SelfHosted { capability_directories, environment_id, type, workspace_directory } capability_directories: array of string Directories that expose capabilities to the agent.
minItems0 maxItems2000 environment_id: string or null An existing registration, or null to create a session-owned environment.
minLength0 type: "self_hosted" (default: "self_hosted") The type of the object. Always self_hosted.
workspace_directory: string The absolute project directory in the environment.
minLength0 input: array of { content, role, type } Initial input delivered to each new session.
minItems0 maxItems2000 content: array of InputContent The content of the message.
minItems0 maxItems2000 One of the following: InputText { text, type } Text input recorded in a session item.
text: string The text supplied to the agent.
minLength0 type: "input_text" (default: "input_text") The type of the object. Always input_text.
InputImage { image_url, type } Image input recorded in a session item.
image_url: string The URL of the image supplied to the agent, which may be a base64-encoded data URL.
minLength0 type: "input_image" (default: "input_image") The type of the object. Always input_image.
role: "user" (default: "user") The role of the message author. Always user.
type: "message" (default: "message") The type of the input item. Always message.
metadata: map[string] Metadata attached to each new session.
type: "new_session" (default: "new_session") The type of the object. Always new_session.
vault_ids: array of string Vaults made available to each new session.
minItems0 maxItems2000 ExistingSession { instructions, session_id, type } instructions: string Saved instructions delivered as an automation notification.
minLength0 session_id: string The session receiving each invocation.
minLength0 type: "existing_session" (default: "existing_session") The type of the object. Always existing_session.
timezone: string The timezone used to interpret the expression.
minLength0 type: "periodic" (default: "periodic") The type of the object. Always periodic.
pause_reason: optional "target_session_failed" or null (default: "target_session_failed") Why the service paused this schedule, or null for other schedules.
OneTimeAutomation { id, created_at, created_by, 8 more } Fields shared by periodic and one-time automations.
id: string The automation ID.
minLength0 created_at: integer The creation time as a Unix timestamp in seconds.
formatint64 created_by: AutomationCreatedBy Service-recorded provenance; callers cannot supply this field.
One of the following: Developer { type } type: "developer" (default: "developer") The type of the object. Always developer.
Agent { session_id, tool_call_id, type } session_id: string The creator session, which is also the automation’s target.
minLength0 tool_call_id: string The tool call that created the automation.
minLength0 type: "agent" (default: "agent") The type of the object. Always agent.
metadata: map[string] Custom string key-value pairs attached to the automation.
name: string The automation’s display name.
minLength0 object: "agent.automation" (default: "agent.automation") Always agent.automation.
run_at: integer The Unix timestamp, in seconds, of the scheduled occurrence.
formatint64 status: "active" or "paused" or "completed" Completion means the schedule has finished, not the agent’s work.
One of the following: "active" "paused" "completed" target: AutomationTarget The session configuration or existing session receiving invocations.
One of the following: NewSession { agent, agent_id, environment, 4 more } agent: AutomationAgentConfig or null The inline agent configuration, or null when agent_id is configured.
instructions: string or null Custom instructions, or null when absent.
minLength0 model: string The requested model name.
minLength0 multi_agent: MultiAgentConfig { enabled, max_concurrent_subagents } The configuration for creating and coordinating subagents.
enabled: boolean Whether subagent tools are enabled. Defaults to false.
max_concurrent_subagents: integer or null Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.
formatint64 minimum1 maximum4294967295 reasoning: AgentReasoning { effort, summary } The configured reasoning policy.
effort: "none" or "minimal" or "low" or 4 more or null The requested reasoning effort, or null when the model selects its own default.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" summary: "concise" or "detailed" or "auto" or null The requested reasoning summary format, or null when summaries are disabled.
One of the following: "concise" Returns a concise reasoning summary when supported.
"detailed" Returns a detailed reasoning summary when supported.
"auto" Automatically selects the most detailed summary supported by the model.
service_tier: "auto" or "default" or "flex" or 3 more The configured service-tier policy.
One of the following: "auto" "default" "flex" "priority" "fast" "ultrafast" text: AgentText { format, verbosity } The configured output format and verbosity.
format: TextFormat The effective output format. Defaults to ordinary text.
One of the following: Text { type } Generates ordinary text without a structured-output constraint.
type: "text" (default: "text") The type of the object. Always text.
JSONSchema { schema, type } Constrains generated text to a JSON Schema.
schema: map[unknown] The JSON Schema that generated text must match.
type: "json_schema" (default: "json_schema") The type of the object. Always json_schema.
verbosity: "low" or "medium" or "high" The amount of text produced by the agent. Defaults to medium.
One of the following: "low" "medium" "high" tools: array of AgentTool Configured tools, excluding confidential credentials.
minItems0 maxItems2000 One of the following: Function { defer_loading, description, name, 3 more } A function defined by the application.
defer_loading: boolean Whether the function is deferred and discovered through tool search.
description: string A description of what the function does.
minLength0 name: string The name of the function.
minLength0 parameters: map[unknown] A JSON Schema object describing the function’s arguments.
type: "function" (default: "function") The type of the object. Always function.
async: optional boolean Whether the agent continues without waiting for the function result.
ProgrammaticToolCalling { enabled, type } Enables calling tools from model-generated code.
enabled: boolean Whether tools can be called from model-generated code.
type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the object. Always programmatic_tool_calling.
Mcp { allowed_tools, connection_origin, credential_id, 5 more } Tools provided by a remote MCP server.
allowed_tools: array of string or null The MCP tools the agent may call.
minItems0 maxItems2000 connection_origin: "service" or "environment" Where outbound MCP HTTP connections originate.
One of the following: "service" "environment" credential_id: string or null The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.
minLength0 request_metadata: map[unknown] Metadata included with requests to this MCP server.
required: boolean Whether this MCP server must initialize before the first turn.
server_label: string A label used to identify the MCP server in tool calls.
minLength0 transport: McpTransport The transport used to connect to the MCP server.
One of the following: HTTP { server_url, type } Connects to an MCP server over HTTP.
server_url: string The URL of the MCP server.
minLength0 type: "http" (default: "http") The type of the object. Always http.
Stdio { args, command, cwd, 2 more } Starts an MCP server as a local process.
args: array of string Arguments passed to the MCP server command.
minItems0 maxItems2000 command: string The command used to start the MCP server.
minLength0 cwd: string The working directory used to start the MCP server.
minLength0 env_vars: array of string Environment variable names inherited from the execution environment.
minItems0 maxItems2000 type: "stdio" (default: "stdio") The type of the object. Always stdio.
type: "mcp" (default: "mcp") The type of the object. Always mcp.
WebSearch { allowed_domains, context_size, location, 2 more } Web search.
allowed_domains: array of string or null Allowed search domains, or null when the search is unrestricted.
minItems0 maxItems2000 context_size: "low" or "medium" or "high" The amount of search context made available to the model. Defaults to medium.
One of the following: "low" "medium" "high" location: object or null Approximate location used to localize search results, if provided.
city: string or null The city name.
minLength0 country: string or null The two-letter ISO country code, such as US.
minLength0 region: string or null The region or state name.
minLength0 timezone: string or null The IANA timezone, such as America/Los_Angeles.
minLength0 mode: "disabled" or "cached" or "live" The source used for web search results.
One of the following: "disabled" "cached" "live" type: "web_search" (default: "web_search") The type of the object. Always web_search.
ComputerUse { include_screenshots, type } Browser use in an OpenAI-hosted session.
include_screenshots: boolean Whether computer tool outputs include screenshots.
type: "computer_use" (default: "computer_use") The type of the object. Always computer_use.
Automations { type } Lets the agent manage its own scheduled wakeups.
type: "automations" (default: "automations") The type of the object. Always automations.
compaction: optional { async } The effective context compaction settings.
async: boolean Whether context is compacted in the background. Defaults to false.
experimental: optional { time_awareness } The effective experimental settings for the agent.
time_awareness: boolean Whether the model receives periodic current-time reminders.
agent_id: string or null The saved agent reference, or null when an inline agent is configured.
minLength0 environment: AutomationEnvironment Configuration or references used to select the execution environment.
One of the following: None { type } type: "none" (default: "none") The type of the object. Always none.
OpenAIHosted { capability_directories, container_size, desktop, 8 more } Hosted environment selection with confidential setup commands and variables omitted.
capability_directories: array of string or null Directory overrides, or null to inherit the template or creation default.
minItems0 maxItems2000 container_size: "small" or "medium" or "large" or null The configured container size, or null to use the creation default.
One of the following: "small" "medium" "large" desktop: object or null Desktop overrides, or null to inherit the template or creation default.
enabled: boolean Whether the environment provisions a desktop and browser proxy.
environment_id: string or null An existing environment reference, or null when provisioning a new environment.
minLength0 environment_template_id: string or null A template reference, or null when no template is selected.
minLength0 files: array of FileID or Inline or null File overrides, excluding contents, or null to inherit.
minItems0 maxItems2000 One of the following: FileID { file_id, path, type } A project-scoped Files API reference resolved separately for each session.
file_id: string The ID of the uploaded file.
minLength0 path: string The file’s absolute path inside the environment.
minLength0 type: "file_id" (default: "file_id") The type of the object. Always file_id.
Inline { path, size_bytes, type } Metadata for confidential inline file contents.
path: string The file’s absolute path inside the environment.
minLength0 size_bytes: integer The decoded size of the inline file in bytes.
formatint64 minimum0 type: "inline" (default: "inline") The type of the object. Always inline.
network: object or null Network overrides, or null to inherit the template or creation default.
access: "enabled" or "disabled" or "restricted" The environment’s network access mode.
One of the following: "enabled" Allows unrestricted network access.
"disabled" Disables network access.
"restricted" Applies the configured domain restrictions.
allowed_domains: array of string Domains the environment may access when network access is restricted.
minItems0 maxItems2000 packages: object or null Package overrides, or null to inherit the template or creation default.
npm: array of string npm packages installed globally in the environment.
minItems0 maxItems16384 python: array of string Python packages installed in the environment.
minItems0 maxItems16384 system: array of string System packages installed in the environment.
minItems0 maxItems16384 plugins: array of HostedPlugin or null Plugin overrides, excluding archive contents, or null to inherit.
minItems0 maxItems2000 description: string The installed plugin description.
minLength0 name: string The installed plugin name.
minLength0 type: "inline" (default: "inline") The type of the object. Always inline.
skills: array of SkillReference or Inline or null Skill overrides, excluding archive contents, or null to inherit.
minItems0 maxItems2000 One of the following: SkillReference { skill_id, type, version } A skill resolved afresh from the Skills API whenever a session starts.
skill_id: string The referenced skill ID.
minLength0 type: "skill_reference" (default: "skill_reference") The type of the object. Always skill_reference.
version: string or null The requested version selector, including latest.
minLength0 Inline { description, name, type } Safe metadata for an inline skill archive.
description: string The skill description declared in SKILL.md.
minLength0 name: string The skill name declared in SKILL.md.
minLength0 type: "inline" (default: "inline") The type of the object. Always inline.
type: "openai_hosted" (default: "openai_hosted") The type of the object. Always openai_hosted.
SelfHosted { capability_directories, environment_id, type, workspace_directory } capability_directories: array of string Directories that expose capabilities to the agent.
minItems0 maxItems2000 environment_id: string or null An existing registration, or null to create a session-owned environment.
minLength0 type: "self_hosted" (default: "self_hosted") The type of the object. Always self_hosted.
workspace_directory: string The absolute project directory in the environment.
minLength0 input: array of { content, role, type } Initial input delivered to each new session.
minItems0 maxItems2000 content: array of InputContent The content of the message.
minItems0 maxItems2000 One of the following: InputText { text, type } Text input recorded in a session item.
text: string The text supplied to the agent.
minLength0 type: "input_text" (default: "input_text") The type of the object. Always input_text.
InputImage { image_url, type } Image input recorded in a session item.
image_url: string The URL of the image supplied to the agent, which may be a base64-encoded data URL.
minLength0 type: "input_image" (default: "input_image") The type of the object. Always input_image.
role: "user" (default: "user") The role of the message author. Always user.
type: "message" (default: "message") The type of the input item. Always message.
metadata: map[string] Metadata attached to each new session.
type: "new_session" (default: "new_session") The type of the object. Always new_session.
vault_ids: array of string Vaults made available to each new session.
minItems0 maxItems2000 ExistingSession { instructions, session_id, type } instructions: string Saved instructions delivered as an automation notification.
minLength0 session_id: string The session receiving each invocation.
minLength0 type: "existing_session" (default: "existing_session") The type of the object. Always existing_session.
type: "once" (default: "once") The type of the object. Always once.
pause_reason: optional "target_session_failed" or null (default: "target_session_failed") Why the service paused this schedule, or null for other schedules.