Documentation

    AI chat

    10. AI chat

    Ask questions about your project's data in natural language. AI must be enabled for the project. Each user has their own chat, identified by their email.

    MethodPathDescription
    GET/projects/{project}/ai/chatYour chats
    POST/projects/{project}/ai/chat/{chatId}Send a message: { "text": "Which region grew fastest last quarter?" }
    GET/projects/{project}/ai/chat/{chatId}?page=0&pageSize=5Message history, newest first
    DELETE/projects/{project}/ai/chat/{chatId}Clear the conversation

    Ask a question

    1. Send the question with POST .../ai/chat/[email protected] and body { "text": "..." }. The response is an scache job link.

    2. Poll the job until status is OK.

    3. Read the answer with GET .../ai/chat/[email protected]?page=0&pageSize=1. The newest message has "author": "AI".

    A chat processes one message at a time. A new message sent before the previous answer arrives returns 409. Messages count against the plan's daily AI limit (402 when it is exceeded).

    Support

    For API access, credentials and integration help, contact [email protected].

    Further reading

    Was this helpful?

    Contact support