Stream Chat with Knowledge Graph (AI SDK Compatible)

POST

/api/v1/projects/{projectId}/chat/stream

const url = 'https://api.yggy.tech/api/v1/projects/example/chat/stream';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"input":[{"id":"example","role":"user","parts":["example"],"metadata":{"commandId":"search"}}],"options":{"tier":"fast","conversationId":"example","userId":"example","chatId":"example","projectId":"example","graphContext":{"nodes":[{"id":"example","label":"example","type":"example"}],"edges":[{"source":"example","target":"example","label":"example"}]},"roomContext":{"roomId":"example","roomTitle":"example","boardId":"example","boardTitle":"example","title":"example"},"seedMode":"first-run"}}'
};

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://api.yggy.tech/api/v1/projects/example/chat/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "input": [ { "id": "example", "role": "user", "parts": [ "example" ], "metadata": { "commandId": "search" } } ], "options": { "tier": "fast", "conversationId": "example", "userId": "example", "chatId": "example", "projectId": "example", "graphContext": { "nodes": [ { "id": "example", "label": "example", "type": "example" } ], "edges": [ { "source": "example", "target": "example", "label": "example" } ] }, "roomContext": { "roomId": "example", "roomTitle": "example", "boardId": "example", "boardTitle": "example", "title": "example" }, "seedMode": "first-run" } }'

Stream chat responses from the knowledge graph agent.

This endpoint returns Server-Sent Events (SSE) compatible with the Vercel AI SDK useChat hook.

Use this endpoint for real-time streaming responses in the frontend.

Authorizations

bearerAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

Request Body

application/json

object

input

required

Any of:

string
Array<object>

string

options

object

tier

string

default: balanced

Allowed values: fast balanced accurate

conversationId

string

userId

string

chatId

string

projectId

string

graphContext

object

nodes

Array<object>

object

required

string

label

required

string

type

required

string

edges

Array<object>

object

source

required

string

target

required

string

label

string

roomContext

object

roomId

required

string

<= 80 characters

roomTitle

string

<= 500 characters

boardId

string

<= 80 characters

boardTitle

string

<= 200 characters

title

string

<= 500 characters

seedMode

string

Allowed values: first-run

Responses

200

SSE stream of chat chunks

text/event-stream

401

Unauthorized

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}

403

Project access denied

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}

500

Internal server error

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}