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

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

const response = await client.teamMemory.appendTeamMemoryEntry({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "entry": {
    "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>"
  },
  "supersededEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Body

application/json
​
kind
enum<string>
required

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
​
title
string
required

Short one-line label for the memory, 1-200 characters, no control characters.

Required string length: 1 - 200
Pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
​
content
string
required

The memory itself in plain text or markdown, 1-4000 characters.

Required string length: 1 - 4000
​
key
string

Omit to derive one from the kind and title (rule/no-emojis). Writing to a key with a current entry supersedes it and requires expectedCurrentEntryId.

Maximum string length: 200
Pattern: ^[a-z0-9][a-z0-9_-]*(\/[a-z0-9][a-z0-9_-]*){0,7}$
​
description
string

Optional one-line summary, up to 500 characters.

Maximum string length: 500
​
pinned
boolean

Pin the entry so only a person can displace it.

​
scope
string

Omit for the default: team, or the caller for user_preference. Only admins may write another member's preference.

Required string length: 1 - 64
​
confidence
number

How sure the writer is that the memory is true, from 0 to 1.

Required range: 0 <= x <= 1
​
expectedCurrentEntryId
string<uuid> | null

The current entry for the key this append supersedes; null or omitted when the key has none. A stale value returns 409 and writes nothing.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
relations
maxItems(10) · object[]

Up to 10 relations from the new entry to existing ones.

Maximum array length: 10

Response

Success

​
entry
object
required
​
supersededEntryId
string<uuid> | null
required

The entry this append superseded; null when the key was new.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
embedding
enum<string>
required

pending when the vector could not be created yet; the entry is still found by keyword search and can be embedded later by the backfill endpoint.

Available options:
ready,
pending