Skip to content
RuntaRunta
Start free with $50 credit

Execute a Cloud Agent workspace operation

POST
/v2/agents/{agent_id}/workspace
curl --request POST \
  --url https://api.runta.me/v2/agents/example/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "list_directory", "path": "example", "query": "example", "offset": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agent_id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
kind
required
string
Allowed values: list_directory read_text search_files read_media list_ports
path
string
query
string
offset
integer format: uint64

Responses

Section titled “Responses”

200

Section titled “200”

Workspace operation result.

Media typeapplication/json
object
kind
required
string
Allowed values: list_directory read_text search_files read_media list_ports
entries
required
Array<object>
object
name
required
string
path
required
string
kind
required
string
Allowed values: directory text image video file
size
required
integer format: uint64
text
string
matches
required
Array<object>
object
path
required
string
line
required
integer format: uint32
>= 1
preview
required
string
media_base64
string
media_type
string
next_offset
integer format: uint64
ports
required
Array<object>
object
port
required
integer format: uint16
>= 1 <= 65535
forwardable

Whether the listener accepts traffic addressed to the Runtime rather than loopback only. Omitted by older Runtime agents.

boolean
truncated
required
boolean
Example
{
  "kind": "list_directory",
  "entries": [
    {
      "kind": "directory"
    }
  ]
}

401

Section titled “401”

Missing, malformed, or rejected bearer token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

403

Section titled “403”

The bearer token is not allowed to perform this action

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

404

Section titled “404”

The requested resource was not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

409

Section titled “409”

The request conflicts with current resource state

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

422

Section titled “422”

Validation or application error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

501

Section titled “501”

Operation is not implemented

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

503

Section titled “503”

Upstream service is unavailable

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

504

Section titled “504”

Upstream request timed out

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

default

Section titled “default”

Error response

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}