v1

latestOpenAPI 3.0.0ISC2026-07-26782347.5 KB
Agent

Get an agent record.

get/agent/{id}

Path parameters

idinteger required

ID of the agent to retrieve.

Query parameters

withScriptboolean

If true, and if the agent has an associated script, also return the script record.

Response

Success

statusstring

Example response

{
  "status": "success",
  "data": {
    "id": 1763,
    "name": "Nice Agent",
    "scriptId": 1902,
    "proxy": "none",
    "loadImages": true,
    "launch": "manually",
    "nbLaunches": 94,
    "showDebug": true,
    "awsFolder": "nVFRid8kvsuPeuCL80DnBg",
    "executionTimeLimit": 5,
    "fileMgmt": "folders",
    "fileMgmtMaxFolders": 10,
    "lastEndMessage": "Execution time limit reached",
    "lastEndStatus": "error",
    "maxParallelExecs": 1,
    "userAwsFolder": "QwYH17CB0Xj",
    "nonce": 123,
    "script": {
      "id": 1902,
      "name": "nice_agent.coffee",
      "source": "phantombuster",
      "text": " ... script contents ... "
    }
  }
}