agents

GET /agents/fetch-output

Gets the output of the most recent container of an agent. This API endpoint is specifically designed so that it's easy to get incremental data from an agent.

Request

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

Query parameters

idstring required

Id of the agent to fetch output from.

fromOutputPosnumber

If set, the returned output will start from the specified position.

prevContainerIdstring

If set, the output will be retrieved from the container after the specified previous container id.

'starting' | 'running' | 'finished' | 'unknown' | 'launch error'

'never launched'

If set, allows to define which status was previously retrieved on user-side.

prevRuntimeEventIndexnumber

If set, the container's runtime events will be returned in the response starting from the provided previous runtime event index.

Headers

X-Phantombuster-Orgstring

ID of the org that is perfoming the operation (not necessary when using a third party key)

Response

containerIdstring

outputstring

outputPosnumber

mostRecentEndedAtnumber

progressnumber

progressLabelstring

isAgentRunningboolean required

canSoftAbortboolean required

Changes

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