The files attached to a note

GET

/api/v1/saga/notes/{id}/attachments

const url = 'https://api.yggy.tech/api/v1/saga/notes/example/attachments';
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/notes/example/attachments \
  --header 'Authorization: Bearer <token>'

The attachments of one of the caller’s notes, oldest first, each with its own reading status. An attachment is a document of its own and is never listed as a note.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

/^[A-Za-z0-9_-]{1,128}$/

Responses

200

Attachments

application/json

object

noteId

required

string

attachments

required

Array<object>

object

required

string

title

required

string

status

required

Read on its own, apart from the note.

string

Allowed values: PENDING PROCESSING COMPLETED FAILED STORED

contentType

required

string | null

sourceKind

required

Where the file came from: UPLOAD for a device file, LINK for a link, else the provider.

string

link

required

Set for a link attachment.

object

url

required

string

platform

required

string

Allowed values: youtube tiktok x instagram web

fetch

required

Whether yggy has read the link yet.

string

Allowed values: pending read failed link_only

failure

required

string | null

Allowed values: unreachable blocked too_large not_html robots not_found

title

required

string | null

author

required

string | null

site

required

string | null

hasPreview

required

A preview image can be loaded from the link preview route.

boolean

forLinkId

required

The link attachment this file was uploaded for, e.g. a video for its transcript.

string | null

Example

{
  "attachments": [
    {
      "status": "PENDING",
      "link": {
        "platform": "youtube",
        "fetch": "pending",
        "failure": "unreachable"
      }
    }
  ]
}

403

Not a yggy notes workspace

application/json

object

success

required

boolean

error

required

object

message

required

string

code

required

string

Allowed values: INTERNAL_ERROR VALIDATION_ERROR UNAUTHORIZED RATE_LIMITED ORG_REQUIRED FORBIDDEN NOT_FOUND CONFLICT PROJECT_DENIED USAGE_LIMIT_EXCEEDED HUGINN_ERROR HUGINN_STREAM_ERROR QUERY_FAILED PROVIDER_CONFLICT PROVIDER_CONFIG_INVALID PROVIDER_NOT_CONNECTED PROVIDER_RATE_LIMITED PROJECT_MEMBER_USER_NOT_IN_ORG PROJECT_MEMBER_UNKNOWN_ROLE PROJECT_MEMBER_LAST_OWNER PROJECT_CONFLICT STORAGE_NOT_CONFIGURED BILLING_NOT_CONFIGURED LICENSE_INACTIVE PLAN_REQUIRED MEMBER_LIMIT_REACHED SAGA_ASK_QUOTA_EXCEEDED SAGA_ASK_RATE_LIMITED SAGA_ASK_BUSY SAGA_ASK_PAUSED SAGA_ASK_UPSTREAM SAGA_DICTATION_BUSY SAGA_DICTATION_UNAVAILABLE SAGA_SHARE_LINK_LIMIT PROJECT_MEMBERSHIP_JWT_TOO_LARGE WEBHOOK_URL_INVALID WEBHOOK_ADDRESS_BLOCKED WEBHOOK_EVENT_UNKNOWN WEBHOOK_ENDPOINT_LIMIT WEBHOOK_ENDPOINT_DISABLED WEBHOOK_DELIVERY_IN_PROGRESS ORG_KEY_PERSONAL_SCOPE API_KEY_PERMISSION_EXCEEDS_ROLE API_KEY_NO_PERMISSIONS ORG_KEY_GRAPH_SCOPE_UNAVAILABLE ORG_KEY_TOO_MANY_PROJECTS SENDER_IS_LOGIN_EMAIL SENDER_TAKEN

details

Example

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR"
  }
}