Agents / REST API
Get agent 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.
GET /api/agents/setupDeterministic operationParameters
workspaceIdOptional · string- Optional with API key auth, inferred from the key.
executionModeOptional · string- Use external_agent when the coding agent performs inference itself.external_agent · pipeline_hosted
curl -X GET "https://app.pipeline.help/api/agents/setup" \
-H "Authorization: Bearer $PIPELINE_API_KEY"Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Optional with API key auth, inferred from the key."
},
"executionMode": {
"type": "string",
"enum": [
"external_agent",
"pipeline_hosted"
],
"description": "Use external_agent when the coding agent performs inference itself."
}
}
}