Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

ReadOutputResponse

Type: object

ReadOutputResponse is one page of ordered output.
chunks

Type: array

chunks is retained output in stream_sequence order, possibly empty.
Array item

Schema: ProcessChunk

All schema constraints and annotations
{
  "description": "chunks is retained output in stream_sequence order, possibly empty.",
  "items": {
    "$ref": "#/components/schemas/ProcessChunk"
  },
  "type": "array"
}
exited

Schema: ProcessExited

exited is set once the process has exited and no retained bytes follow next_resume_from.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ProcessExited",
  "description": "exited is set once the process has exited and no retained bytes follow next_resume_from."
}
nextResumeFrom

Type: integer | string

next_resume_from is the stream_sequence to pass next; equal to resume_from when nothing new was retained.
All schema constraints and annotations
{
  "description": "next_resume_from is the stream_sequence to pass next; equal to resume_from\nwhen nothing new was retained.",
  "format": "int64",
  "type": [
    "integer",
    "string"
  ]
}
All schema constraints and annotations
{
  "description": "ReadOutputResponse is one page of ordered output.",
  "properties": {
    "chunks": {
      "description": "chunks is retained output in stream_sequence order, possibly empty.",
      "items": {
        "$ref": "#/components/schemas/ProcessChunk"
      },
      "type": "array"
    },
    "exited": {
      "$ref": "#/components/schemas/ProcessExited",
      "description": "exited is set once the process has exited and no retained bytes follow next_resume_from."
    },
    "nextResumeFrom": {
      "description": "next_resume_from is the stream_sequence to pass next; equal to resume_from\nwhen nothing new was retained.",
      "format": "int64",
      "type": [
        "integer",
        "string"
      ]
    }
  },
  "title": "ReadOutputResponse",
  "type": "object"
}