Skip to main content

ProjectStorageRequest

oneOf
projectIdstring<uuid>required

Current project UUID; mutually exclusive with consumerProjectId and alias.

consumerProjectIdstring<uuid>

Consumer project UUID for related-project access; must be provided with alias.

aliasstring

Related-project alias declared by the consumer; Server resolves the target UUID.

Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

storageKindstringrequired

Possible values: [kv, persistent_value]

operationstringrequired

Possible values: [get, set, compare-and-set, knowledge-mutation]

entry object
scopeProjectStorageScoperequired

Possible values: [project, conversation]

keystringrequired
projectIdstring<uuid>

Required for current-project requests and must equal the top-level projectId; forbidden for related-project requests.

conversationIdstring
value

Set and compare-and-set operations are required; must be JSON value and cannot be omitted.

expectedRevisionstring | nullnullable

compare-and-set operation is required. The revision returned by the pass-in get; null is passed when no value is first created.

source object
projectIdstring<uuid>

Must equal projectId for current access or consumerProjectId for related-project access.

runIdstring
conversationIdstring
namespace object
scopestringrequired
Constant value: project
projectIdstring<uuid>required

Must equal the request projectId.

mutation object
typestringrequired

Possible values: [create, edit, delete]

input objectrequired
oneOf
idstring

the optional document id. If omitted, the server is generated based on the title.

titlestringrequired
markdownstringrequired
ProjectStorageRequest
{
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "consumerProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "alias": "string",
  "storageKind": "kv",
  "operation": "get",
  "entry": {
    "scope": "project",
    "key": "string",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "conversationId": "string"
  },
  "expectedRevision": "string",
  "source": {
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "runId": "string",
    "conversationId": "string"
  },
  "namespace": {
    "scope": "project",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "mutation": {
    "type": "create",
    "input": {
      "id": "string",
      "title": "string",
      "markdown": "string"
    }
  }
}