Read shell output

Page through captured combined output by absolute byte cursor.

GET/api/shell/{id}/output

Path parameters

idobjectrequired

Query parameters

locationobject | any

cursorobject

limitobject

Responses

200Success

locationLocation.Inforequired

Show properties

directorystringrequired

workspaceIDobject

Show properties

object

projectobjectrequired

Show properties

idstringrequired

directorystringrequired

dataobjectrequired

Show properties

outputstringrequired

cursorobjectrequired

Show properties

object

sizeobjectrequired

Show properties

object

truncatedbooleanrequired

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

404ShellNotFoundError

_tagstringrequired

Allowed:ShellNotFoundError

idstringrequired

messagestringrequired

Request

curl -X GET "/api/shell/%5Bobject%20Object%5D/output"

const response = await fetch("/api/shell/%5Bobject%20Object%5D/output", {
  method: "GET"
});

import requests

response = requests.get(
    "/api/shell/%5Bobject%20Object%5D/output",
)

Response

{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": {
    "output": "string",
    "cursor": {},
    "size": {},
    "truncated": true
  }
}