Update a memory

curl --request PATCH \
  --url https://api.example.com/utils/memories/{memory_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "asset_fqn": "<string>",
  "content": {
    "text": "<string>",
    "type": "text"
  },
  "content_url": "<string>",
  "search_text": "<string>",
  "classification": {
    "domain": "<string>",
    "priority": "normal",
    "tags": [
      "<string>"
    ],
    "sensitivity": "<string>"
  },
  "meta_data": {},
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.example.com/utils/memories/{memory_id}"

payload = {
    "name": "<string>",
    "asset_fqn": "<string>",
    "content": {
        "text": "<string>",
        "type": "text"
    },
    "content_url": "<string>",
    "search_text": "<string>",
    "classification": {
        "domain": "<string>",
        "priority": "normal",
        "tags": ["<string>"],
        "sensitivity": "<string>"
    },
    "meta_data": {},
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    asset_fqn: '<string>',
    content: {text: '<string>', type: 'text'},
    content_url: '<string>',
    search_text: '<string>',
    classification: {
      domain: '<string>',
      priority: 'normal',
      tags: ['<string>'],
      sensitivity: '<string>'
    },
    meta_data: {},
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.example.com/utils/memories/{memory_id}', 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.example.com/utils/memories/{memory_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'asset_fqn' => '<string>',
    'content' => [
        'text' => '<string>',
        'type' => 'text'
    ],
    'content_url' => '<string>',
    'search_text' => '<string>',
    'classification' => [
        'domain' => '<string>',
        'priority' => 'normal',
        'tags' => [
                '<string>'
        ],
        'sensitivity' => '<string>'
    ],
    'meta_data' => [
        
    ],
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/utils/memories/{memory_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/utils/memories/{memory_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/utils/memories/{memory_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "context_pack_id": "<string>",
  "version": 123,
  "content": {},
  "memory_type": "fact",
  "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>"
  },
  "meta_data": {},
  "quality": {
    "validation_status": "unvalidated",
    "confidence_score": 0.5,
    "validated_by": "<string>",
    "validated_at": "2023-11-07T05:31:56Z"
  },
  "access": {
    "count": 0,
    "last_accessed": "2023-11-07T05:31:56Z",
    "success_count": 0,
    "failure_count": 0,
    "success_rate": 123
  },
  "status": "active",
  "pinned": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_fqn": "<string>",
  "content_url": "<string>",
  "search_text": "<string>",
  "superseded_by": "<string>",
  "pinned_at": "2023-11-07T05:31:56Z",
  "unpinned_at": "2023-11-07T05:31:56Z",
  "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"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

PATCH

utils

memories

{memory_id}

Update a memory

curl --request PATCH \
  --url https://api.example.com/utils/memories/{memory_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "asset_fqn": "<string>",
  "content": {
    "text": "<string>",
    "type": "text"
  },
  "content_url": "<string>",
  "search_text": "<string>",
  "classification": {
    "domain": "<string>",
    "priority": "normal",
    "tags": [
      "<string>"
    ],
    "sensitivity": "<string>"
  },
  "meta_data": {},
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.example.com/utils/memories/{memory_id}"

payload = {
    "name": "<string>",
    "asset_fqn": "<string>",
    "content": {
        "text": "<string>",
        "type": "text"
    },
    "content_url": "<string>",
    "search_text": "<string>",
    "classification": {
        "domain": "<string>",
        "priority": "normal",
        "tags": ["<string>"],
        "sensitivity": "<string>"
    },
    "meta_data": {},
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    asset_fqn: '<string>',
    content: {text: '<string>', type: 'text'},
    content_url: '<string>',
    search_text: '<string>',
    classification: {
      domain: '<string>',
      priority: 'normal',
      tags: ['<string>'],
      sensitivity: '<string>'
    },
    meta_data: {},
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.example.com/utils/memories/{memory_id}', 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.example.com/utils/memories/{memory_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'asset_fqn' => '<string>',
    'content' => [
        'text' => '<string>',
        'type' => 'text'
    ],
    'content_url' => '<string>',
    'search_text' => '<string>',
    'classification' => [
        'domain' => '<string>',
        'priority' => 'normal',
        'tags' => [
                '<string>'
        ],
        'sensitivity' => '<string>'
    ],
    'meta_data' => [
        
    ],
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/utils/memories/{memory_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/utils/memories/{memory_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/utils/memories/{memory_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"asset_fqn\": \"<string>\",\n  \"content\": {\n    \"text\": \"<string>\",\n    \"type\": \"text\"\n  },\n  \"content_url\": \"<string>\",\n  \"search_text\": \"<string>\",\n  \"classification\": {\n    \"domain\": \"<string>\",\n    \"priority\": \"normal\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"sensitivity\": \"<string>\"\n  },\n  \"meta_data\": {},\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "context_pack_id": "<string>",
  "version": 123,
  "content": {},
  "memory_type": "fact",
  "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>"
  },
  "meta_data": {},
  "quality": {
    "validation_status": "unvalidated",
    "confidence_score": 0.5,
    "validated_by": "<string>",
    "validated_at": "2023-11-07T05:31:56Z"
  },
  "access": {
    "count": 0,
    "last_accessed": "2023-11-07T05:31:56Z",
    "success_count": 0,
    "failure_count": 0,
    "success_rate": 123
  },
  "status": "active",
  "pinned": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_fqn": "<string>",
  "content_url": "<string>",
  "search_text": "<string>",
  "superseded_by": "<string>",
  "pinned_at": "2023-11-07T05:31:56Z",
  "unpinned_at": "2023-11-07T05:31:56Z",
  "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"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

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

Headers

X-Project-ID

string | null

Path Parameters

memory_id

string

required

Memory ID

Body

application/json

Request to update a memory.

name

string | null

Updated name

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.:-]*$

asset_fqn

string | null

Updated asset FQN

Required string length: 1 - 512

content

TextContent · object

Plain text memory content.

TextContent
StructuredContent
JsonContent
CodeContent
ExperienceContent

Show child attributes

content_url

string | null

Updated content URL

search_text

string | null

Updated search text

classification

MemoryClassificationInfo · object | null

Updated classification

Show child attributes

meta_data

Meta Data · object | null

Updated metadata

expires_at

string<date-time> | null

Updated expiration time

Response

Successful Response

Full response model for a memory.

string

required

Memory ID

name

string

required

Memory name

organization_id

string

required

Organization ID

project_id

string

required

Project ID

context_pack_id

string

required

Parent context pack ID

version

integer

required

Version number

content

Content · object

required

Memory content

memory_type

enum<string>

required

Memory type

Available options:

fact,

experience,

observation,

instruction,

preference,

summary,

glossary,

ontology,

textual_pattern,

kpi,

exemplar,

join,

numeric_pattern,

policy

source

MemorySourceInfo · object

required

Source information

Show child attributes

classification

MemoryClassificationInfo · object

required

Classification

Show child attributes

meta_data

Meta Data · object

required

User-defined metadata

quality

MemoryQualityInfo · object

required

Quality information

Show child attributes

access

MemoryAccessInfo · object

required

Access tracking (PLACEHOLDER)

Show child attributes

status

enum<string>

required

Current status

Available options:

active,

superseded,

archived,

deleted

pinned

boolean

required

Whether pinned

created_at

string<date-time>

required

Creation timestamp

updated_at

string<date-time>

required

Last update timestamp

asset_fqn

string | null

Dot-separated catalog asset FQN

content_url

string | null

External content URL

search_text

string | null

Search text

superseded_by

string | null

ID of superseding memory

pinned_at

string<date-time> | null

Pin timestamp

unpinned_at

string<date-time> | null

Unpin timestamp

archived_at

string<date-time> | null

Archive timestamp

deleted_at

string<date-time> | null

Deletion timestamp

superseded_at

string<date-time> | null

Supersede timestamp

reactivated_at

string<date-time> | null

Reactivation timestamp

expires_at

string<date-time> | null

Expiration timestamp

Overview

Platform APIs

Solution APIs

SDKs & Client Libraries

Update a memory

Authorizations

Headers

Path Parameters

Body

Response