Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Get agent run

GET /api/agents/runs/{runId}

Drill into a specific agent run: full input/output summary plus every tool call (agent_run_steps) with its arguments, output, duration, and tokens. Use for debugging or auditing what an agent actually did. Read-only.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

runIdrequired

string

No description.

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/agents/runs/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "run": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        },
        "agentRole": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "trigger": {
          "type": "string"
        },
        "startedAt": {
          "type": "string"
        },
        "endedAt": {
          "type": "string"
        },
        "tokensUsed": {
          "type": "number"
        },
        "toolCalls": {
          "type": "number"
        },
        "costCents": {
          "type": "number"
        },
        "summary": {
          "type": "string"
        },
        "error": {
          "type": "string"
        },
        "skillProvenance": {
          "type": [
            "object",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "workspaceId",
        "agentRole",
        "status",
        "trigger"
      ]
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agentRunId": {
            "type": "string"
          },
          "stepIndex": {
            "type": "number"
          },
          "toolName": {
            "type": "string"
          },
          "tokensIn": {
            "type": "number"
          },
          "tokensOut": {
            "type": "number"
          },
          "costCents": {
            "type": "number"
          },
          "durationMs": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agentRunId",
          "stepIndex",
          "toolName",
          "status"
        ]
      }
    }
  },
  "required": [
    "run",
    "steps"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.