Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/social-post-ideas/trigger-pipeline

Trigger pipeline

Triggers the full social post-idea generation pipeline for a brand. Returns a pipeline ID; supply brand context (profile name, site URL, categories, hashtags, intent, content language) to steer generation.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Body

NameTypeRequiredDescription
socialProfileIdstringrequired
profileNamestringrequired
siteUrlstringoptional
categoriesarray of stringoptional
brandHashtagsarray of stringoptional
businessIntentstringoptional
contentPreferredLanguagestringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/trigger-pipeline' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "socialProfileId": "6f1c2a90-...",
  "profileName": "Acme Co"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "triggerPipeline": {
      "success": true,
      "pipelineId": "string",
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.triggerPipelineobjectoptional
data.triggerPipeline.successbooleanoptional
data.triggerPipeline.pipelineIdstringoptional
data.triggerPipeline.errorobjectoptional
data.triggerPipeline.error.messagestringoptional
data.triggerPipeline.error.codestringoptional
data.triggerPipeline.error.contextInfoarray of objectoptional
data.triggerPipeline.error.contextInfo[].keystringoptional
data.triggerPipeline.error.contextInfo[].valuestringoptional