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

apiHosted AI, explicit consent

Generate reply draft

POST /api/inbox/generate-reply

Run the ReplyAgent to draft a reply to an inbox conversation, using workspace GTM context (offers, ICP, personas, case studies) and calendar availability. Returns the drafted message, strategy, confidence, and whether it needs human review before sending.

Parameters

workspaceId

string

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

workspaceSlug

string

Required for Clerk auth. Ignored when using API key (workspace inferred from key).

linkedin_account_id

string

Optional connected LinkedIn account UUID used to scope calendar availability and reply context.

conversationrequired

object

Required. The conversation object (must include chat_id).

messages

object[]

Message thread the reply should respond to.

sentimentAnalysis

object

Optional prior sentiment classification (from analyze-sentiment) to ground strategy selection.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/inbox/generate-reply" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"conversation":{},"allowHostedAi":true}'

Response

The operation is available, but its typed response schema has not been published yet.

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.