Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 62 additions & 146 deletions openapi/agent-sdk.json
Original file line number Diff line number Diff line change
Expand Up @@ -2586,6 +2586,43 @@
"title": "Load Public Skills",
"description": "Whether to automatically load skills from the public OpenHands skills repository at https://github.com/OpenHands/skills. This allows you to get the latest skills without SDK updates.",
"default": false
},
"secrets": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"oneOf": [
{
"$ref": "#/components/schemas/LookupSecret"
},
{
"$ref": "#/components/schemas/StaticSecret"
}
],
"title": "SecretSource",
"discriminator": {
"propertyName": "kind",
"mapping": {
"openhands__sdk__secret__secrets__LookupSecret-Output__1": "#/components/schemas/LookupSecret",
"openhands__sdk__secret__secrets__StaticSecret-Output__1": "#/components/schemas/StaticSecret"
}
}
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Secrets",
"description": "Dictionary mapping secret keys to values or secret sources. Secrets are used for authentication and sensitive data handling. Values can be either strings or SecretSource instances (str | SecretSource)."
}
},
"type": "object",
Expand Down Expand Up @@ -4116,137 +4153,6 @@
"title": "EventSortOrder",
"description": "Enum for event sorting options."
},
"ExecuteBashAction": {
"properties": {
"kind": {
"type": "string",
"const": "ExecuteBashAction",
"title": "Kind",
"default": "ExecuteBashAction"
},
"command": {
"type": "string",
"title": "Command",
"description": "The bash command to execute. Can be empty string to view additional logs when previous exit code is `-1`. Can be `C-c` (Ctrl+C) to interrupt the currently running process. Note: You can only execute one bash command at a time. If you need to run multiple commands sequentially, you can use `&&` or `;` to chain them together."
},
"is_input": {
"type": "boolean",
"title": "Is Input",
"description": "If True, the command is an input to the running process. If False, the command is a bash command to be executed in the terminal. Default is False.",
"default": false
},
"timeout": {
"anyOf": [
{
"type": "number",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Timeout",
"description": "Optional. Sets a maximum time limit (in seconds) for running the command. If the command takes longer than this limit, you\u2019ll be asked whether to continue or stop it. If you don\u2019t set a value, the command will instead pause and ask for confirmation when it produces no new output for 30 seconds. Use a higher value if the command is expected to take a long time (like installation or testing), or if it has a known fixed duration (like sleep)."
},
"reset": {
"type": "boolean",
"title": "Reset",
"description": "If True, reset the terminal by creating a new session. Use this only when the terminal becomes unresponsive. Note that all previously set environment variables and session state will be lost after reset. Cannot be used with is_input=True.",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"command"
],
"title": "ExecuteBashAction",
"description": "Deprecated: Use TerminalAction instead.\n\nThis class is deprecated and will be removed in version 1.5.0.\nPlease use TerminalAction instead."
},
"ExecuteBashObservation": {
"properties": {
"kind": {
"type": "string",
"const": "ExecuteBashObservation",
"title": "Kind",
"default": "ExecuteBashObservation"
},
"content": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TextContent"
},
{
"$ref": "#/components/schemas/ImageContent"
}
]
},
"type": "array",
"title": "Content",
"description": "Content returned from the tool as a list of TextContent/ImageContent objects. When there is an error, it should be written in this field."
},
"is_error": {
"type": "boolean",
"title": "Is Error",
"description": "Whether the observation indicates an error",
"default": false
},
"command": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Command",
"description": "The bash command that was executed. Can be empty string if the observation is from a previous command that hit soft timeout and is not yet finished."
},
"exit_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Exit Code",
"description": "The exit code of the command. -1 indicates the process hit the soft timeout and is not yet finished."
},
"timeout": {
"type": "boolean",
"title": "Timeout",
"description": "Whether the command execution timed out.",
"default": false
},
"metadata": {
"$ref": "#/components/schemas/CmdOutputMetadata",
"description": "Additional metadata captured from PS1 after command execution."
},
"full_output_save_dir": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Full Output Save Dir",
"description": "Directory where full output files are saved"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"command"
],
"title": "ExecuteBashObservation",
"description": "Deprecated: Use TerminalObservation instead.\n\nThis class is deprecated and will be removed in version 1.5.0.\nPlease use TerminalObservation instead."
},
"ExecuteBashRequest": {
"properties": {
"command": {
Expand Down Expand Up @@ -6535,8 +6441,8 @@
"discriminator": {
"propertyName": "kind",
"mapping": {
"openhands__sdk__conversation__secret_source__LookupSecret-Output__1": "#/components/schemas/LookupSecret",
"openhands__sdk__conversation__secret_source__StaticSecret-Output__1": "#/components/schemas/StaticSecret"
"openhands__sdk__secret__secrets__LookupSecret-Output__1": "#/components/schemas/LookupSecret",
"openhands__sdk__secret__secrets__StaticSecret-Output__1": "#/components/schemas/StaticSecret"
}
}
},
Expand Down Expand Up @@ -6615,7 +6521,7 @@
"version": {
"type": "string",
"title": "Version",
"default": "1.4.1"
"default": "1.5.0"
},
"docs": {
"type": "string",
Expand Down Expand Up @@ -7033,8 +6939,8 @@
"discriminator": {
"propertyName": "kind",
"mapping": {
"openhands__sdk__conversation__secret_source__LookupSecret-Input__1": "#/components/schemas/LookupSecret",
"openhands__sdk__conversation__secret_source__StaticSecret-Input__1": "#/components/schemas/StaticSecret"
"openhands__sdk__secret__secrets__LookupSecret-Input__1": "#/components/schemas/LookupSecret",
"openhands__sdk__secret__secrets__StaticSecret-Input__1": "#/components/schemas/StaticSecret"
}
}
},
Expand Down Expand Up @@ -7710,8 +7616,8 @@
"discriminator": {
"propertyName": "kind",
"mapping": {
"openhands__sdk__conversation__secret_source__LookupSecret-Input__1": "#/components/schemas/LookupSecret",
"openhands__sdk__conversation__secret_source__StaticSecret-Input__1": "#/components/schemas/StaticSecret"
"openhands__sdk__secret__secrets__LookupSecret-Input__1": "#/components/schemas/LookupSecret",
"openhands__sdk__secret__secrets__StaticSecret-Input__1": "#/components/schemas/StaticSecret"
}
}
},
Expand Down Expand Up @@ -7984,9 +7890,6 @@
{
"$ref": "#/components/schemas/TaskTrackerAction"
},
{
"$ref": "#/components/schemas/ExecuteBashAction"
},
{
"$ref": "#/components/schemas/TerminalAction"
}
Expand All @@ -8013,7 +7916,6 @@
"openhands__tools__grep__definition__GrepAction-Output__1": "#/components/schemas/GrepAction",
"openhands__tools__planning_file_editor__definition__PlanningFileEditorAction-Output__1": "#/components/schemas/PlanningFileEditorAction",
"openhands__tools__task_tracker__definition__TaskTrackerAction-Output__1": "#/components/schemas/TaskTrackerAction",
"openhands__tools__terminal__definition__ExecuteBashAction-Output__1": "#/components/schemas/ExecuteBashAction",
"openhands__tools__terminal__definition__TerminalAction-Output__1": "#/components/schemas/TerminalAction"
}
},
Expand Down Expand Up @@ -8041,6 +7943,24 @@
},
"title": "CondenserBase"
},
"SecretSource": {
"oneOf": [
{
"$ref": "#/components/schemas/LookupSecret"
},
{
"$ref": "#/components/schemas/StaticSecret"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"openhands__sdk__secret__secrets__LookupSecret-Input__1": "#/components/schemas/LookupSecret",
"openhands__sdk__secret__secrets__StaticSecret-Input__1": "#/components/schemas/StaticSecret"
}
},
"title": "SecretSource"
},
"BaseWorkspace": {
"oneOf": [
{
Expand Down Expand Up @@ -8110,9 +8030,6 @@
{
"$ref": "#/components/schemas/TaskTrackerObservation"
},
{
"$ref": "#/components/schemas/ExecuteBashObservation"
},
{
"$ref": "#/components/schemas/TerminalObservation"
}
Expand All @@ -8129,7 +8046,6 @@
"openhands__tools__grep__definition__GrepObservation-Output__1": "#/components/schemas/GrepObservation",
"openhands__tools__planning_file_editor__definition__PlanningFileEditorObservation-Output__1": "#/components/schemas/PlanningFileEditorObservation",
"openhands__tools__task_tracker__definition__TaskTrackerObservation-Output__1": "#/components/schemas/TaskTrackerObservation",
"openhands__tools__terminal__definition__ExecuteBashObservation-Output__1": "#/components/schemas/ExecuteBashObservation",
"openhands__tools__terminal__definition__TerminalObservation-Output__1": "#/components/schemas/TerminalObservation"
}
},
Expand Down