A notes graph relation and where it came from

GET

/api/v1/saga/graph/edges/{id}

const url = 'https://api.yggy.tech/api/v1/saga/graph/edges/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.yggy.tech/api/v1/saga/graph/edges/example \
  --header 'Authorization: Bearer <token>'

One statement with both things, its passage, how sure the reading was and the notes it came from.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

Graph edge id

string

>= 1 characters <= 64 characters /^0x[0-9a-f]+$/i/

Graph edge id

Responses

200

Relation details

application/json

object

required

string

predicate

required

string

subject

required

object

required

string

label

required

string

group

required

string

Allowed values: people organizations places topics

object

required

object

required

string

label

required

string

group

required

string

Allowed values: people organizations places topics

status

required

string

Allowed values: current superseded conflicting retracted source_deleted

evidence

The passage the statement was taken from; left out while any document behind it is in the trash.

string

confidence

number

<= 1

method

Read from running text, from a table or form, entered by hand, or both.

string

Allowed values: UNSTRUCTURED STRUCTURED_SGSE MANUAL HYBRID

readAt

string

createdAt

string

validFrom

Only when the text states it; a bare year stays a four-digit year.

string

values

object

amount

string

currency

string

unit

string

location

string

sources

required

The notes and files it came from, newest first, from at most 50 documents read.

Array<object>

object

required

The note to open; for a file, the note it is attached to.

string

title

required

string

createdAt

string

isFile

required

boolean

sourcesMore

required

More documents back it than were read, so sources is not complete.

boolean

Example

{
  "subject": {
    "group": "people"
  },
  "object": {
    "group": "people"
  },
  "status": "current",
  "method": "UNSTRUCTURED"
}

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
}

404

No such relation in this workspace

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

429

Too many graph requests

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}