get comments

The conversations on library items, canvases, timelines and share pages. waiting_for_me lists threads holding an unanswered message for this connection: naming it, or unaddressed where it is the only other side; replying clears it. Name a ref, canvas_id, timeline_id or link_id for its threads, or thread_id for one, newest first. A message from a share-page visitor carries visitor_id and never joins the waiting list. Each thread says what it is about, its reply count and when it last moved; more_messages means thread_id pages older messages; about.deleted marks a thread whose subject is gone. Free.

POST

/

tools

/

get_comments

get comments

curl --request POST \
  --url https://eversince.ai/api/v1/tools/get_comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "canvas_id": "<string>",
  "timeline_id": "<string>",
  "link_id": "<string>",
  "thread_id": "<string>",
  "message_cursor": "<string>",
  "waiting_for_me": true,
  "include_archived": true,
  "search": "<string>",
  "limit": 100,
  "cursor": "<string>"
}
'

import requests

url = "https://eversince.ai/api/v1/tools/get_comments"

payload = {
    "ref": "<string>",
    "canvas_id": "<string>",
    "timeline_id": "<string>",
    "link_id": "<string>",
    "thread_id": "<string>",
    "message_cursor": "<string>",
    "waiting_for_me": True,
    "include_archived": True,
    "search": "<string>",
    "limit": 100,
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ref: '<string>',
    canvas_id: '<string>',
    timeline_id: '<string>',
    link_id: '<string>',
    thread_id: '<string>',
    message_cursor: '<string>',
    waiting_for_me: true,
    include_archived: true,
    search: '<string>',
    limit: 100,
    cursor: '<string>'
  })
};

fetch('https://eversince.ai/api/v1/tools/get_comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key

string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id

string

The workspace this one call acts in, when it is not the default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json

ref

string

The threads on one item.

canvas_id

string

The threads on one canvas.

timeline_id

string

The threads on one timeline.

link_id

string

The threads on one share page, visitors' comments included.

thread_id

string

One conversation; newest page by default.

message_cursor

string

next_message_cursor for older messages in thread_id.

waiting_for_me

boolean

Only the threads someone in the workspace left waiting on your answer.

include_archived

boolean

Also the threads somebody has put away.

search

string

Words to find, over every message in a thread.

limit

integer

Required range: 1 <= x <= 200

cursor

string

next_cursor from the page before, with the same filters.

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok

any

required

data

object

required

meta

object

required

Show child attributes

media

object[]

get comments

curl --request POST \
  --url https://eversince.ai/api/v1/tools/get_comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "canvas_id": "<string>",
  "timeline_id": "<string>",
  "link_id": "<string>",
  "thread_id": "<string>",
  "message_cursor": "<string>",
  "waiting_for_me": true,
  "include_archived": true,
  "search": "<string>",
  "limit": 100,
  "cursor": "<string>"
}
'

import requests

url = "https://eversince.ai/api/v1/tools/get_comments"

payload = {
    "ref": "<string>",
    "canvas_id": "<string>",
    "timeline_id": "<string>",
    "link_id": "<string>",
    "thread_id": "<string>",
    "message_cursor": "<string>",
    "waiting_for_me": True,
    "include_archived": True,
    "search": "<string>",
    "limit": 100,
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ref: '<string>',
    canvas_id: '<string>',
    timeline_id: '<string>',
    link_id: '<string>',
    thread_id: '<string>',
    message_cursor: '<string>',
    waiting_for_me: true,
    include_archived: true,
    search: '<string>',
    limit: 100,
    cursor: '<string>'
  })
};

fetch('https://eversince.ai/api/v1/tools/get_comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}