Generate event-stream settings

Generate a draft of editable event display settings from sample payload fields and optional current settings. This helper does not save or activate an event stream.

POST/api/table-event-streams/generate-settings

HTTP referenceScope tables:readUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Developer API keys need the listed scope. A valid authenticated user session may also call this route.

Generation uses the configured LLM when sample fields exist and returns warnings or empty sanitized settings when fields are missing or generation fails. Treat returned mappings/templates as suggestions and validate them; this endpoint does not mutate a definition. The response example is abbreviated and illustrative.

Body parameters

sample_payload · optional
any
Optional representative payload; values are truncated before the model prompt.
fields · optional
array<object>
Optional field descriptors used when payload fields are not present.
current · optional
object
Current editable settings to inform the generated draft.

Name	Type	Description
sample_payload	any	Optional representative payload; values are truncated before the model prompt.
fields	array<object>	Optional field descriptors used when payload fields are not present.
current	object	Current editable settings to inform the generated draft.

Errors

Status	Meaning
401	Authentication is missing or invalid.
403	The credential is invalid or lacks the required scope, or the caller cannot access the resource.
422	A supplied field descriptor or current value has an invalid type.

Example

bash

curl -X POST "https://app.autotouch.ai/api/table-event-streams/generate-settings" \
  -H "Authorization: Bearer $AUTOTOUCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sample_payload":{"company":{"domain":"example.test"},"event_type":"hiring","occurred_at":"2026-09-27T12:00:00Z"},"current":{}}'

Request body

json

{
  "sample_payload": {
    "company": {
      "domain": "example.test"
    },
    "event_type": "hiring",
    "occurred_at": "2026-09-27T12:00:00Z"
  },
  "current": {}
}

Response example

json

{
  "item": {
    "timestamp_column_key": "occurred_at",
    "title_template": "Hiring update for {{payload.company.domain}}"
  },
  "warnings": []
}