Ask a question over the caller's notes (streaming)

POST

/api/v1/saga/ask

const url = 'https://api.yggy.tech/api/v1/saga/ask';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"messages":[{"role":"user","text":"example"}],"focusEntityId":"example","commandId":"search"}'
};

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/saga/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "messages": [ { "role": "user", "text": "example" } ], "focusEntityId": "example", "commandId": "search" }'

Streams an answer from the knowledge graph built from the caller’s own notes. Limited per plan; read-only.

Authorizations

bearerAuth
apiKeyAuth

Request Body

application/json

object

messages

required

Array<object>

>= 1 items <= 7 items

object

role

required

string

Allowed values: user assistant

text

required

string

>= 1 characters <= 4000 characters

focusEntityId

string

/^0x[0-9a-fA-F]{1,16}$/

commandId

string

Allowed values: search path similar document central changes

Responses

200

SSE stream

text/event-stream

400

Invalid request

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

403

Not a yggy notes workspace

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

429

Limit reached or busy

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

502

Ask unavailable

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

503

Free Ask paused

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}