Skip to content
SupaCloud Docs
Select themeSelect language

get_api_memories_graph

GET
/api/memories/graph
curl --request GET \
  --url https://example.com/api/memories/graph

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_archived
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Memory graph with nodes, edges and health findings

Media typeapplication/json
object
edges
required
Array<object>
object
id
required
string
kind
required
string
label
required
string
source
required
string
target
required
string
weight
required
number format: double
health
required
Array<object>
object
action
required
string
detail
required
string
id
required
string
kind
required
string
memory_id
string | null format: uuid
related_memory_id
string | null format: uuid
severity
required
string
title
required
string
metrics
required
object
active_count
required
integer
archived_count
required
integer
edge_count
required
integer
health_count
required
integer
memory_count
required
integer
pinned_count
required
integer
nodes
required
Array<object>
object
archived
required
boolean
id
required
string
kind
required
string
label
required
string
memory_id
string | null format: uuid
metadata
required
weight
required
number format: double
Examplegenerated
{
  "edges": [
    {
      "id": "example",
      "kind": "example",
      "label": "example",
      "source": "example",
      "target": "example",
      "weight": 1
    }
  ],
  "health": [
    {
      "action": "example",
      "detail": "example",
      "id": "example",
      "kind": "example",
      "memory_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "related_memory_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "severity": "example",
      "title": "example"
    }
  ],
  "metrics": {
    "active_count": 1,
    "archived_count": 1,
    "edge_count": 1,
    "health_count": 1,
    "memory_count": 1,
    "pinned_count": 1
  },
  "nodes": [
    {
      "archived": true,
      "id": "example",
      "kind": "example",
      "label": "example",
      "memory_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "metadata": "example",
      "weight": 1
    }
  ]
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}