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
• system_prompt Optional[str]: System prompt to be used for Completion type searches in Cognee
• node_name Optional[list[str]]: Filter results to specific node_sets defined in the add pipeline (for targeted search).
• top_k (Optional[int]): Maximum number of results to return (default: 10)
• only_context bool: Set to true to only return context Cognee will be sending to LLM in Completion type searches. This will be returned instead of LLM calls for completion type searches.

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/v1/search

Search

cURL

curl --request POST \
  --url https://api.cognee.ai/api/v1/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_type": "GRAPH_COMPLETION",
  "query": "What is Cognee?",
  "top_k": 10
}
'

200

[
  {
    "search_result": "<unknown>",
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_name": "<string>"
  }
]

Body

application/json

searchType · enum<string> · default: GRAPH_COMPLETION

Available options: SUMMARIES, CHUNKS, RAG_COMPLETION, TRIPLET_COMPLETION, GRAPH_COMPLETION, GRAPH_SUMMARY_COMPLETION, CYPHER, NATURAL_LANGUAGE, GRAPH_COMPLETION_COT, GRAPH_COMPLETION_CONTEXT_EXTENSION, FEELING_LUCKY, TEMPORAL, CODING_RULES, CHUNKS_LEXICAL

datasets · string[] | null

datasetIds · string<uuid>[] | null

Example:

[]

query · string · default: What is in the document?

systemPrompt · string | null · default: Answer the question using the provided context. Be as brief as possible.

nodeName · string[] | null

Example:

[]

topK · integer | null · default: 10

onlyContext · boolean · default: false

verbose · boolean · default: false

Response

200

application/json

Successful Response

search_result · any · required

dataset_id · string<uuid> | null · required

dataset_name · string | null · required