Data

Verify a data record against a schema

post

Verify that a data record satisfies a JSON schema without saving it to the database.

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Body

application/json

DTO for verifying data against a JSON schema, can have any properties in additional to the required schemaUri

schemaUristringRequired

URL to JSON schema for validation

Example: https://example.com/schemas/memory.json

Responses

200

Validation completed

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/api/v1/data/verify

HTTPcURLJavaScriptPython

POST /api/v1/data/verify HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

{
  "valid": false,
  "errors": [
    {
      "field": "age",
      "message": "Invalid age",
      "value": 25
    }
  ]
}

Get data records

get

Get Data Records

This endpoint provides skip-based pagination for querying data records.

Key Features

• Pagination: Uses page numbers and limits for simple pagination

• Flexible filtering: Support for complex MongoDB-style filter (passed as URL-encoded JSON)

• Simple sorting: Sort by predefined fields with asc/desc order

Usage Examples

First Page Request

GET /data/v1/memories?page=1&limit=20&filter=%7B%22status%22%3A%22active%22%7D&sortBy=createdAt&sortOrder=desc

Next Page Request

GET /data/v1/memories?page=2&limit=20&filter=%7B%22status%22%3A%22active%22%7D&sortBy=createdAt&sortOrder=desc

Sort by Updated Date

GET /data/v1/memories?page=1&limit=10&sortBy=updatedAt&sortOrder=asc

Filter Examples

• Simple filter: { "status": "active" }

• Date range filter: { "createdAt": { "$gte": "2025-01-01T00:00:00.000Z" } }

• ObjectId filter: { "id": "507f1f77bcf86cd799439011" }

• Complex filter: { "$and": [{ "status": "active" }, { "priority": { "$gte": 5 } }] }

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

collectionstringRequired

Collection to look into

Example: memories

Query parameters

filterstringOptional

MongoDB-style filter object (passed as URL-encoded JSON string)

Example: { "status": "active" }

sortBystring · enumOptional

Field to sort by

Example: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Example: descPossible values:

limitnumberOptional

Number of records to return (1-100)

Example: 20

pagenumberOptional

Page number (1-based)

Example: 1

Responses

200

Query executed successfully

application/json

400

Invalid query parameters

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/api/v1/data/{collection}

HTTPcURLJavaScriptPython

GET /api/v1/data/{collection} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "title": "Sample Record",
      "content": "This is a sample record",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8,
    "hasNext": true,
    "hasPrev": false
  }
}

Create a new data record

post

Creates a new record in the specified collection.

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

collectionstringRequired

Collection to create the record into

Example: memories

Body

application/json

DTO for creating a new record, can have any properties in addition to the schemaUri used for validation.

schemaUristringOptional

URL to JSON schema for validation

Example: https://example.com/schemas/memory.json

Responses

201

Data record created successfully

application/json

400

Invalid request or data validation failed (if a validation schema is provided)

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/api/v1/data/{collection}

HTTPcURLJavaScriptPython

POST /api/v1/data/{collection} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

Get data record by ID

get

Retrieves a single data record by its unique identifier for a given collection.

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

collectionstringRequired

Collection to look into

Example: memories

recordIdstringRequired

ID of the data record to retrieve

Example: 66bd3762c23f9e3f152fb4d1

Responses

200

Data record retrieved successfully

application/json

401

Unauthorized

application/json

404

Record not found

application/json

500

Internal server error

application/json

get

/api/v1/data/{collection}/{recordId}

HTTPcURLJavaScriptPython

GET /api/v1/data/{collection}/{recordId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

Update an existing data record

put

Updates an existing data record.

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

collectionstringRequired

Collection the record belongs to

Example: memories

recordIdstringRequired

ID of the data record to update

Example: 66bd3762c23f9e3f152fb4d1

Body

application/json

DTO for updating an existing record, can have any properties in addition to the optional schemaUri used for validation.

schemaUristringOptional

URL to JSON schema for validation

Example: https://example.com/schemas/memory.json

Responses

200

Data record updated successfully

application/json

400

Invalid request or data validation failed (if a validation schema is provided)

application/json

401

Unauthorized

application/json

404

Record not found

application/json

500

Internal server error

application/json

put

/api/v1/data/{collection}/{recordId}

HTTPcURLJavaScriptPython

PUT /api/v1/data/{collection}/{recordId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

{
  "schemaUri": "https://example.com/schemas/memory.json"
}

Delete a data record by ID

delete

Deletes a data record from the specified collection by its unique identifier.

Required scope: user-data

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

collectionstringRequired

Collection the record belongs to

Example: memories

recordIdstringRequired

ID of the data record to delete

Example: 66bd3762c23f9e3f152fb4d1

Responses

204

Data record deleted successfully

401

Unauthorized

application/json

404

Record not found

application/json

500

Internal server error

application/json

delete

/api/v1/data/{collection}/{recordId}

HTTPcURLJavaScriptPython

DELETE /api/v1/data/{collection}/{recordId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content