GETapi.synup.com/api/v4/local-post-ideas/idea-job-status
Local idea job status
Returns the async job status for a post idea (used to poll image generation) — the current status and, when ready, the generated image URL.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
ideaId | string | required | ID of the post idea. |
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/local-post-ideas/idea-job-status?ideaId=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/idea-job-status?ideaId=', {
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/local-post-ideas/idea-job-status?ideaId=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/local-post-ideas/idea-job-status?ideaId=", 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": {
"localIdeaJobStatus": {
"status": "string",
"imageUrl": "string"
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.localIdeaJobStatus | object | optional | |
data.localIdeaJobStatus.status | string | optional | |
data.localIdeaJobStatus.imageUrl | string | optional |