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

apiDeterministic

Get agent setup

GET /api/agents/setup

Read Reply Agent, SDR Agent and Content Agent setup readiness before using them. Content requires a completed and saved author knowledge interview before strategy, ideas or drafts. Returns missing setup, UI paths and SOP/playbook guidance. Explain blockers to the user and help configure the offer, audience, playbooks, runtime and approval policy. External coding-agent inference needs no Pipeline model key. Read-only.

Parameters

workspaceId

string

Optional with API key auth, inferred from the key.

executionMode

string

Use external_agent when the coding agent performs inference itself.

external_agent | pipeline_hosted

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/agents/setup" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "agents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "missing": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "executionMode": {
      "type": "string"
    },
    "guidance": {
      "type": "string"
    }
  },
  "required": [
    "agents",
    "executionMode",
    "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.