Skip to main content
POST
/
memories
/
{memory_id}
/
pin
Pin Memory
curl --request POST \
  --url https://api.example.com/memories/{memory_id}/pin \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "context_pack_id": "<string>",
  "version": 123,
  "content": {},
  "source": {
    "type": "<string>",
    "conversation_id": "<string>",
    "turn_index": 123,
    "actor": "<string>",
    "confidence": 0.5,
    "document_url": "<string>"
  },
  "classification": {
    "domain": "<string>",
    "priority": "normal",
    "tags": [
      "<string>"
    ],
    "sensitivity": "<string>"
  },
  "metadata": {},
  "quality": {
    "validation_status": "unvalidated",
    "confidence_score": 123,
    "validated_at": "2023-11-07T05:31:56Z",
    "validated_by": "<string>"
  },
  "access": {
    "count": 123,
    "success_count": 123,
    "failure_count": 123,
    "last_accessed": "2023-11-07T05:31:56Z",
    "success_rate": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "content_url": "<string>",
  "search_text": "<string>",
  "superseded_by": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "superseded_at": "2023-11-07T05:31:56Z",
  "reactivated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "pinned": false,
  "pinned_at": "2023-11-07T05:31:56Z",
  "unpinned_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
memory_id
string<uuid>
required

Response

Successful Response

​
id
string
required
​
context_pack_id
string
required
​
version
integer
required
​
content
Content · object
required
​
memory_type
enum<string>
required
Available options:
fact,
experience,
observation,
instruction,
preference,
summary,
glossary,
ontology,
textual_pattern,
kpi,
exemplar,
join,
numeric_pattern,
policy
​
source
MemorySourceInfo · object
required
​
classification
MemoryClassificationInfo · object
required
​
metadata
Metadata · object
required
​
quality
MemoryQualityInfo · object
required
​
access
MemoryAccessInfo · object
required
​
status
enum<string>
required
Available options:
active,
superseded,
archived,
deleted
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
content_url
string | null
​
search_text
string | null
​
superseded_by
string | null
​
archived_at
string<date-time> | null
​
deleted_at
string<date-time> | null
​
superseded_at
string<date-time> | null
​
reactivated_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
pinned
boolean
default:false
​
pinned_at
string<date-time> | null
​
unpinned_at
string<date-time> | null