Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/local-post-ideas/send-chat-message

Send local chat message

Sends a message to an AI post-idea chat session and returns the assistant's reply. The response may include a generated post idea card (postCard), follow-up action chips, and a series plan when relevant. Optionally attach referenceImageUrls for image-grounded 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
sessionIdstringrequired
messagestringrequired
referenceImageUrlsarray of stringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/local-post-ideas/send-chat-message' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "7f3c1a2e-...",
  "message": "Give me a post idea for our weekend sale"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "sendLocalChatMessage": {
      "success": true,
      "message": {
        "id": "string",
        "role": "string",
        "content": "string",
        "messageType": "string",
        "metadata": {},
        "sequence": 0,
        "createdAt": "string"
      },
      "postCard": {},
      "seriesPlan": {},
      "actionChips": [
        {
          "label": "string",
          "emoji": "string",
          "action": "string"
        }
      ],
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.sendLocalChatMessageobjectoptional
data.sendLocalChatMessage.successbooleanoptional
data.sendLocalChatMessage.messageobjectoptional
data.sendLocalChatMessage.message.idstringoptional
data.sendLocalChatMessage.message.rolestringoptional
data.sendLocalChatMessage.message.contentstringoptional
data.sendLocalChatMessage.message.messageTypestringoptional
data.sendLocalChatMessage.message.metadataobjectoptional
data.sendLocalChatMessage.message.sequenceintegeroptional
data.sendLocalChatMessage.message.createdAtstringoptional
data.sendLocalChatMessage.postCardobjectoptionalGenerated post idea card (see Local post ideas), when produced.
data.sendLocalChatMessage.seriesPlanobjectoptionalContent-series plan, when produced.
data.sendLocalChatMessage.actionChipsarray of objectoptional
data.sendLocalChatMessage.actionChips[].labelstringoptional
data.sendLocalChatMessage.actionChips[].emojistringoptional
data.sendLocalChatMessage.actionChips[].actionstringoptional
data.sendLocalChatMessage.errorobjectoptional
data.sendLocalChatMessage.error.messagestringoptional
data.sendLocalChatMessage.error.codestringoptional
data.sendLocalChatMessage.error.contextInfoarray of objectoptional
data.sendLocalChatMessage.error.contextInfo[].keystringoptional
data.sendLocalChatMessage.error.contextInfo[].valuestringoptional