AIsuru Docs
AIsuru API
AIsuru API
  • Introduzione
  • Engine
    • ChatLogs
    • ContextVars
    • CorrelationPairs
    • CustomDictionary
    • Dialog
    • EventLogs
    • ExpertReferences
    • Functions
    • Intents
    • LocalizationKeys
    • Media
    • Memories
    • NLP
    • People
    • Search
    • Session
    • Stats
    • Topics
    • UnansweredQuestions
    • User
    • WebHooks
    • Models
  • Backend
    • ActionLog
    • Analysis
    • Asset
    • Badge
    • CompletionConfig
    • ConsumptionLog
    • ImportExport
    • Integration
    • Invitation
    • Memori
    • MemoriList
    • Notification
    • Process
    • Tenant
    • User
    • Models
Powered by GitBook
On this page
  1. Engine

Media

PreviousLocalizationKeysNextMemories

Lists all Medium objects of a Memory.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

Responses
200
Success
application/json
get
GET /memori/v2/Media/{strSessionID}/{strMemoryID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "media": [
    {
      "mediumID": "text",
      "url": "text",
      "content": "text",
      "mimeType": "text",
      "title": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "creationTimestamp": "2025-06-07T14:38:43.960Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T14:38:43.960Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes all Medium objects from a Memory.

delete

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

Responses
200
Success
application/json
delete
DELETE /memori/v2/Media/{strSessionID}/{strMemoryID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Medium object of a Memory.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

strMediumIDstringRequired

The Medium object ID

Responses
200
Success
application/json
get
GET /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "medium": {
    "mediumID": "text",
    "url": "text",
    "content": "text",
    "mimeType": "text",
    "title": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "creationTimestamp": "2025-06-07T14:38:43.960Z",
    "creationSessionID": "text",
    "lastChangeTimestamp": "2025-06-07T14:38:43.960Z",
    "lastChangeSessionID": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Medium object from a Memory.

delete

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

strMediumIDstringRequired

The Medium object ID

Responses
200
Success
application/json
delete
DELETE /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}
  • GETLists all Medium objects of a Memory.
  • DELETERemoves all Medium objects from a Memory.
  • GETGets the details of a Medium object of a Memory.
  • DELETERemoves an existing Medium object from a Memory.
  • PATCHUpdates an existing Medium object of a Memory.
  • POSTAdds a new Medium object to a Memory.

Updates an existing Medium object of a Memory.

patch

This API requires a Giver session. Only non-null (present) fields are considered for update. Null or absent fields are left unaltered.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

strMediumIDstringRequired

The Medium object ID

Body
mediumIDstring | nullableOptional

Medium object ID.

urlstring | nullableOptional

URL of the Medium. If specified, the Content property must be Null. Use this property to link large amounts of data stored externally. If the amount of data is modest the Content property may be used as an alternative.

contentstring | nullableOptional

Content of the Medium. If specified, the URL property must be Null. Don't use this property to store large amounts of data. Can be used to store limited text for a maximum of 10 KiB. For larger amounts store the data externally and link it via the URL property.

mimeTypestring | nullableOptional

MIME type of the Medium. Required during Add operations.

titlestring | nullableOptional

Title of the Medium.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.

creationSessionIDstring | nullableOptional

ID of the session that created this object.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.

lastChangeSessionIDstring | nullableOptional

ID of the latest session that changed this object.

Responses
200
Success
application/json
patch
PATCH /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "mediumID": "text",
  "url": "text",
  "content": "text",
  "mimeType": "text",
  "title": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "creationTimestamp": "2025-06-07T14:38:43.960Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T14:38:43.960Z",
  "lastChangeSessionID": "text"
}
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Adds a new Medium object to a Memory.

post

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strMemoryIDstringRequired

The Memory object ID

Body

Specifications of a Medium object.

mediumIDstring | nullableOptional

Medium object ID.

urlstring | nullableOptional

URL of the Medium. If specified, the Content property must be Null. Use this property to link large amounts of data stored externally. If the amount of data is modest the Content property may be used as an alternative.

contentstring | nullableOptional

Content of the Medium. If specified, the URL property must be Null. Don't use this property to store large amounts of data. Can be used to store limited text for a maximum of 10 KiB. For larger amounts store the data externally and link it via the URL property.

mimeTypestring | nullableOptional

MIME type of the Medium. Required during Add operations.

titlestring | nullableOptional

Title of the Medium.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.

creationSessionIDstring | nullableOptional

ID of the session that created this object.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.

lastChangeSessionIDstring | nullableOptional

ID of the latest session that changed this object.

Responses
200
Success
application/json
post
POST /memori/v2/Medium/{strSessionID}/{strMemoryID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "mediumID": "text",
  "url": "text",
  "content": "text",
  "mimeType": "text",
  "title": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "creationTimestamp": "2025-06-07T14:38:43.960Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T14:38:43.960Z",
  "lastChangeSessionID": "text"
}
200

Success

{
  "mediumID": "text",
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:38:43.960Z",
  "resultCode": 1,
  "resultMessage": "text"
}