Generate a chat completion

Base URL: https://{kibana_url}

POST /api/observability_ai_assistant/chat/complete

Create a new chat completion by using the Observability AI Assistant.

The API returns the model's response based on the current conversation context.

It also handles any tool requests within the conversation, which may trigger multiple calls to the underlying large language model (LLM).

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

actions object[]
connectorId string required: A unique identifier for the connector.
conversationId string: A unique identifier for the conversation if you are continuing an existing conversation.
disableFunctions boolean: Flag indicating whether all function calls should be disabled for the conversation. If true, no calls to functions will be made.
instructions union oneOf[]: An array of instruction objects, which can be either simple strings or detailed objects.; One of:
messages object[] required: An array of message objects containing the conversation history.
persist boolean required: Indicates whether the conversation should be saved to storage. If true, the conversation will be saved and will be available in Kibana.
title string: A title for the conversation.

Response

Successful response

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl --request POST 'localhost:5601/api/observability_ai_assistant/chat/complete' -u <username>:<password> -H 'kbn-xsrf: true' -H "Content-Type: application/json" --data '
{
"connectorId": "<connectorId>",
"disableFunctions": false,
  "messages": [
    {
      "@timestamp": "2025-06-25T23:45:00.000Z",
      "message": {
        "role": "user",
        "content": "Is my Elasticsearch cluster healthy right now?"
      }
    }
  ],
"persist": false,
"actions": [
  {
    "name": "get_cluster_health",
    "description": "Fetch the current Elasticsearch cluster-health status and key metrics.",
    "parameters": {
      "type": "object",
      "properties": {
        "includeShardStats": {
          "type": "boolean",
          "default": false
        }
      }
    }
  }
],
"instructions": ["When the user asks about Elasticsearch cluster health, use the get_cluster_health tool to retrieve cluster health, then summarize the response in plain English."]
}'

Response

data: {"model":"unknown","choices":[{"delta":{"content":"","function_call":{"name":"get_cluster_health","arguments":"{\"includeShardStats\":true}"}},"finish_reason":null,"index":0}],"created":1750936626911,"id":"9c8eff9b-4fd4-4203-a4ab-2e364688deff","object":"chat.completion.chunk"}

data: [DONE]

Authentication

Request body { }

Response

Request body