GET
/
agent
/
status
/
{agent_id}
import { Skylight } from "skylight-sdk";

const skylight = new Skylight({
  apikey: process.env["SKYLIGHT_APIKEY"] ?? "",
});

async function run() {
  const result = await skylight.agent.status("<id>");

  // Handle the result
  console.log(result);
}

run();
{
  "agent_id": "agent-123456",
  "agent_status": "running",
  "created_at": "2023-01-01T12:00:00Z",
  "files": [
    {
      "description": "Downloaded PDF",
      "filename": "document.pdf",
      "timestamp": "2023-01-01T12:00:00Z"
    }
  ],
  "final_summary": "Successfully completed all tasks",
  "is_running": true,
  "query": "Find and download information about Windows",
  "step_count": 5,
  "steps": [
    "Step 1: Search for information",
    "Step 2: Download file"
  ],
  "total_steps": 5
}

Authorizations

X-API-Key
string
header
required

API key authentication

Path Parameters

agent_id
string
required

Response

200
application/json
Agent status retrieved
agent_status
string
required

Current status of the agent

Example:

"running"

is_running
boolean
required

Whether the agent is currently running

Example:

true

total_steps
integer
required

Total number of steps executed

Example:

5

step_count
integer
required

Number of steps in memory

Example:

5

files
object[]
required

List of files downloaded by the agent

steps
string[]
required

List of steps executed by the agent

created_at
string
required

Timestamp when the agent was created

query
string
required

Original query given to the agent

agent_id
string
required

Unique identifier for the agent

final_summary
string | null

Final summary of agent execution