GETapi.synup.com/api/v4/local-post-ideas/active-chat-session

Local active chat session

Returns the currently active AI post-idea chat session for a location, if one exists. Use this to resume an in-progress conversation. Set excludeSeries to skip sessions that belong to a content series.

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

Parameters

Query

Name	Type	Required	Description
`locationId`	string	required	Relay-encoded location ID.
`excludeSeries`	boolean	optional	Exclude sessions that belong to a content series.

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/active-chat-session?locationId=&excludeSeries=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/active-chat-session?locationId=&excludeSeries=', {
  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/active-chat-session?locationId=&excludeSeries=",
    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/active-chat-session?locationId=&excludeSeries=", 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": {
    "localActiveChatSession": {
      "id": "string",
      "locationId": 0,
      "mode": "string",
      "status": "string",
      "messageCount": 0,
      "title": "string",
      "subjectType": "string",
      "subjectId": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Response body

Name	Type	Required
`data`	object	optional
`data.localActiveChatSession`	object	optional
`data.localActiveChatSession.id`	string	optional
`data.localActiveChatSession.locationId`	integer	optional
`data.localActiveChatSession.mode`	string	optional
`data.localActiveChatSession.status`	string	optional
`data.localActiveChatSession.messageCount`	integer	optional
`data.localActiveChatSession.title`	string	optional
`data.localActiveChatSession.subjectType`	string	optional
`data.localActiveChatSession.subjectId`	string	optional
`data.localActiveChatSession.createdAt`	string	optional
`data.localActiveChatSession.updatedAt`	string	optional