Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Activity API

Get detailed activity logs and audit trails.

​
Get Activity Engrams

Get activity engrams (traces of receptor executions, memory operations, etc.).
Brain scope required. Include the X-Brain-Id header or configure getBrainId in the public client.
GET /v1/activity/engrams

​
Headers

HeaderTypeDescription
X-Brain-Idstring (UUID)Required. Brain ID for scoping

​
Query Parameters

ParameterTypeDescription
source_typesstring[]Filter by source types (comma-separated)
target_typesstring[]Filter by target types (comma-separated)
hoursnumberHours to look back (default: 24)
limitnumberMaximum number of results (default: 10000, max: 50000)
offsetnumberOffset for pagination
Workspace is derived from auth context; do not pass workspace_slug.

​
Example Request

const auvy = createAUVYClient({
  apiKey: 'your-api-key',
  getBrainId: () => 'your-brain-id',
  fetch
})

const { engrams } = await auvy.activity.getEngrams({
  source_types: ['synapse'],
  limit: 50
})

​
Example Response

{
  "engrams": [
    {
      "id": "engram-uuid",
      "source_type": "synapse",
      "source_id": "synapse-uuid",
      "target_type": "memory",
      "target_id": "memory-uuid",
      "trace_type": "thread",
      "trace_id": "thread-uuid",
      "parent_type": null,
      "parent_id": null,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 100,
  "returned": 50,
  "has_more": true
}

​
Source Types

Common source types for filtering:
  • synapse - Receptor-backed synapse executions
  • memory - Memory operations
  • pathway - Pathway executions
  • neuron - neuronExecution