# InteractRequest


[API catalog](/reference/api/) · [Docker Sandboxes overview](/reference/api/sandboxes/latest/) · [Product manual](https://docs.docker.com/ai/sandboxes-api/) · [OpenAPI specification](/reference/api/sandboxes/api.yaml)

API version: v1


> This API is experimental. Features, interfaces,
> and behavior may change.




Schema constraints and annotations:

```json
{
  "description": "InteractRequest is one frame on the bidirectional interaction stream.",
  "oneOf": [
    {
      "properties": {
        "attach": {
          "$ref": "#/components/schemas/ProcessAttach",
          "description": "attach opens or resumes the interaction."
        }
      },
      "required": [
        "attach"
      ],
      "title": "attach",
      "type": "object"
    },
    {
      "properties": {
        "closeStdin": {
          "description": "close_stdin closes standard input when true; false has no effect, including on a PTY.\nOn a PTY, true delivers the terminal's VEOF input through the line discipline and\ndoes not close the PTY master; subsequent stdin frames remain valid. Terminal mode\nowns interpretation: canonical mode treats VEOF as marking the end of input, while\nraw mode delivers it as an ordinary input byte, so this promises delivery, never\ninterpretation. Each true frame on a PTY delivers exactly one VEOF input; unlike the\npipe path, repeated frames are not a no-op.",
          "type": "boolean"
        }
      },
      "required": [
        "closeStdin"
      ],
      "title": "close_stdin",
      "type": "object"
    },
    {
      "properties": {
        "resize": {
          "$ref": "#/components/schemas/TerminalSize",
          "description": "resize changes terminal size; portable-range dimensions on a running process without a PTY return FAILED_PRECONDITION."
        }
      },
      "required": [
        "resize"
      ],
      "title": "resize",
      "type": "object"
    },
    {
      "properties": {
        "stdin": {
          "description": "stdin writes process standard input.",
          "format": "byte",
          "type": "string"
        }
      },
      "required": [
        "stdin"
      ],
      "title": "stdin",
      "type": "object"
    }
  ],
  "title": "InteractRequest",
  "type": "object",
  "unevaluatedProperties": false
}
```