GET
/
v1
/
teams
/
{teamId}
/
team-memory
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.teamMemory.listTeamMemory({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "scope": "<string>",
      "title": "<string>",
      "description": "<string>",
      "content": "<string>",
      "pinned": true,
      "sourceRef": "<string>",
      "confidence": 123,
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "verified": true,
      "current": true,
      "embedded": true,
      "createdAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Query Parameters

​
kind
enum<string>

What the memory records: company_fact (true about the business), user_preference (how one person likes things done), observation (something noticed, e.g. by an agent) or rule (a standing instruction).

Available options:
company_fact,
user_preference,
observation,
rule
​
keyPrefix
string

Only keys starting with this prefix, e.g. rule/.

Maximum string length: 200
​
limit
string

a string to be decoded into a number

Response

ListTeamMemoryResponse

​
data
object[]
required