Pulse AI Research Agent | Chat Completions Streaming API

OpenAI-compatible chat completions endpoint with streaming support.
This endpoint allows applications to send messages to Pulse AI Research Agent and receive streaming responses in OpenAI-compatible format. It processes user messages through the appropriate agent based on the requested model and maintains conversation history between requests.

Stream Format

Each event starts with "data: " followed by a JSON string and two newlines

First content chunk: {"choices": [{"delta": {"role": "assistant", "content": "chunk"}, "index": 0, "finish_reason": null}]}

Subsequent chunks: {"choices": [{"delta": {"content": "chunk"}, "index": 0, "finish_reason": null}]}

End markers: {"choices":[{"delta":{},"finish_reason":"stop","index":0}]} followed by [DONE]

Request

Header Params

x-user-email

string

optional

Example:

corey@lineupiq.io

x-app-id

string <password>

required

Default:

x-api-key

string <password>

required

Default:

Content-Type

string

optional

Default:

application/json

Body Params application/json

model

string

required

ID of the model to use (e.g., 'control-4v1', 'discovery-pulse-4v1')

Example:

control-4v1

messages

array [object {2}]

required

A list of messages comprising the conversation so far

role

enum<string>

required

The role of the message author

Allowed values:

systemuserassistant

Example:

user

content

string

required

The content of the message

Example:

Tell me about LAIRA Core

stream

boolean

optional

Whether to stream the response (recommended for this endpoint)

Default:

true

Example:

true

Example

{
  "model": "discovery-pulse-4v1",
  "messages": [
    {
      "role": "user",
      "content": "I'm looking for venues in Edmonton that can host a rock concert with about 2000 attendees in August."
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

text/event-stream

Streaming response

Body

string <binary>

optional

Examples

Content chunkNext content chunkFinal metadataEnd of stream marker

data: {"choices": [{"delta": {"role": "assistant", "content": "Hello"}, "index": 0, "finish_reason": null}]}\n\n

🟠401Unauthorized

🔴500Server Error

Chat Completions Endpoint

Stream Format#

Request

Request samples

Responses

Stream Format