Search

Search for nodes in the graph database.

This endpoint performs semantic search across the knowledge graph to find relevant nodes based on the provided query. It supports different search types and can be scoped to specific datasets.

Request Parameters

search_type (SearchType): Type of search to perform
datasets (Optional[List[str]]): List of dataset names to search within
dataset_ids (Optional[List[UUID]]): List of dataset UUIDs to search within
query (str): The search query string
top_k (Optional[int]): Maximum number of results to return (default: 10)

Response

Returns a list of search results containing relevant nodes from the graph.

Error Codes

409 Conflict: Error during search operation
403 Forbidden: User doesn’t have permission to search datasets (returns empty list)

Notes

Datasets sent by name will only map to datasets owned by the request sender
To search datasets not owned by the request sender, dataset UUID is needed
If permission is denied, returns empty list instead of error

POST

api

curl --request POST \
  --url https://api.cognee.ai/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '{
  "searchType": "GRAPH_COMPLETION",
  "datasets": [
    "<string>"
  ],
  "datasetIds": [],
  "query": "What is in the document?",
  "topK": 123
}'

[
  "<any>"
]

Body

application/json

searchType

enum<string>

Available options:

SUMMARIES,

INSIGHTS,

CHUNKS,

RAG_COMPLETION,

GRAPH_COMPLETION,

GRAPH_SUMMARY_COMPLETION,

CODE,

CYPHER,

NATURAL_LANGUAGE,

GRAPH_COMPLETION_COT,

GRAPH_COMPLETION_CONTEXT_EXTENSION,

FEELING_LUCKY

datasets

string[] | null

datasetIds

string<uuid>[] | null

Examples:

[]

query

string

default:What is in the document?

topK

integer | null

default:10

Response

Successful Response

The response is of type any[].

Give Datasets Permission To PrincipalGrant permission on datasets to a principal (user or role). This endpoint allows granting specific permissions on one or more datasets to a principal (which can be a user or role). The authenticated user must have appropriate permissions to grant access to the specified datasets. ## Path Parameters - **principal_id** (UUID): The UUID of the principal (user or role) to grant permission to ## Request Parameters - **permission_name** (str): The name of the permission to grant (e.g., "read", "write", "delete") - **dataset_ids** (List[UUID]): List of dataset UUIDs to grant permission on ## Response Returns a success message indicating permission was assigned. ## Error Codes - **400 Bad Request**: Invalid request parameters - **403 Forbidden**: User doesn't have permission to grant access - **500 Internal Server Error**: Error granting permission

⌘I

curl --request POST \
  --url https://api.cognee.ai/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '{
  "searchType": "GRAPH_COMPLETION",
  "datasets": [
    "<string>"
  ],
  "datasetIds": [],
  "query": "What is in the document?",
  "topK": 123
}'

[
  "<any>"
]

Getting Started

API Reference

auth

add

cognify

search

permissions

datasets

settings

visualize

delete

responses

code-pipeline

users

Search

Request Parameters

Response

Error Codes

Notes

Body

Response