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
| Name | Type | Required | Description |
|---|---|---|---|
socialProfileId | string | required | Social profile ID. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Synup-Version | string | required | API 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'const res = await fetch('https://api.synup.com/api/v4/social-post-ideas/pipeline-status?socialProfileId=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/social-post-ideas/pipeline-status?socialProfileId=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/social-post-ideas/pipeline-status?socialProfileId=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
401 | Unauthorized - 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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.pipelineStatus | object | optional | |
data.pipelineStatus.id | string | optional | |
data.pipelineStatus.socialProfileId | string | optional | |
data.pipelineStatus.pipelineType | string | optional | |
data.pipelineStatus.status | string | optional | |
data.pipelineStatus.currentStep | string | optional | |
data.pipelineStatus.stepsCompleted | array of string | optional | |
data.pipelineStatus.stepsRemaining | array of string | optional | |
data.pipelineStatus.errorMessage | string | optional | |
data.pipelineStatus.startedAt | string | optional | |
data.pipelineStatus.completedAt | string | optional |