MechaMental
Api reference

Entities

List Entities

GET
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id

Query Parameters

entity_type?string|null
limit?Limit
Default100
Range1 <= value <= 1000

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "entities": []
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Entity

POST
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "entity_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "name": "string",
  "entity_type": "person",
  "description": "string",
  "aliases": [],
  "relations": [],
  "source_memory_ids": [],
  "importance": 0.5,
  "mention_count": 0,
  "last_referenced_at": "string",
  "metadata": {},
  "tags": [],
  "is_indexed": false,
  "created_at": "",
  "updated_at": ""
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Entity

GET
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities/{entity_id}

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id
entity_id*Entity Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities/string"
{
  "entity_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "name": "string",
  "entity_type": "person",
  "description": "string",
  "aliases": [],
  "relations": [],
  "source_memory_ids": [],
  "importance": 0.5,
  "mention_count": 0,
  "last_referenced_at": "string",
  "metadata": {},
  "tags": [],
  "is_indexed": false,
  "created_at": "",
  "updated_at": ""
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Delete Entity

DELETE
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities/{entity_id}

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id
entity_id*Entity Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities/string"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Entity

PUT
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities/{entity_id}

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id
entity_id*Entity Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "entity_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "name": "string",
  "entity_type": "person",
  "description": "string",
  "aliases": [],
  "relations": [],
  "source_memory_ids": [],
  "importance": 0.5,
  "mention_count": 0,
  "last_referenced_at": "string",
  "metadata": {},
  "tags": [],
  "is_indexed": false,
  "created_at": "",
  "updated_at": ""
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Relation

POST
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities/relations

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities/relations" \  -H "Content-Type: application/json" \  -d '{    "source_entity_id": "string",    "target_entity_id": "string",    "relation_type": "string"  }'
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Traverse Graph

POST
/v1/orgs/{org_id}/workspaces/{workspace_id}/apps/{app_id}/namespaces/{namespace_id}/entities/{entity_id}/traverse

Path Parameters

org_id*Org Id
workspace_id*Workspace Id
app_id*App Id
namespace_id*Namespace Id
entity_id*Entity Id

Query Parameters

depth?Depth
Default1
Range1 <= value <= 3
relation_types?array<string>|null
include_memories?Include Memories
Defaulttrue

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/entities/string/traverse"
{
  "root": {
    "entity_id": "string",
    "workspace_id": "string",
    "namespace_id": "string",
    "name": "string",
    "entity_type": "person",
    "description": "string",
    "aliases": [],
    "relations": [],
    "source_memory_ids": [],
    "importance": 0.5,
    "mention_count": 0,
    "last_referenced_at": "string",
    "metadata": {},
    "tags": [],
    "is_indexed": false,
    "created_at": "",
    "updated_at": ""
  },
  "connected_entities": [],
  "linked_memories": [],
  "depth_reached": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Endpoints

Previous Page

Environments

Next Page