Pickaxe Learn

API Reference

Memory

Endpoints for end-user memory records.

Related In Learn

Users

Monitor user activity, manage memory, and administer your user base.

Open Learn

Memory endpoints manage end-user memory records.

Endpoints

POST /studio/memory/create

Create a new user memory to collect from your users.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/create

Request Fields

  • memory (string, required): The title that will best describe the information to collect.
  • prompt (string, required): The prompt that will instruct the AI on what kind of information to collect.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/memory/create \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "memory": "Work",
  "prompt": "Assess the user's work"
}'

POST /studio/memory/user/create

Create a collected memory specific to a user.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/user/create

Request Fields

  • userId (string, required): The ID of the user to associate the collected memory with.
  • memoryId (string, required): The ID of the memory to collect from your users. This should be an existing memory created from the /studio/memory/create endpoint.
  • value (string, required): The value of the memory to store for the user.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/memory/user/create \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "userId": "example@business.com",
  "memoryId": "MEMORY1A2B3C4D5E",
  "value": "Full Stack Web Developer"
}'

GET /studio/memory/list

List all user memories with optional pagination.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/list

Request Fields

  • skip (number, optional): The number of memories to skip for pagination. Defaults to 0.
  • take (number, optional): The number of memories to take for pagination. Defaults to 10.

Examples

curl -X GET https://api.pickaxe.co/v1/studio/memory/list?skip=0&take=10 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

GET /studio/memory/<memory_id>

Retrieve a specific user memory by its ID.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/<memory_id>

Request Fields

  • memoryId (string, required): The ID of the memory to retrieve.

Examples

curl -X GET https://api.pickaxe.co/v1/studio/memory/MEMORY1A2B3C4D5E \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

GET /studio/memory/user/<user_id>

Retrieve all memories associated with a specific user by their ID.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/user/<user_id>

Request Fields

  • userId (string, required): The ID of the user whose memories to retrieve.
  • memoryId (string, optional): The ID of the memory to retrieve.
  • skip (number, optional): The number of memories to skip for pagination. Defaults to 0.
  • take (number, optional): The number of memories to take for pagination. Defaults to 10.

Examples

curl -X GET https://api.pickaxe.co/v1/studio/memory/user/jane.doe@example.com?skip=0&take=10 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

PATCH /studio/memory/<memory_id>

Update a specific user memory by its ID.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/<memory_id>

Request Fields

  • memoryId (string, required): The ID of the memory to update.
  • data (object, required): The data to update the memory with.
    • isEnabled (boolean, optional): Whether the memory is enabled or not.

Examples

curl -X PATCH https://api.pickaxe.co/v1/studio/memory/MEMORY1A2B3C4D5E \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "data": {
    "isEnabled": true
  }
}'

PATCH /studio/memory/user/<email>/<memory_id>

Update a specific user memory by its ID for a specific user by their email.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/user/<email>/<memory_id>

Request Fields

  • email (string, required): The email of the user whose memory to update.
  • memoryId (string, required): The ID of the memory to update.
  • data (object, required): The data to update the memory with.
    • value (string, optional): The value of the memory to update.

Examples

curl -X PATCH https://api.pickaxe.co/v1/studio/memory/user/jane.doe@example.com/MEMORY1A2B3C4D5E \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "data": {
    "value": "Updated memory value"
  }
}'

DELETE /studio/memory/<memory_id>

Delete a specific user memory by its ID.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/<memory_id>

Request Fields

  • memoryId (string, required): The ID of the memory to delete.

Examples

curl -X DELETE https://api.pickaxe.co/v1/studio/memory/MEMORY1A2B3C4D5E \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /studio/memory/user/<email>

Delete collected memories associated with a specific user by their email.

  • Full URL: https://api.pickaxe.co/v1/studio/memory/user/<email>

Request Fields

  • email (string, required): The email of the user whose memories to delete.
  • memoryId (string, optional): The ID of the memory to delete.

Examples

curl -X DELETE https://api.pickaxe.co/v1/studio/memory/user/jane.doe@example.com \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Previous

Deployment

Next

User