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

Pipeline status

Returns the status of the post-idea generation pipeline for a brand (social profile) — current step, steps completed/remaining, and any error.

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

Parameters

Query

NameTypeRequiredDescription
socialProfileIdstringrequiredSocial profile ID.

Headers

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

Request

Request
curl -X GET 'https://api.synup.com/api/v4/social-post-ideas/pipeline-status?socialProfileId=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "pipelineStatus": {
      "id": "string",
      "socialProfileId": "string",
      "pipelineType": "string",
      "status": "string",
      "currentStep": "string",
      "stepsCompleted": [
        "string"
      ],
      "stepsRemaining": [
        "string"
      ],
      "errorMessage": "string",
      "startedAt": "string",
      "completedAt": "string"
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.pipelineStatusobjectoptional
data.pipelineStatus.idstringoptional
data.pipelineStatus.socialProfileIdstringoptional
data.pipelineStatus.pipelineTypestringoptional
data.pipelineStatus.statusstringoptional
data.pipelineStatus.currentStepstringoptional
data.pipelineStatus.stepsCompletedarray of stringoptional
data.pipelineStatus.stepsRemainingarray of stringoptional
data.pipelineStatus.errorMessagestringoptional
data.pipelineStatus.startedAtstringoptional
data.pipelineStatus.completedAtstringoptional