POST
/
agent
/
run
/
{instance_id}
import os
from skylight_sdk import Skylight


with Skylight(
    apikey=os.getenv("SKYLIGHT_APIKEY", ""),
) as skylight:

    res = skylight.agent.run(instance_id="<id>", query="Search for something on the VM")

    # Handle response
    print(res)
{
  "message": "<string>",
  "status": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key authentication

Path Parameters

instance_id
string
required

Body

application/json
query
string
required
messages
object[] | null

Response

200
application/json
Agent task started
status
string
required

Status of the operation

Example:

"success"

message
string
required

Human-readable status message