Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/social-post-ideas/start-chat-session

Start chat session

Starts a new AI post-idea chat session for a brand (social profile). Optionally seed with an intent, a mode, and a subject (subjectType/subjectId) to anchor the conversation.

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
intentstringoptional
modestringoptional
subjectTypestringoptional
subjectIdstringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/start-chat-session' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "socialProfileId": "6f1c2a90-...",
  "mode": "fast",
  "intent": "idea"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "startChatSession": {
      "success": true,
      "session": {
        "id": "string",
        "socialProfileId": "string",
        "mode": "string",
        "status": "string",
        "messageCount": 0,
        "title": "string",
        "createdAt": "string"
      },
      "suggestions": [
        "string"
      ],
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.startChatSessionobjectoptional
data.startChatSession.successbooleanoptional
data.startChatSession.sessionobjectoptional
data.startChatSession.session.idstringoptional
data.startChatSession.session.socialProfileIdstringoptional
data.startChatSession.session.modestringoptional
data.startChatSession.session.statusstringoptional
data.startChatSession.session.messageCountintegeroptional
data.startChatSession.session.titlestringoptional
data.startChatSession.session.createdAtstringoptional
data.startChatSession.suggestionsarray of stringoptional
data.startChatSession.errorobjectoptional
data.startChatSession.error.messagestringoptional
data.startChatSession.error.codestringoptional
data.startChatSession.error.contextInfoarray of objectoptional
data.startChatSession.error.contextInfo[].keystringoptional
data.startChatSession.error.contextInfo[].valuestringoptional