Types API

REST Admin only

Basics

Data Types act as the blueprints for your data. They define the JSON Schema that every object must satisfy before it can be saved.

• Base path: /api/memory/types
• Auth: Authorization: Bearer <token>

List types

GET /api/memory/types

Retrieves all available type definitions.

Response

{
  "items": [
    {
      "id": "b1820464-9e11...",
      "type": "Ticket",
      "version": 1,
      "jsonSchema": { "type": "object" }
    }
  ]
}

Create a type

POST /api/memory/types

Define a new blueprint. You provide a unique name and the validation schema.

Body

Field	Type	Required	Description
type	string	Yes	Unique identifier (for example Ticket).
jsonSchema	object	Yes	Valid JSON Schema object.
groupNames	string[]	No	PARAMETER, RETURN, or KNOWLEDGE.

Example

{
  "type": "Ticket",
  "groupNames": ["KNOWLEDGE"],
  "jsonSchema": {
    "type": "object",
    "required": ["status"],
    "properties": {
      "status": { "type": "string" },
      "priority": { "type": "string" }
    }
  }
}

Update a type

PUT /api/memory/types/{id}

Update the schema or metadata for an existing type.

Body

Field	Type	Required	Description
jsonSchema	object	Yes	The new validation schema.
groupNames	string[]	No	The updated list of groups.

Response

Returns the active type definition.

Automatic versioning

You don’t need to manage version numbers manually.

• If you update a schema that already has data stored against it, the system automatically versions it safely for you.
• Always use the ID returned in the response for future operations, as it may differ from the ID in your request.

Delete a type

DELETE /api/memory/types/{id}

Removes the definition.

• Constraint: you cannot delete a type if objects are still using it. Delete dependent objects first to keep data consistent.