Chat Stream Endpoint
POST
/ai/chat/stream/
const url = 'https://example.com/api/ai/chat/stream/';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"message":"example","map_id":"example","layers":[{"id":"example","name":"example","dataset_id":"example","dataset_table_name":"example","geometry_type":"example","layer_type":"example","column_info":[{}],"dataset_title":"example","feature_count":1,"sample_values":{},"visible":true,"filter":{},"label_config":{},"style_config":{},"paint":{}}],"language":"example","history":[{"role":"user","content":"example"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/ai/chat/stream/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "message": "example", "map_id": "example", "layers": [ { "id": "example", "name": "example", "dataset_id": "example", "dataset_table_name": "example", "geometry_type": "example", "layer_type": "example", "column_info": [ {} ], "dataset_title": "example", "feature_count": 1, "sample_values": {}, "visible": true, "filter": {}, "label_config": {}, "style_config": {}, "paint": {} } ], "language": "example", "history": [ { "role": "user", "content": "example" } ] }'Chat-based map editing with server-sent event streaming.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
ChatRequest
object
message
required
Message
string
map_id
required
Map Id
string
layers
required
Layers
Array<object>
ChatMapLayerLayer state sent from frontend for chat context.
object
id
required
Id
string
name
required
Name
string
dataset_id
required
Dataset Id
string
dataset_table_name
required
Dataset Table Name
string
column_info
Any of:
Array<object>
object
key
additional properties
any
null
visible
Visible
boolean
history
History
Array<object>
ChatHistoryMessageA single message in the conversation history.
object
role
required
Role
string
content
required
Content
string
Responses
Section titled “ Responses ”Server-Sent Events stream
Example generated
exampleBad request — invalid query parameters or payload
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Unauthorized — missing or invalid credentials
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Forbidden — caller lacks access to this resource
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Not found
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Validation error
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Internal server error
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}