Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

Search the caller's notes

GET
/api/v1/saga/search
 
curl --request GET \
  --url 'https://api.yggy.tech/api/v1/saga/search?q=' \
  --header 'Authorization: Bearer <token>'

Finds notes by their title, their original text, and the people, places and topics yggy recognised in them, and says which. Ignores case, accents and the German sharp s.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q

What to look for. Fewer than 2 characters finds nothing.

string
"" <= 200 characters

What to look for. Fewer than 2 characters finds nothing.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Matches

Media type application/json
object
query
required
string
notes
required
Array<object>
object
id
required
string
title
required
string
createdAt
required
string
status
required
string
Allowed values: PENDING PROCESSING COMPLETED FAILED STORED
isImage
required
boolean
isAudio
required
boolean
reasons
required
Array<string>
Allowed values: title text entity
snippet
object
before
required
string
match
required
string
after
required
string
matchedEntities
required
Array<object>
object
label
required
string
group
required
string
Allowed values: people organizations places topics
entities
required
Array<object>
object
label
required
string
group
required
string
Allowed values: people organizations places topics
noteCount
required
number
noteIds
required
Array<string>
reading
required

Notes yggy is still reading, so more may match when it is done.

number
suggestions
required

The most mentioned things in the person’s notes, only when nothing matched.

Array<object>
object
label
required
string
group
required
string
Allowed values: people organizations places topics
Example 
{
  "notes": [
    {
      "status": "PENDING",
      "reasons": [
        "title"
      ],
      "matchedEntities": [
        {
          "group": "people"
        }
      ]
    }
  ],
  "entities": [
    {
      "group": "people"
    }
  ],
  "suggestions": [
    {
      "group": "people"
    }
  ]
}

400

Section titled “400 ”

Invalid request

Media type application/json
object
success
required
boolean
error
required
object
code
required
string
message
required
string
details
Example 
{
  "success": false
}

403

Section titled “403 ”

Not a yggy notes workspace

Media type application/json
object
success
required
boolean
error
required
object
code
required
string
message
required
string
details
Example 
{
  "success": false
}