Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Chat through an OpenAI-compatible interface

It is useful if you need inline citations or OpenAI-compatible responses, but has limited functionality compared to the standard chat interface.

For guidance and examples, see Chat with an assistant.

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"

curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME/chat/completions" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "What is the maximum height of a red pine?"
    }
  ]
}'
curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"

curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME/chat/completions" \
  -H "Api-Key: $PINECONE_API_KEY "\
  -H "Content-Type: application/json" \
  -H "X-Pinecone-Api-Version: 2026-04" \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "What is the maximum height of a red pine?"
    }
  ],
  "stream": true
}'
Default
{"chat_completion":
  {
    "id":"chatcmpl-9OtJCcR0SJQdgbCDc9JfRZy8g7VJR",
    "choices":[
      {
        "finish_reason":"stop",
        "index":0,
        "message":{
          "role":"assistant",
          "content":"The maximum height of a red pine (Pinus resinosa) is up to 25 meters."
        }
      }
    ],
    "model":"my_assistant"
  }
}
Streaming
{
  'id': '000000000000000009de65aa87adbcf0',
  'choices': [
      {
      'index': 0,
      'delta':
        {
        'role': 'assistant',
        'content': 'The'
        },
      'finish_reason': None
      }
    ],
  'model': 'gpt-4o-2024-05-13'
}

...

{
  'id': '00000000000000007a927260910f5839',
  'choices': [
      {
      'index': 0,
      'delta':
        {
          'role': '',
          'content': 'The'
        },
      'finish_reason': None
      }
    ],
  'model': 'gpt-4o-2024-05-13'
}

...

{
  'id': '00000000000000007a927260910f5839',
  'choices': [
    {
      'index': 0,
      'delta':
        {
        'role': None,
        'content': None
        },
      'finish_reason': 'stop'
      }
    ],
  'model': 'gpt-4o-2024-05-13'
}

POST /chat/{assistant_name}/chat/completions

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • assistant_name (path, string, required) — The name of the assistant to be described.
  • messages (body, object[], required) — The list of messages sent to the assistant, used for context retrieval and generating response with the LLM.
  • stream (body, boolean) — If false, the assistant returns a single JSON response. If true, the assistant returns a stream of responses.
  • model (body, string) — The large language model used to generate responses.
  • temperature (body, number) — Controls the randomness of the model's output: lower values make responses more deterministic, while higher values increase creativity and variability. If the model does not support a temperature parameter, the parameter will be ignored.
  • filter (body, object) — Optional metadata-based filter to restrict which documents are retrieved for the assistant's response context.
  • 200 — Search request successful.
  • 400 — Bad request. The request body included invalid request parameters.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Assistant not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu