BrainAPI
BrainAPI
ReferenceCore API

For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.

BrainAPI Metadata API

Inspect authentication scope and graph metadata.

GET
/meta/entity-labels

Retrieve all unique node labels present in the graph.

Parameters: brain_id (str): Identifier of the brain/graph to query. Defaults to "default".

Returns: labels (list[str]): List of unique node label names.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/meta/entity-labels"
[  "string"]
GET
/meta/entity-properties

Retrieve all unique property keys used by entities in the specified brain/graph.

Parameters: brain_id (str): Identifier of the brain/graph to query; defaults to "default".

Returns: list[str]: A list of property key names present on entities in the graph.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/meta/entity-properties"
[  "string"]
GET
/meta/login-info

Resolve whether a BrainPAT is the system token or scoped to a single brain.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/meta/login-info"
{  "brain_id": "string",  "is_system_pat": true}
GET
/meta/relationships-properties

Retrieve all unique relationship types present in the graph for the specified brain.

Parameters: brain_id (str): Identifier of the brain/graph to query. Defaults to "default".

Returns: A list of relationship type names (strings) found in the specified graph.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/meta/relationships-properties"
[  "string"]
Edit on GitHub

Last updated on