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

apiDeterministic

Get sop context

GET /api/agents/sop

Read Reply/SDR base SOP, full GTM context, active overlay and pending draft. Use your coding-agent model to personalize it; ask for missing decisions and show the full draft.

Parameters

workspaceId

string

No description.

skillNamerequired

string

No description.

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/agents/sop?skillName=example" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "skill": {
      "type": "object"
    },
    "gtm": {
      "type": "object"
    },
    "overlay": {
      "type": [
        "object",
        "null"
      ]
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "knowledgeBase": {
      "type": [
        "object",
        "null"
      ]
    },
    "runtimeSettings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "config": {
            "type": "object"
          },
          "autonomy": {
            "type": "string",
            "enum": [
              "autopilot",
              "hitl",
              "paused"
            ]
          }
        }
      }
    },
    "guidance": {
      "type": "string"
    }
  },
  "required": [
    "skill",
    "gtm",
    "overlay",
    "versions",
    "knowledgeBase",
    "runtimeSettings",
    "guidance"
  ]
}

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.