Synupv1
Create a key
v1Resources/AEO/postEnqueue AEO report generation

Enqueue AEO report generation

Starts a background generation of a fresh AEO report for a location. Report generation runs multiple LLM calls per engine/prompt and never runs synchronously in-request — this call enqueues the job and returns immediately. There is no separate job-id or status resource: poll GET /api/v1/aeo/reports for the same location and watch the generating field until it returns to false. Not available for locations that predate Synup's legacy location cache (native-only locations).

post/api/v1/aeo/reports/enqueue
aeo:write
Request body
locationIdstringrequired
The location to generate a report for.
clientIdstringoptional
The location's client.
forcebooleanoptional
When true, starts a fresh generation even if a report was already generated this month.
Response
dataobjectoptional
enqueuedbooleanoptional
Always true — the generation job was enqueued.
forcebooleanoptional
Echoes back the force flag from the request.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/aeo/reports/enqueue
Your API key
Request body*
{
  "data": {
    "enqueued": true,
    "force": false
  }
}