Session briefing over an explicit selector (mirrors the MCP briefing tool)

GET

api

briefing

curl --request GET \
  --url https://api.3ngram.ai/api/v1/briefing \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.3ngram.ai/api/v1/briefing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.3ngram.ai/api/v1/briefing"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.3ngram.ai/api/v1/briefing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "generatedAt": "2023-11-07T05:31:56Z",
  "mode": "brief",
  "selector": {
    "kind": "all"
  },
  "appliedScope": "<string>",
  "blockers": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "commitments": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "dueAt": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overdue": true,
        "status": "open",
        "topic": "<string>"
      }
    ]
  },
  "overdue": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "dueAt": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overdue": true,
        "status": "open",
        "topic": "<string>"
      }
    ]
  },
  "preferences": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "recentDecisions": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "staleCandidates": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "error": "invalid_input",
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

kind

enum<string>

required

Available options:

all,

scope,

project,

scope_project

scope

string

Required string length: 1 - 64

Pattern: ^[a-z0-9][a-z0-9-]*$

project

string

Required string length: 1 - 256

includeUnscoped

boolean

default:false

Also match memories in the scope written with NO project (project IS NULL). Default false: strict scope AND project intersection.

mode

enum<string>

Available options:

brief,

full

sections

string

Comma-separated subset of sections to compute (unique names from: commitments, overdue, blockers, staleCandidates, recentDecisions, preferences). Absent = all sections; un-requested sections are skipped and omitted from the result.

sectionLimit

integer

Per-section item bound (1..100). Absent = the mode default (3 brief / 25 full).

Required range: 1 <= x <= 100

Response

Success

generatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

mode

enum<string>

required

Available options:

brief,

full

selector

object

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

appliedScope

string

Scope your retrieval-scope policy applied to this unscoped call (mode default). Absent when nothing was narrowed.

Required string length: 1 - 64

Pattern: ^[a-z0-9][a-z0-9-]*$

blockers

object

Show child attributes

commitments

object

Show child attributes

overdue

object

Show child attributes

preferences

object

Show child attributes

recentDecisions

object

Show child attributes

staleCandidates

object

Show child attributes

Session briefing over an explicit selector (mirrors the MCP briefing tool)

curl --request GET \
  --url https://api.3ngram.ai/api/v1/briefing \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.3ngram.ai/api/v1/briefing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.3ngram.ai/api/v1/briefing"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.3ngram.ai/api/v1/briefing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "generatedAt": "2023-11-07T05:31:56Z",
  "mode": "brief",
  "selector": {
    "kind": "all"
  },
  "appliedScope": "<string>",
  "blockers": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "commitments": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "dueAt": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overdue": true,
        "status": "open",
        "topic": "<string>"
      }
    ]
  },
  "overdue": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "dueAt": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overdue": true,
        "status": "open",
        "topic": "<string>"
      }
    ]
  },
  "preferences": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "recentDecisions": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "staleCandidates": {
    "count": 4503599627370495,
    "hasMore": true,
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memoryType": "decision",
        "project": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z",
        "scope": "<string>",
        "topic": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "error": "invalid_input",
  "detail": "<string>"
}

MCP reference

CLI & SDK

API reference

Session briefing over an explicit selector (mirrors the MCP briefing tool)

Authorizations

Query Parameters

Response