Agent

GET /agent/{id}

Get an agent record.

Request

Base URL
https://api.phantombuster.com/api/v2
Auth
API key in header X-Phantombuster-Key-1
TypeScript
https://skmtc.dev/phantombuster/apis/phantombuster-api-v2/docs/agent/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

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 ... "
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.