{"openapi":"3.1.0","info":{"title":"BrainAPI","description":"Knowledge, memory, search, recommendation, and agent API.","version":"2.19.0.dev0"},"paths":{"/auth/session":{"post":{"tags":["auth"],"summary":"Login","operationId":"auth_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLogin"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Login. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/auth/me":{"get":{"tags":["auth"],"summary":"Me","operationId":"auth_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Me. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/auth/logout":{"post":{"tags":["auth"],"summary":"Logout","operationId":"auth_logout_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoutResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Logout. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/access-tokens":{"get":{"tags":["access-tokens"],"summary":"List Tokens","operationId":"access_tokens_list_tokens_get","parameters":[{"name":"brain_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"List Tokens. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["access-tokens"],"summary":"Create Token","operationId":"access_tokens_create_token_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCreation"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedAccessTokenResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Create Token. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/access-tokens/{token_id}":{"delete":{"tags":["access-tokens"],"summary":"Revoke Token","operationId":"access_tokens_revoke_token_delete","parameters":[{"name":"token_id","in":"path","required":true,"schema":{"type":"string","title":"Token Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenMetadataResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Revoke Token. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/ingest/":{"post":{"tags":["ingest"],"summary":"Ingest Data","description":"Accept data for asynchronous ingestion.","operationId":"ingest_ingest_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionRequestBody"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionAcceptedResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/ingest/structured":{"post":{"tags":["ingest"],"summary":"Ingest Structured Data","description":"Accept structured data for asynchronous ingestion.","operationId":"ingest_ingest_structured_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionStructuredRequestBody"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionAcceptedResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/ingest/file":{"post":{"tags":["ingest"],"summary":"Ingest File","description":"Ingest a file into the processing pipeline and save to the memory.","operationId":"ingest_ingest_file_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_ingest_ingest_file_post"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionAcceptedResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/":{"get":{"tags":["retrieve"],"summary":"Retrieve","description":"Retrieve data from the knowledge graph and data store.","operationId":"retrieve_retrieve_get","parameters":[{"name":"text","in":"query","required":true,"schema":{"type":"string","description":"The text to search for.","title":"Text"},"description":"The text to search for."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"The number of results to return.","default":10,"title":"Limit"},"description":"The number of results to return."},{"name":"preferred_entities","in":"query","required":false,"schema":{"type":"string","description":"The entities to prioritize in the relationships, separated by commas.","default":"","title":"Preferred Entities"},"description":"The entities to prioritize in the relationships, separated by commas."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRequestResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entities/neighbors":{"get":{"tags":["retrieve"],"summary":"Get Neighbors","description":"Get the neighbors of an entity.","operationId":"retrieve_get_neighbors_get","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string","description":"The UUID of the entity to get neighbors for.","title":"Uuid"},"description":"The UUID of the entity to get neighbors for."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"The number of neighbors to return.","default":10,"title":"Limit"},"description":"The number of neighbors to return."},{"name":"look_for","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The description of what in the neighbors should share with the target.","title":"Look For"},"description":"The description of what in the neighbors should share with the target."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveNeighborsRequestResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["retrieve"],"summary":"Get Neighbors With Identification Params","description":"Get the neighbors of an entity.","operationId":"retrieve_get_neighbors_with_identification_params_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveNeighborsWithIdentificationParamsRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveNeighborsRequestResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entities/neighbors/ai-mode":{"post":{"tags":["retrieve"],"summary":"Get Neighbors Ai Mode","description":"Retrieve neighboring entities using AI-mode identification parameters.\n\nParameters:\n    request (RetrieveNeighborsAiModeRequestBody): Request body containing:\n        - identification_params: parameters that identify the target entity or entities.\n        - looking_for: description of the desired neighbors or relation types.\n        - limit: maximum number of neighbor results to return.\n\nReturns:\n    list: Neighboring entities that match the AI-mode identification and search criteria.","operationId":"retrieve_get_neighbors_ai_mode_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveNeighborsAiModeRequestBody","description":"The request body for the retrieve neighbors AI mode endpoint."}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveNeighborsRequestResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/context":{"post":{"tags":["retrieve"],"summary":"Get Context","description":"Handle an HTTP request to retrieve an entity's contextual information.\n\nParameters:\n    request (GetContextRequestBody): Request body containing:\n        - text: The text to search context for.\n        - brain_id: The brain/workspace identifier to query.\n\nReturns:\n    GetContextResponse: Response containing the context information.","operationId":"retrieve_get_context_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContextRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContextResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/relationships":{"get":{"tags":["retrieve"],"summary":"Get Relationships","description":"Retrieve relationships filtered by types, node labels, and query criteria.\n\nParameters:\n    relationship_types (Optional[str]): Comma-separated relationship types to include.\n    from_node_labels (Optional[str]): Comma-separated source node labels to filter.\n    to_node_labels (Optional[str]): Comma-separated target node labels to filter.\n    query_text (Optional[str]): Text to match against relationships or nodes.\n    query_search_target (Optional[str]): Target of the text query, such as \"all\", \"source\", or \"target\".\n    limit (int): Maximum number of relationships to return.\n    skip (int): Number of relationships to skip.\n    brain_id (str): Brain (dataset) identifier.\n\nReturns:\n    List of relationship records matching the filters.","operationId":"retrieve_get_relationships_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"relationship_types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relationship Types"}},{"name":"from_node_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Node Labels"}},{"name":"to_node_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Node Labels"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}},{"name":"query_search_target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Query Search Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entities":{"get":{"tags":["retrieve"],"summary":"Get Entities","description":"Retrieve entities matching optional label and text filters with pagination.\n\nParameters:\n    node_labels (Optional[str]): Comma-separated node labels to filter by (e.g. \"Person,Company\"); when provided, only entities with any of these labels are returned.\n    query_text (Optional[str]): Free-text filter to match entity properties or content.\n    brain_id (str): Identifier of the brain/knowledge store to query.\n\nReturns:\n    list: A list of entity records that match the provided filters and pagination parameters.","operationId":"retrieve_get_entities_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"node_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Labels"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/structured-data/types":{"get":{"tags":["retrieve"],"summary":"Get Structured Data Types","description":"Get all unique types from structured data.","operationId":"retrieve_get_structured_data_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/structured-data/{id}":{"get":{"tags":["retrieve"],"summary":"Get Structured Data By Id","description":"Get structured data by ID.","operationId":"retrieve_get_structured_data_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredDataItemResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/structured-data":{"get":{"tags":["retrieve"],"summary":"Get Structured Data List","description":"Get a list of structured data.","operationId":"retrieve_get_structured_data_list_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Types"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredDataListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/text-chunks":{"get":{"tags":["retrieve"],"summary":"Get Text Chunks","description":"Get text chunks by a query text and optional metadata equality filters.","operationId":"retrieve_get_text_chunks_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}},{"name":"metadata_eq","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metadata Eq"}},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"desc","title":"Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextChunkListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/observations/labels":{"get":{"tags":["retrieve"],"summary":"Get Observation Labels","description":"Get all unique labels from observations.","operationId":"retrieve_get_observation_labels_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/observations/{id}":{"get":{"tags":["retrieve"],"summary":"Get Observation By Id","description":"Get observation by ID.","operationId":"retrieve_get_observation_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationItemResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/observations":{"get":{"tags":["retrieve"],"summary":"Get Observations List","description":"Retrieve a list of observations filtered by the provided parameters.\n\nParameters:\n    limit (int): Maximum number of observations to return.\n    skip (int): Number of observations to skip (offset).\n    resource_id (Optional[str]): If provided, only return observations for this resource identifier.\n    labels (Optional[str]): Comma-separated observation labels to filter by; when provided, labels are treated as a list of strings.\n    query_text (Optional[str]): Full-text query to filter observations.\n    brain_id (str): Identifier of the brain/tenant to query.\n\nReturns:\n    list: A list of observation records that match the provided filters.","operationId":"retrieve_get_observations_list_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"resource_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"}},{"name":"labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Labels"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/changelogs/types":{"get":{"tags":["retrieve"],"summary":"Get Changelog Types","description":"Retrieve all unique changelog types for the specified brain.\n\nParameters:\n    brain_id (str): Identifier of the brain to query; defaults to \"default\".\n\nReturns:\n    list[str]: List of unique changelog type names.","operationId":"retrieve_get_changelog_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/changelogs/{id}":{"get":{"tags":["retrieve"],"summary":"Get Changelog By Id","description":"Retrieve a changelog entry by its unique identifier.\n\nParameters:\n    id (str): Unique identifier of the changelog entry.\n    brain_id (str): Brain identifier to query. Defaults to \"default\".\n\nReturns:\n    The changelog entry corresponding to the specified identifier.","operationId":"retrieve_get_changelog_by_id_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangelogItemResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/changelogs":{"get":{"tags":["retrieve"],"summary":"Get Changelogs List","description":"Retrieve a paginated list of changelogs.\n\nParameters:\n    types (Optional[str]): Optional comma-separated changelog types to filter by; each type will be applied as a filter.\n    query_text (Optional[str]): Optional text used to filter changelogs by content or metadata.\n\nReturns:\n    list: Changelog records matching the provided filters, constrained by `limit` and `skip`.","operationId":"retrieve_get_changelogs_list_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Types"}},{"name":"query_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Text"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangelogListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/hops":{"get":{"tags":["retrieve"],"summary":"Get Hops","description":"Compute graph hops for the given query.\n\nParameters:\n    query (str): Search text or entity identifier to start hop traversal from.\n    degrees (int): Maximum number of hop degrees to traverse (default 2).\n    flattened (bool): If True, return a flattened list of hops; otherwise preserve nested hop structure.\n    brain_id (str): Identifier of the brain (knowledge graph) to query.\n\nReturns:\n    list: Hops (paths) connecting matching entities up to the specified degree; the exact structure varies based on `flattened`.","operationId":"retrieve_get_hops_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"degrees","in":"query","required":false,"schema":{"const":2,"type":"integer","default":2,"title":"Degrees"}},{"name":"flattened","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Flattened"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HopListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entity/info":{"get":{"tags":["retrieve"],"summary":"Get Entity Info","description":"Retrieve detailed information for an entity identified by the given target and query.\n\nParameters:\n    target (str): Identifier or name of the target entity to retrieve.\n    query (str): Query text used to refine or disambiguate the requested entity information.\n    max_depth (int): Maximum graph depth to traverse when collecting related information.\n    brain_id (str): Identifier of the brain/namespace to query.\n\nReturns:\n    dict: A mapping containing the entity's attributes and related contextual information.","operationId":"retrieve_get_entity_info_get","parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"max_depth","in":"query","required":false,"schema":{"type":"integer","default":3,"title":"Max Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntityInfoResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entity/context":{"get":{"tags":["retrieve"],"summary":"Get Entity Context","description":"Retrieve contextual information for an entity identified by `target`.\n\nParameters:\n    target (str): Identifier or name of the target entity.\n    context_depth (int): Maximum depth of related context to include.\n    brain_id (str): Identifier of the brain/knowledge graph to query.\n\nReturns:\n    dict: A mapping containing the entity's contextual information.","operationId":"retrieve_get_entity_context_get","parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"context_depth","in":"query","required":false,"schema":{"type":"integer","default":3,"title":"Context Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntityContextResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entity/synergies":{"get":{"tags":["retrieve"],"summary":"Get Entity Synergies","description":"Retrieve synergies for a specified entity.\n\nParameters:\n    target: Identifier or name of the target entity.\n    polarity: \"same\" for matching node polarity; \"opposite\" for positive↔negative.\n    do: If True, only direct synergies are returned.\n    pa: If True, potential anchors are returned.\n    ppa: If True, seed anchors are returned.\n    top_k: Maximum synergies to return (default 50).\n    labels: Optional candidate label filter.\n    brain_id: Identifier of the knowledge brain to query.\n\nReturns:\n    Synergy records for the target entity matching the requested polarity.","operationId":"retrieve_get_entity_synergies_get","parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"polarity","in":"query","required":false,"schema":{"enum":["same","opposite"],"type":"string","default":"same","title":"Polarity"}},{"name":"do","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Do"}},{"name":"pa","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Pa"}},{"name":"ppa","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Ppa"}},{"name":"top_k","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Top K"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Labels"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitySibilingsResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/recommend":{"get":{"tags":["retrieve"],"summary":"Recommend entities (Preview)","description":"Preview: ranked event-graph recommendations composing synergies, asymmetric\ncomplementary walks, multi-interest medoids, and optional attribute\npreferences (retrieval-time only; no training).","operationId":"retrieve_get_recommend_get","parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"polarity","in":"query","required":false,"schema":{"enum":["same","opposite"],"type":"string","default":"same","title":"Polarity"}},{"name":"top_k","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Top K"}},{"name":"include_asymmetric","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Asymmetric"}},{"name":"include_multi_interest","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Multi Interest"}},{"name":"include_attribute_pref","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Attribute Pref"}},{"name":"diversify","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Diversify"}},{"name":"asymmetric_direction","in":"query","required":false,"schema":{"enum":["outbound","inbound","both"],"type":"string","default":"outbound","title":"Asymmetric Direction"}},{"name":"exclude_seen","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Exclude Seen"}},{"name":"recency_half_life_days","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Recency Half Life Days"}},{"name":"dampen_degree","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Dampen Degree"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Labels"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-stability":"preview","security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["retrieve"],"summary":"Recommend entities from a request body (Preview)","description":"Preview recommendation surface; request and response compatibility is kept.","operationId":"retrieve_post_recommend_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-stability":"preview","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/search":{"get":{"tags":["retrieve"],"summary":"Get Search","operationId":"retrieve_get_search_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"The search query.","title":"Query"},"description":"The search query."},{"name":"k","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of hits to return.","default":10,"title":"K"},"description":"Number of hits to return."},{"name":"channels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated channels: passages, entities, events, communities, and/or plugin:<name>.","default":"passages","title":"Channels"},"description":"Comma-separated channels: passages, entities, events, communities, and/or plugin:<name>."},{"name":"node_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated node labels to filter the entities channel.","title":"Node Labels"},"description":"Comma-separated node labels to filter the entities channel."},{"name":"community_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated hub labels for the communities channel.","title":"Community Labels"},"description":"Comma-separated hub labels for the communities channel."},{"name":"expand","in":"query","required":false,"schema":{"enum":["none","neighbors"],"type":"string","description":"Optional 1-hop expansion from graph channel seeds.","default":"none","title":"Expand"},"description":"Optional 1-hop expansion from graph channel seeds."},{"name":"fusion","in":"query","required":false,"schema":{"anyOf":[{"enum":["rrf","cc"],"type":"string"},{"type":"null"}],"description":"Fusion override. Default is SEARCH_FUSION.","title":"Fusion"},"description":"Fusion override. Default is SEARCH_FUSION."},{"name":"rerank","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"none or plugin:<name>. Unknown plugin names return 400.","title":"Rerank"},"description":"none or plugin:<name>. Unknown plugin names return 400."},{"name":"target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional USER uuid or id for query-gated rerank of retrieved hits.","title":"Target"},"description":"Optional USER uuid or id for query-gated rerank of retrieved hits."},{"name":"profile_stages","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Profile Stages"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get Search. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["retrieve"],"summary":"Post Search","operationId":"retrieve_post_search_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Post Search. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/entity/status":{"get":{"tags":["retrieve"],"summary":"Get Entity Status","description":"Retrieve status information for a specified entity.\n\nParameters:\n    target (str): Identifier or name of the entity to inspect.\n    types (Optional[List[str]]): Optional list of entity types to filter the status computation.\n    brain_id (str): Identifier of the brain (knowledge graph) to query.\n\nReturns:\n    status (dict): A dictionary containing the entity's status details.","operationId":"retrieve_get_entity_status_get","parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Types"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntityStatusResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/vectors/stores":{"get":{"tags":["retrieve"],"summary":"Get Vector Stores","description":"List available vector store names and dimensions.","operationId":"retrieve_get_vector_stores_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/retrieve/vectors/{store}":{"get":{"tags":["retrieve"],"summary":"Get Vectors List","description":"List vectors in a store with pagination.","operationId":"retrieve_get_vectors_list_get","parameters":[{"name":"store","in":"path","required":true,"schema":{"type":"string","title":"Store"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"include_embeddings","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Embeddings"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorListResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/meta/login-info":{"get":{"tags":["meta"],"summary":"Get Login Info","description":"Resolve whether a BrainPAT is the system token or scoped to a single brain.","operationId":"meta_get_login_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginInfoResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":true,"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/meta/relationships-properties":{"get":{"tags":["meta"],"summary":"Get Relationships Properties","description":"Retrieve all unique relationship types present in the graph for the specified brain.\n\nParameters:\n    brain_id (str): Identifier of the brain/graph to query. Defaults to \"default\".\n\nReturns:\n    A list of relationship type names (strings) found in the specified graph.","operationId":"meta_get_relationships_properties_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/meta/entity-labels":{"get":{"tags":["meta"],"summary":"Get Entities Labels","description":"Retrieve all unique node labels present in the graph.\n\nParameters:\n    brain_id (str): Identifier of the brain/graph to query. Defaults to \"default\".\n\nReturns:\n    labels (list[str]): List of unique node label names.","operationId":"meta_get_entities_labels_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/meta/entity-properties":{"get":{"tags":["meta"],"summary":"Get Entity Properties","description":"Retrieve all unique property keys used by entities in the specified brain/graph.\n\nParameters:\n    brain_id (str): Identifier of the brain/graph to query; defaults to \"default\".\n\nReturns:\n    list[str]: A list of property key names present on entities in the graph.","operationId":"meta_get_entity_properties_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/model/entity":{"put":{"tags":["model"],"summary":"Update Entity","description":"Update an entity (node) in the graph.\n\n@returns The controller's response containing the updated node representation or an operation result.","operationId":"model_update_entity_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntityRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}],"title":"Response Model Update Entity Put"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["model"],"summary":"Add Entity","description":"Create a new entity (node) in the knowledge graph.\n\nReturns:\n    Response payload containing details of the created node.","operationId":"model_add_entity_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEntityRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},{"type":"string"}],"title":"Response Model Add Entity Post"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/model/relationship":{"put":{"tags":["model"],"summary":"Update Relationship","description":"Update properties of an existing relationship.\n\nUses the following fields from `request`: `uuid`, `brain_id`, `new_properties` (defaults to an empty dict if missing), and `properties_to_remove` (defaults to an empty list if missing).\n\nReturns:\n    The updated relationship representation or a result object describing the outcome of the update.","operationId":"model_update_relationship_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRelationshipRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Predicate"},{"type":"null"}],"title":"Response Model Update Relationship Put"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["model"],"summary":"Add Relationship","description":"Create a relationship linking two nodes in the graph.\n\nReturns:\n    relationship (dict): Representation of the created relationship.","operationId":"model_add_relationship_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRelationshipRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Model Add Relationship Post"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/brains-list":{"get":{"tags":["system"],"summary":"Get Brains List","description":"Get the list of brains.","operationId":"system_get_brains_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Brain"},"type":"array","title":"Response System Get Brains List Get"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/brains":{"post":{"tags":["system"],"summary":"Create Brain","description":"Create a new brain","operationId":"system_create_brain_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBrainRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brain"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/brains/{brain_id}/clear":{"post":{"tags":["system"],"summary":"Clear Brain","description":"Clear all data for a brain while preserving its identity and PAT.","operationId":"system_clear_brain_post","parameters":[{"name":"brain_id","in":"path","required":true,"schema":{"type":"string","title":"Brain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrainLifecycleResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/brains/{brain_id}":{"delete":{"tags":["system"],"summary":"Delete Brain","description":"Delete a brain's data, registry identity, PAT, and cached credentials.","operationId":"system_delete_brain_delete","parameters":[{"name":"brain_id","in":"path","required":true,"schema":{"type":"string","title":"Brain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrainLifecycleResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/backup/status":{"get":{"tags":["system"],"summary":"Backup Status","operationId":"system_backup_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Backup Status. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/backup/quiesce":{"post":{"tags":["system"],"summary":"Backup Quiesce","operationId":"system_backup_quiesce_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Backup Quiesce. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/backup/checkpoint":{"post":{"tags":["system"],"summary":"Backup Checkpoint","operationId":"system_backup_checkpoint_post","parameters":[{"name":"timeout_seconds","in":"query","required":false,"schema":{"type":"integer","maximum":300,"minimum":1,"default":120,"title":"Timeout Seconds"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Backup Checkpoint. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/backup/resume":{"post":{"tags":["system"],"summary":"Backup Resume","operationId":"system_backup_resume_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Backup Resume. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/tasks/":{"get":{"tags":["tasks"],"summary":"Get Tasks","operationId":"tasks_get_tasks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get Tasks. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/tasks/{task_id}":{"get":{"tags":["tasks"],"summary":"Get Task","description":"Get the result of a task by its ID.","operationId":"tasks_get_task_get","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStateResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/health":{"get":{"tags":["public"],"summary":"Health","description":"Return public liveness metadata without accessing customer data.","operationId":"public_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[]}},"/demo/search":{"get":{"tags":["public"],"summary":"Demo Search","description":"Search the fixed public demo brain using passages-only BM25 retrieval.\n\nThis endpoint never accepts a caller-selected brain and exposes no write path.\nProduction applies an additional per-client rate limit at the edge.","operationId":"public_demo_search_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"description":"Search query over the public BrainAPI documentation corpus.","title":"Query"},"description":"Search query over the public BrainAPI documentation corpus."},{"name":"k","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"description":"Number of public documentation passages to return (maximum 10).","default":10,"title":"K"},"description":"Number of public documentation passages to return (maximum 10)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"404":{"description":"Public demo is disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Demo search is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Public demo rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[],"x-rate-limit":{"requests":30,"window":"60 seconds"}}},"/system/workspaces":{"get":{"tags":["workspaces"],"summary":"List Workspaces","operationId":"workspaces_list_workspaces_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Workspaces List Workspaces Get"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"List Workspaces. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"post":{"tags":["workspaces"],"summary":"Create Workspace","operationId":"workspaces_create_workspace_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Create Workspace. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/workspaces/{slug}":{"get":{"tags":["workspaces"],"summary":"Get Workspace","operationId":"workspaces_get_workspace_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get Workspace. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]},"patch":{"tags":["workspaces"],"summary":"Update Workspace","operationId":"workspaces_update_workspace_patch","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Update Workspace. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/system/workspaces/{slug}/endpoint":{"get":{"tags":["workspaces"],"summary":"Get Workspace Endpoint","operationId":"workspaces_get_workspace_endpoint_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get Workspace Endpoint. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/brains/{workspace_slug}/agent/search":{"post":{"tags":["agent-memory"],"summary":"Agent Search","operationId":"agent_memory_agent_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Agent Search. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/brains/{workspace_slug}/agent/context":{"post":{"tags":["agent-memory"],"summary":"Agent Context","operationId":"agent_memory_agent_context_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentContextRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Agent Context. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/brains/{workspace_slug}/agent/memory":{"post":{"tags":["agent-memory"],"summary":"Agent Memory","operationId":"agent_memory_agent_memory_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentMemoryRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Agent Memory. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/brains/{workspace_slug}/agent/tasks/{task_id}":{"get":{"tags":["agent-memory"],"summary":"Agent Task","operationId":"agent_memory_agent_task_get","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Agent Task. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}},"/brains/{workspace_slug}/agent/capabilities":{"get":{"tags":["agent-memory"],"summary":"Agent Capabilities","operationId":"agent_memory_agent_capabilities_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericObjectResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Operation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Brain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Dependency unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Agent Capabilities. See the BrainAPI developer documentation for request, response, authentication, and retry semantics.","security":[{"BrainPAT":[]},{"BearerAuth":[]}]}}},"components":{"schemas":{"AccessTokenListResponse":{"properties":{"tokens":{"items":{"$ref":"#/components/schemas/AccessTokenMetadataResponse"},"type":"array","title":"Tokens"}},"type":"object","required":["tokens"],"title":"AccessTokenListResponse"},"AccessTokenMetadataResponse":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"brain_id":{"type":"string","title":"Brain Id"},"token_prefix":{"type":"string","title":"Token Prefix"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"legacy":{"type":"boolean","title":"Legacy"},"created_by":{"type":"string","title":"Created By"}},"type":"object","required":["id","label","brain_id","token_prefix","permissions","created_at","last_used_at","expires_at","revoked_at","legacy","created_by"],"title":"AccessTokenMetadataResponse"},"AddEntityRequest":{"properties":{"name":{"type":"string","title":"Name"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties"},"identification_params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Identification Params"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["name"],"title":"AddEntityRequest","description":"Request model for adding a new entity to the graph."},"AddRelationshipRequest":{"properties":{"subject_uuid":{"type":"string","title":"Subject Uuid"},"predicate_name":{"type":"string","title":"Predicate Name"},"predicate_description":{"type":"string","title":"Predicate Description"},"object_uuid":{"type":"string","title":"Object Uuid"},"brain_id":{"type":"string","title":"Brain Id","default":"default"}},"type":"object","required":["subject_uuid","predicate_name","predicate_description","object_uuid"],"title":"AddRelationshipRequest","description":"Request model for adding a new relationship between two entities."},"AgentContextRequest":{"properties":{"query":{"type":"string","minLength":1,"title":"Query"},"max_tokens":{"type":"integer","maximum":32000.0,"minimum":100.0,"title":"Max Tokens","default":4000}},"additionalProperties":false,"type":"object","required":["query"],"title":"AgentContextRequest"},"AgentMemoryRequest":{"properties":{"text":{"type":"string","minLength":1,"title":"Text"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"additionalProperties":false,"type":"object","required":["text"],"title":"AgentMemoryRequest"},"AgentSearchRequest":{"properties":{"query":{"type":"string","minLength":1,"title":"Query"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","default":10}},"additionalProperties":false,"type":"object","required":["query"],"title":"AgentSearchRequest"},"Body_ingest_ingest_file_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_ingest_ingest_file_post"},"Brain":{"properties":{"id":{"type":"string","title":"Id"},"name_key":{"type":"string","title":"Name Key","description":"The key used to identify the brain."}},"type":"object","required":["name_key"],"title":"Brain","description":"Model for a single brain, stored into data db"},"BrainLifecycleResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"brain_id":{"type":"string","title":"Brain Id"},"operation":{"type":"string","enum":["clear","delete"],"title":"Operation"},"existed":{"type":"boolean","title":"Existed"},"cleared_backends":{"items":{"type":"string"},"type":"array","title":"Cleared Backends"}},"type":"object","required":["success","brain_id","operation","existed","cleared_backends"],"title":"BrainLifecycleResponse"},"ChangelogItemResponse":{"properties":{"message":{"type":"string","title":"Message"},"changelog":{"$ref":"#/components/schemas/KGChanges"}},"type":"object","required":["message","changelog"],"title":"ChangelogItemResponse"},"ChangelogListResponse":{"properties":{"message":{"type":"string","title":"Message"},"changelogs":{"items":{"$ref":"#/components/schemas/KGChanges"},"type":"array","title":"Changelogs"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["message","changelogs","count"],"title":"ChangelogListResponse"},"CreateBrainRequest":{"properties":{"brain_id":{"type":"string","title":"Brain Id"}},"type":"object","required":["brain_id"],"title":"CreateBrainRequest","description":"Request body for the create brain endpoint."},"CreateWorkspaceRequest":{"properties":{"slug":{"type":"string","title":"Slug"},"display_name":{"type":"string","maxLength":200,"minLength":1,"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["slug","display_name"],"title":"CreateWorkspaceRequest"},"EntityListResponse":{"properties":{"message":{"type":"string","title":"Message"},"entities":{"items":{"$ref":"#/components/schemas/Node"},"type":"array","title":"Entities"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["message","entities","total"],"title":"EntityListResponse"},"EntitySynergy":{"properties":{"node":{"$ref":"#/components/schemas/Node"},"connected_by":{"items":{"$ref":"#/components/schemas/Node"},"type":"array","title":"Connected By"},"association_score":{"type":"number","title":"Association Score"}},"type":"object","required":["node","connected_by","association_score"],"title":"EntitySynergy","description":"Entity synergy model."},"ErrorInfo":{"properties":{"code":{"type":"string","title":"Code","description":"Stable error code for programmatic handling."},"message":{"type":"string","title":"Message","description":"Short human-readable error summary."},"resolution":{"type":"string","title":"Resolution","description":"Concrete guidance for resolving the error."},"request_id":{"type":"string","title":"Request Id","description":"Identifier shared with the X-Request-ID header."}},"type":"object","required":["code","message","resolution","request_id"],"title":"ErrorInfo","description":"Stable machine-readable information attached to every API error."},"ErrorResponse":{"properties":{"detail":{"$ref":"#/components/schemas/JsonValue","description":"Original FastAPI error detail value."},"error":{"$ref":"#/components/schemas/ErrorInfo"}},"type":"object","required":["detail","error"],"title":"ErrorResponse","description":"Additive error envelope that preserves FastAPI's legacy detail field."},"FlatHopNode":{"properties":{"uuid":{"type":"string","title":"Uuid"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels"},"name":{"type":"string","title":"Name"}},"type":"object","required":["uuid","labels","name"],"title":"FlatHopNode"},"FlatHopPredicate":{"properties":{"uuid":{"type":"string","title":"Uuid"},"name":{"type":"string","title":"Name"},"direction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Direction"}},"type":"object","required":["uuid","name"],"title":"FlatHopPredicate"},"GetContextRequestBody":{"properties":{"text":{"type":"string","title":"Text"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"historical_limit":{"type":"integer","title":"Historical Limit","default":10},"max_facts":{"type":"integer","minimum":0.0,"title":"Max Facts","default":40},"max_passages":{"type":"integer","title":"Max Passages","default":8},"apply_fact_filter":{"type":"boolean","title":"Apply Fact Filter","default":true},"use_ppr":{"type":"boolean","title":"Use Ppr","default":true},"sufficiency_retry":{"type":"boolean","title":"Sufficiency Retry","default":false},"profile_stages":{"type":"boolean","title":"Profile Stages","default":false},"cross_event_bridges":{"type":"integer","minimum":0.0,"title":"Cross Event Bridges","default":3}},"type":"object","required":["text"],"title":"GetContextRequestBody","description":"Request body for the get context endpoint."},"GetContextResponse":{"properties":{"text_context":{"type":"string","title":"Text Context"},"triples":{"items":{"$ref":"#/components/schemas/GetContextTriple"},"type":"array","title":"Triples"},"historical_context":{"items":{"type":"string"},"type":"array","title":"Historical Context","default":[]},"source_passages":{"items":{"type":"string"},"type":"array","title":"Source Passages","default":[]},"graph_session_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Graph Session Ids"},"temporal_conflicts":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Temporal Conflicts"},"paths":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Paths"},"topics":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Topics"},"stage_timings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Stage Timings"}},"type":"object","required":["text_context","triples"],"title":"GetContextResponse","description":"Response for the get context endpoint."},"GetContextTriple":{"properties":{"identified_entity":{"type":"string","title":"Identified Entity"},"triple":{"prefixItems":[{"$ref":"#/components/schemas/Node"},{"$ref":"#/components/schemas/Predicate"},{"$ref":"#/components/schemas/Node"},{"$ref":"#/components/schemas/Predicate"},{"$ref":"#/components/schemas/Node"}],"type":"array","maxItems":5,"minItems":5,"title":"Triple"},"source_chunk_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Source Chunk Ids"},"source_session_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Source Session Ids"}},"type":"object","required":["identified_entity","triple"],"title":"GetContextTriple","description":"Triple for the get context endpoint."},"GetEntityContextResponse":{"properties":{"neighborhood":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Neighborhood"},"target_node":{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}]},"text_contexts":{"items":{"type":"string"},"type":"array","title":"Text Contexts","default":[]},"natural_language_web":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Natural Language Web","default":[]}},"type":"object","required":["neighborhood"],"title":"GetEntityContextResponse","description":"Response model for the get entity context endpoint."},"GetEntityInfoResponse":{"properties":{"target_node":{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}]},"path":{"$ref":"#/components/schemas/MatchPath"}},"type":"object","required":["path"],"title":"GetEntityInfoResponse","description":"Response model for the get entity info endpoint."},"GetEntitySibilingsResponse":{"properties":{"target_node":{"$ref":"#/components/schemas/Node"},"synergies":{"items":{"$ref":"#/components/schemas/EntitySynergy"},"type":"array","title":"Synergies"},"anchors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},{"type":"null"}],"title":"Anchors"},"potential_anchors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},{"type":"null"}],"title":"Potential Anchors"}},"type":"object","required":["target_node","synergies"],"title":"GetEntitySibilingsResponse","description":"Response model for the get entity siblings endpoint."},"GetEntityStatusResponse":{"properties":{"node":{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}]},"exists":{"type":"boolean","title":"Exists"},"has_relationships":{"type":"boolean","title":"Has Relationships"},"relationships":{"items":{"prefixItems":[{"$ref":"#/components/schemas/Predicate"},{"$ref":"#/components/schemas/Node"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Relationships"},"observations":{"items":{"$ref":"#/components/schemas/Observation"},"type":"array","title":"Observations"}},"type":"object","required":["exists","has_relationships","relationships","observations"],"title":"GetEntityStatusResponse","description":"Response model for the get entity status endpoint."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Service health status."},"service":{"type":"string","title":"Service","description":"Service name."},"version":{"type":"string","title":"Version","description":"Running BrainAPI version."},"backup":{"additionalProperties":true,"type":"object","title":"Backup","description":"Non-secret remote checkpoint state."},"persistence":{"additionalProperties":true,"type":"object","title":"Persistence","description":"Non-secret durability and release status."},"storage":{"additionalProperties":true,"type":"object","title":"Storage","description":"Local storage and explicit checkpoint RPO policy."},"checks":{"additionalProperties":true,"type":"object","title":"Checks","description":"Safe dependency readiness results."},"maintenance":{"additionalProperties":true,"type":"object","title":"Maintenance","description":"Write admission and maintenance hold state."},"restored_checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Restored Checkpoint"},"remote_checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Checkpoint"},"checkpoint_lag":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Checkpoint Lag"},"backup_dirty":{"type":"boolean","title":"Backup Dirty","default":false},"backup_last_success":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Backup Last Success"},"backup_age_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Backup Age Seconds"},"content_durable":{"type":"boolean","title":"Content Durable","default":false},"zero_loss_durable":{"type":"boolean","title":"Zero Loss Durable","default":false},"rpo_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rpo Seconds"}},"type":"object","required":["status","service","version"],"title":"HealthResponse"},"HopListResponse":{"items":{"prefixItems":[{"anyOf":[{"$ref":"#/components/schemas/Node"},{"$ref":"#/components/schemas/FlatHopNode"}]},{"items":{"prefixItems":[{"anyOf":[{"$ref":"#/components/schemas/Predicate"},{"$ref":"#/components/schemas/FlatHopPredicate"}]},{"anyOf":[{"$ref":"#/components/schemas/Node"},{"$ref":"#/components/schemas/FlatHopNode"}]},{"items":{"prefixItems":[{"anyOf":[{"$ref":"#/components/schemas/Predicate"},{"$ref":"#/components/schemas/FlatHopPredicate"}]},{"anyOf":[{"$ref":"#/components/schemas/Node"},{"$ref":"#/components/schemas/FlatHopNode"}]}],"type":"array","maxItems":2,"minItems":2},"type":"array"}],"type":"array","maxItems":3,"minItems":3},"type":"array"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"HopListResponse"},"IdentificationParams":{"properties":{"name":{"type":"string","title":"Name"},"entity_types":{"items":{"type":"string"},"type":"array","title":"Entity Types","description":"The types of the entity to identify.","default":[]}},"additionalProperties":true,"type":"object","required":["name"],"title":"IdentificationParams","description":"Identification params model.\nMust have a name property.\nThan can contain other properties."},"IngestionAcceptedResponse":{"properties":{"message":{"type":"string","title":"Message"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["message","task_id"],"title":"IngestionAcceptedResponse"},"IngestionRequestBody":{"properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/IngestionTaskJsonArgs"},{"$ref":"#/components/schemas/IngestionTaskTextArgs"}],"title":"Data","discriminator":{"propertyName":"data_type","mapping":{"json":"#/components/schemas/IngestionTaskJsonArgs","text":"#/components/schemas/IngestionTaskTextArgs"}}},"meta_keys":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta Keys","description":"The shared keys that should not be treated as nodes. (eg: email because each person has an email). The keys specified here will not be analyzed but just added to the metadata."},"identification_params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Identification Params","description":"The parameters used to identify the data."},"observate_for":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Observate For","description":"What to look for and describe in the data during observation. If not provided, the observations will be generic","default":[]},"preferred_extraction_entities":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Preferred Extraction Entities","description":"The entities that are preferred to be extracted from the data. If not provided, the extraction will be done on all the entities in the data.","default":[]},"brain_id":{"type":"string","title":"Brain Id","description":"The brain identifier to store the data in.","default":"default"},"source_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Timestamp","description":"Reference timestamp for the source content (e.g. session date). Used to resolve relative dates like 'yesterday' into absolute dates."},"skip_enrichment":{"type":"boolean","title":"Skip Enrichment","description":"Persist the text chunk and embedding only. Skip observations and knowledge-graph enrichment (Scout/Architect).","default":false}},"type":"object","required":["data"],"title":"IngestionRequestBody","description":"Request body for the ingestion endpoint."},"IngestionStructuredRequestBody":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IngestionTripleSet"},"type":"array","title":"Data","description":"The list of event-centric information triples to ingest."},"anchor":{"anyOf":[{"$ref":"#/components/schemas/PartialNodeFilter"},{"type":"null"}],"description":"The related information to connect the structured data to."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"Additional text context for the structured data."},"mode":{"anyOf":[{"type":"string","enum":["deterministic","hybrid","enrich"]},{"type":"null"}],"title":"Mode","description":"Ingest mode. deterministic: no LLM (triples only; UUID anchor or exact name+type match). hybrid: persist submitted triples then optionally enrich from text. enrich: same as hybrid with LLM backfill. When omitted, inferred as hybrid if text is set else deterministic."},"brain_id":{"type":"string","title":"Brain Id","description":"The brain identifier to store the data in.","default":"default"}},"type":"object","required":["data"],"title":"IngestionStructuredRequestBody","description":"Request body for the structured ingestion endpoint."},"IngestionTaskJsonArgs":{"properties":{"data_type":{"type":"string","const":"json","title":"Data Type","default":"json"},"json_data":{"additionalProperties":true,"type":"object","title":"Json Data"}},"type":"object","required":["json_data"],"title":"IngestionTaskJsonArgs","description":"Arguments for the ingestion task when the data type is JSON."},"IngestionTaskTextArgs":{"properties":{"data_type":{"type":"string","const":"text","title":"Data Type","default":"text"},"text_data":{"type":"string","title":"Text Data"}},"type":"object","required":["text_data"],"title":"IngestionTaskTextArgs","description":"Arguments for the ingestion task when the data type is TEXT."},"IngestionTripleSet":{"properties":{"subject":{"anyOf":[{"$ref":"#/components/schemas/RequestPartialNode"},{"type":"null"}],"description":"The optional actor of the triple."},"subj_event":{"anyOf":[{"$ref":"#/components/schemas/RequestPartialPredicate"},{"type":"null"}],"description":"The optional event predicate of the triple."},"event":{"anyOf":[{"$ref":"#/components/schemas/RequestPartialNode"},{"type":"null"}],"description":"The optional event node. Omit for a direct subject-predicate-object edge."},"event_obj":{"anyOf":[{"$ref":"#/components/schemas/RequestPartialPredicate"},{"type":"null"}],"description":"The optional event-to-object predicate. Paired with event when present."},"object":{"$ref":"#/components/schemas/RequestPartialNode"}},"type":"object","required":["object"],"title":"IngestionTripleSet"},"IssuedAccessTokenResponse":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"brain_id":{"type":"string","title":"Brain Id"},"token_prefix":{"type":"string","title":"Token Prefix"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"legacy":{"type":"boolean","title":"Legacy"},"created_by":{"type":"string","title":"Created By"},"token":{"type":"string","title":"Token","description":"Shown exactly once at creation. Store securely; listing never reveals this value."}},"type":"object","required":["id","label","brain_id","token_prefix","permissions","created_at","last_used_at","expires_at","revoked_at","legacy","created_by","token"],"title":"IssuedAccessTokenResponse"},"JsonValue":{},"KGChangeLogNodePropertiesUpdated":{"properties":{"type":{"type":"string","const":"node_properties_updated","title":"Type","description":"The type of the change.","default":"node_properties_updated"},"node":{"$ref":"#/components/schemas/PartialNode","description":"The node that was updated."},"properties":{"items":{"$ref":"#/components/schemas/KGChangeLogPredicateUpdatedProperty"},"type":"array","title":"Properties","description":"The properties that were updated."}},"type":"object","required":["node","properties"],"title":"KGChangeLogNodePropertiesUpdated","description":"KG change log node properties updated model."},"KGChangeLogPredicatePropertiesUpdated":{"properties":{"type":{"type":"string","const":"relationship_properties_updated","title":"Type","description":"The type of the change.","default":"relationship_properties_updated"},"predicate":{"$ref":"#/components/schemas/PartialPredicate","description":"The predicate that was updated."},"properties":{"items":{"$ref":"#/components/schemas/KGChangeLogPredicateUpdatedProperty"},"type":"array","title":"Properties","description":"The properties that were updated."}},"type":"object","required":["predicate","properties"],"title":"KGChangeLogPredicatePropertiesUpdated","description":"KG change log relationship properties updated model."},"KGChangeLogPredicateUpdatedProperty":{"properties":{"property":{"type":"string","title":"Property","description":"The property that was updated."},"previous_value":{"title":"Previous Value","description":"The previous value of the property."},"new_value":{"title":"New Value","description":"The new value of the property."}},"type":"object","required":["property","previous_value","new_value"],"title":"KGChangeLogPredicateUpdatedProperty","description":"KG change log relationship updated property model."},"KGChangeLogRelationshipCreated":{"properties":{"type":{"type":"string","const":"relationship_created","title":"Type","description":"The type of the change.","default":"relationship_created"},"subject":{"$ref":"#/components/schemas/PartialNode","description":"The subject of the relationship."},"predicate":{"$ref":"#/components/schemas/PartialPredicate","description":"The predicate of the relationship."},"object":{"$ref":"#/components/schemas/PartialNode","description":"The object of the relationship."}},"type":"object","required":["subject","predicate","object"],"title":"KGChangeLogRelationshipCreated","description":"KG change log relationship created model."},"KGChangeLogRelationshipDeprecated":{"properties":{"type":{"type":"string","const":"relationship_deprecated","title":"Type","description":"The type of the change.","default":"relationship_deprecated"},"subject":{"$ref":"#/components/schemas/PartialNode","description":"The subject of the relationship."},"predicate":{"$ref":"#/components/schemas/PartialPredicate","description":"The predicate of the relationship."},"object":{"$ref":"#/components/schemas/PartialNode","description":"The object of the relationship."},"new_predicate":{"anyOf":[{"$ref":"#/components/schemas/PartialPredicate"},{"type":"null"}],"description":"The new predicate of the relationship."}},"type":"object","required":["subject","predicate","object","new_predicate"],"title":"KGChangeLogRelationshipDeprecated","description":"KG change log relationship deprecated model."},"KGChanges":{"properties":{"id":{"type":"string","title":"Id"},"type":{"$ref":"#/components/schemas/KGChangesType","description":"The type of the changes."},"change":{"oneOf":[{"$ref":"#/components/schemas/KGChangeLogRelationshipCreated"},{"$ref":"#/components/schemas/KGChangeLogRelationshipDeprecated"},{"$ref":"#/components/schemas/KGChangeLogNodePropertiesUpdated"},{"$ref":"#/components/schemas/KGChangeLogPredicatePropertiesUpdated"}],"title":"Change","description":"The change data, discriminated by type.","discriminator":{"propertyName":"type","mapping":{"node_properties_updated":"#/components/schemas/KGChangeLogNodePropertiesUpdated","relationship_created":"#/components/schemas/KGChangeLogRelationshipCreated","relationship_deprecated":"#/components/schemas/KGChangeLogRelationshipDeprecated","relationship_properties_updated":"#/components/schemas/KGChangeLogPredicatePropertiesUpdated"}}},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp of the changes."}},"type":"object","required":["type","change"],"title":"KGChanges","description":"KG changes model."},"KGChangesType":{"type":"string","enum":["relationship_created","relationship_deprecated","node_properties_updated","relationship_properties_updated"],"title":"KGChangesType","description":"KG changes type."},"LabelListResponse":{"properties":{"message":{"type":"string","title":"Message"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["message","labels","count"],"title":"LabelListResponse"},"LoginInfoResponse":{"properties":{"is_system_pat":{"type":"boolean","title":"Is System Pat"},"brain_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brain Id"}},"type":"object","required":["is_system_pat","brain_id"],"title":"LoginInfoResponse"},"LogoutResponse":{"properties":{"authenticated":{"type":"boolean","const":false,"title":"Authenticated"}},"type":"object","required":["authenticated"],"title":"LogoutResponse"},"MaintenanceResponse":{"properties":{"state":{"type":"string","title":"State"},"quiesced":{"type":"boolean","title":"Quiesced"},"checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkpoint"},"dirty":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dirty"},"remote_verified":{"type":"boolean","title":"Remote Verified","default":false},"pending_tasks":{"type":"integer","title":"Pending Tasks","default":0},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["state","quiesced"],"title":"MaintenanceResponse"},"MatchPath":{"properties":{"target_node":{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}]},"path":{"prefixItems":[{"$ref":"#/components/schemas/Predicate"},{"anyOf":[{"$ref":"#/components/schemas/Node"},{"type":"null"}]}],"type":"array","maxItems":2,"minItems":2,"title":"Path"},"similarity":{"type":"number","title":"Similarity"},"children":{"items":{"$ref":"#/components/schemas/MatchPath"},"type":"array","title":"Children"}},"type":"object","required":["path","similarity"],"title":"MatchPath"},"Node":{"properties":{"uuid":{"type":"string","title":"Uuid"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"polarity":{"anyOf":[{"type":"string","enum":["positive","negative","neutral"]},{"type":"null"}],"title":"Polarity","description":"The polarity of the node.","default":"neutral"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"The metadata of the node."},"happened_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Happened At","description":"The date and time the node happened at if known otherwise None. Mostly used for event nodes."},"last_updated":{"type":"string","format":"date-time","title":"Last Updated","description":"The date and time the node was last updated."},"observations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Observation"},"type":"array"},{"type":"null"}],"title":"Observations","description":"The observations of the node."}},"type":"object","required":["labels","name"],"title":"Node","description":"Node model."},"Observation":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text","description":"The text of the observation."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"resource_id":{"type":"string","title":"Resource Id","description":"The id of the resource the observation is about."},"inserted_at":{"type":"string","format":"date-time","title":"Inserted At","description":"The date and time the observation was inserted."}},"type":"object","required":["text","resource_id"],"title":"Observation","description":"Observation model."},"ObservationItemResponse":{"properties":{"message":{"type":"string","title":"Message"},"observation":{"$ref":"#/components/schemas/Observation"}},"type":"object","required":["message","observation"],"title":"ObservationItemResponse"},"ObservationListResponse":{"properties":{"message":{"type":"string","title":"Message"},"observations":{"items":{"$ref":"#/components/schemas/Observation"},"type":"array","title":"Observations"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["message","observations","count"],"title":"ObservationListResponse"},"PartialNode":{"properties":{"uuid":{"type":"string","title":"Uuid","description":"The id of the node."},"name":{"type":"string","title":"Name","description":"The name of the node."},"labels":{"items":{"type":"string"},"type":"array","title":"Labels","description":"The labels of the node."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the node."},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"The properties of the node."}},"type":"object","required":["uuid","name","labels","description","properties"],"title":"PartialNode","description":"Partial node model."},"PartialNodeFilter":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the node to filter by."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"The type of the node to filter by."},"uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uuid","description":"The uuid of the node to filter by."},"meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Description","description":"An extra description that explains what this node is about, helpful for entity resolution."}},"type":"object","title":"PartialNodeFilter","description":"Partial node filter model."},"PartialPredicate":{"properties":{"uuid":{"type":"string","title":"Uuid","description":"The id of the relationship."},"name":{"type":"string","title":"Name","description":"The name of the relationship."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the relationship."},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"The properties of the relationship."},"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"The amount of the relationship, if it is a quantitative relationship."}},"type":"object","required":["uuid","name","description"],"title":"PartialPredicate","description":"Partial relationship model."},"Predicate":{"properties":{"uuid":{"type":"string","title":"Uuid"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"flow_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Key","description":"Unique identitier for contextualizing the predicate into the context flow"},"last_updated":{"type":"string","format":"date-time","title":"Last Updated","description":"The date and time the predicate was last updated."},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether the predicate is deprecated.","default":false},"direction":{"anyOf":[{"type":"string","enum":["in","out","neutral"]},{"type":"null"}],"title":"Direction","description":"The direction of the predicate.","default":"neutral"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount","description":"The amount of the predicate."},"observations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Observation"},"type":"array"},{"type":"null"}],"title":"Observations","description":"The observations of the predicate."},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"level":{"anyOf":[{"type":"string","enum":["1","2","3"]},{"type":"null"}],"title":"Level","description":"The level of the predicate. 1: directly connected to the main node. 2: connected to similar nodes of same label, not directly connected.3: connected to similar nodes of different label, not directly connected."}},"type":"object","required":["name","description"],"title":"Predicate","description":"Predicate model."},"RecommendItem":{"properties":{"node":{"$ref":"#/components/schemas/Node"},"score":{"type":"number","title":"Score"},"connected_by":{"items":{"$ref":"#/components/schemas/Node"},"type":"array","title":"Connected By"},"channel":{"type":"string","title":"Channel"}},"type":"object","required":["node","score","connected_by","channel"],"title":"RecommendItem"},"RecommendRequestBody":{"properties":{"target":{"type":"string","title":"Target"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"polarity":{"type":"string","enum":["same","opposite"],"title":"Polarity","default":"same"},"top_k":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Top K","default":20},"labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Labels"},"include_asymmetric":{"type":"boolean","title":"Include Asymmetric","default":true},"include_multi_interest":{"type":"boolean","title":"Include Multi Interest","default":true},"include_attribute_pref":{"type":"boolean","title":"Include Attribute Pref","default":false},"diversify":{"type":"boolean","title":"Diversify","default":true},"asymmetric_direction":{"type":"string","enum":["outbound","inbound","both"],"title":"Asymmetric Direction","default":"outbound"},"exclude_seen":{"type":"boolean","title":"Exclude Seen","default":false},"recency_half_life_days":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Recency Half Life Days"},"dampen_degree":{"type":"boolean","title":"Dampen Degree","default":false},"behavior_weights":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Behavior Weights"}},"type":"object","required":["target"],"title":"RecommendRequestBody","description":"Request body for event-graph recommendations."},"RecommendResponse":{"properties":{"target_node":{"$ref":"#/components/schemas/Node"},"recommendations":{"items":{"$ref":"#/components/schemas/RecommendItem"},"type":"array","title":"Recommendations"}},"type":"object","required":["target_node","recommendations"],"title":"RecommendResponse"},"RelationshipListResponse":{"properties":{"message":{"type":"string","title":"Message"},"relationships":{"items":{"$ref":"#/components/schemas/Triple"},"type":"array","title":"Relationships"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["message","relationships","total"],"title":"RelationshipListResponse"},"RequestPartialNode":{"properties":{"uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uuid","description":"The id of the node."},"name":{"type":"string","title":"Name","description":"The name of the node."},"labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Labels","description":"Optional labels; defaults to [type] when omitted."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the node."},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"The properties of the node."},"type":{"type":"string","title":"Type","description":"The type of the node."},"happened_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Happened At","description":"The date and time the node happened at if known otherwise None. Mostly used for event nodes."}},"type":"object","required":["name","type"],"title":"RequestPartialNode"},"RequestPartialPredicate":{"properties":{"uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uuid","description":"The id of the relationship."},"name":{"type":"string","title":"Name","description":"The name of the relationship."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the relationship."},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"The properties of the relationship."},"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"The amount of the relationship, if it is a quantitative relationship."}},"type":"object","required":["name"],"title":"RequestPartialPredicate"},"RetrieveNeighborsAiModeRequestBody":{"properties":{"identification_params":{"$ref":"#/components/schemas/IdentificationParams","description":"The identification parameters of the entity to get neighbors for."},"limit":{"type":"integer","title":"Limit","description":"The number of neighbors to return.","default":10},"looking_for":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Looking For","description":"The description of the neighbors to look for."},"brain_id":{"type":"string","title":"Brain Id","description":"The brain identifier to store the data in.","default":"default"}},"type":"object","required":["identification_params","looking_for"],"title":"RetrieveNeighborsAiModeRequestBody","description":"Request body for the retrieve neighbors AI mode endpoint."},"RetrieveNeighborsRequestResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"The number of neighbors found.","default":0},"main_node":{"$ref":"#/components/schemas/Node","description":"The main node of the neighbors."},"neighbors":{"items":{"$ref":"#/components/schemas/RetrievedNeighborNode"},"type":"array","title":"Neighbors"}},"type":"object","required":["main_node","neighbors"],"title":"RetrieveNeighborsRequestResponse","description":"Response for the retrieve neighbors endpoint."},"RetrieveNeighborsWithIdentificationParamsRequestBody":{"properties":{"identification_params":{"$ref":"#/components/schemas/IdentificationParams","description":"The identification parameters of the entity to get neighbors for."},"limit":{"type":"integer","title":"Limit","description":"The number of neighbors to return.","default":10},"brain_id":{"type":"string","title":"Brain Id","description":"The brain identifier to store the data in.","default":"default"},"look_for":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Look For","description":"Optional filter for what type of neighbors to look for."}},"type":"object","required":["identification_params"],"title":"RetrieveNeighborsWithIdentificationParamsRequestBody","description":"Request body for the retrieve neighbors with identification params endpoint."},"RetrieveRequestResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TextChunk"},"type":"array","title":"Data"},"observations":{"items":{"$ref":"#/components/schemas/Observation"},"type":"array","title":"Observations"},"relationships":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Relationships"}},"type":"object","required":["data","observations","relationships"],"title":"RetrieveRequestResponse","description":"Response for the retrieve endpoint."},"RetrievedNeighborNode":{"properties":{"neighbor":{"$ref":"#/components/schemas/Node"},"relationship":{"$ref":"#/components/schemas/Predicate"},"most_common":{"$ref":"#/components/schemas/Node"},"similarity_score":{"type":"number","title":"Similarity Score","description":"The similarity score of the neighbor to the main node.","default":0.0}},"type":"object","required":["neighbor","relationship","most_common"],"title":"RetrievedNeighborNode","description":"Node model for the retrieve neighbors endpoint."},"SearchHit":{"properties":{"id":{"type":"string","title":"Id"},"channel":{"type":"string","title":"Channel"},"score":{"type":"number","title":"Score"},"scores":{"$ref":"#/components/schemas/SearchHitScores"},"snippet":{"type":"string","title":"Snippet"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels"},"extras":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extras"},"node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Id"}},"type":"object","required":["id","channel","score","scores","snippet"],"title":"SearchHit"},"SearchHitScores":{"properties":{"bm25":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bm25"},"dense":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dense"},"rrf":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rrf"},"cc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cc"},"rerank":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rerank"},"plugin":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Plugin"},"graph":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Graph"},"personalize":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Personalize"}},"type":"object","title":"SearchHitScores"},"SearchRequestBody":{"properties":{"query":{"type":"string","title":"Query"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"k":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"K","default":10},"channels":{"items":{"type":"string"},"type":"array","title":"Channels"},"node_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Node Labels"},"community_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Community Labels"},"expand":{"type":"string","enum":["none","neighbors"],"title":"Expand","default":"none"},"fusion":{"anyOf":[{"type":"string","enum":["rrf","cc"]},{"type":"null"}],"title":"Fusion"},"fusion_alpha":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Fusion Alpha"},"rerank":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rerank","description":"none or plugin:<name>. Unknown plugin names return 400."},"mode":{"type":"string","enum":["default","catalog"],"title":"Mode","default":"default"},"profile_stages":{"type":"boolean","title":"Profile Stages","default":false},"extras":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Extras"},"target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"}},"type":"object","required":["query"],"title":"SearchRequestBody"},"SearchResponse":{"properties":{"hits":{"items":{"$ref":"#/components/schemas/SearchHit"},"type":"array","title":"Hits"},"stage_timings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Stage Timings"},"channel_lists":{"anyOf":[{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Channel Lists"},"facets":{"anyOf":[{"additionalProperties":{"additionalProperties":{"type":"integer"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Facets"},"node_ids":{"items":{"type":"string"},"type":"array","title":"Node Ids"}},"type":"object","required":["hits"],"title":"SearchResponse"},"SessionLogin":{"properties":{"token":{"type":"string","maxLength":4096,"minLength":1,"format":"password","title":"Token","writeOnly":true}},"type":"object","required":["token"],"title":"SessionLogin"},"SessionResponse":{"properties":{"authenticated":{"type":"boolean","title":"Authenticated"},"kind":{"type":"string","enum":["system","access_token"],"title":"Kind"},"is_system":{"type":"boolean","title":"Is System"},"brain_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brain Id"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions"},"legacy":{"type":"boolean","title":"Legacy","default":false},"csrf_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Csrf Token","description":"CSRF proof for unsafe cookie-authenticated requests; never an access credential."}},"type":"object","required":["authenticated","kind","is_system","brain_id","permissions"],"title":"SessionResponse"},"StringListResponse":{"items":{"type":"string"},"type":"array","title":"StringListResponse"},"StructuredData":{"properties":{"id":{"type":"string","title":"Id"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The json data rapresenting the structured element."},"types":{"items":{"type":"string"},"type":"array","title":"Types","description":"A list of types, used to categorize the data."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"inserted_at":{"type":"string","format":"date-time","title":"Inserted At","description":"The date and time the structured data was inserted."},"brain_version":{"type":"string","title":"Brain Version","description":"The version of the brain when the structured data was inserted.","default":"0.0.0"}},"type":"object","required":["data","types"],"title":"StructuredData","description":"Structured data model."},"StructuredDataItemResponse":{"properties":{"message":{"type":"string","title":"Message"},"data":{"$ref":"#/components/schemas/StructuredData"}},"type":"object","required":["message","data"],"title":"StructuredDataItemResponse"},"StructuredDataListResponse":{"properties":{"message":{"type":"string","title":"Message"},"data":{"items":{"$ref":"#/components/schemas/StructuredData"},"type":"array","title":"Data"},"count":{"type":"integer","title":"Count"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["message","data","count","total"],"title":"StructuredDataListResponse"},"TaskListResponse":{"properties":{"tasks":{"items":{"$ref":"#/components/schemas/TaskStateResponse"},"type":"array","title":"Tasks"}},"type":"object","required":["tasks"],"title":"TaskListResponse"},"TaskStateResponse":{"properties":{"task_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Id"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"status":{"type":"string","title":"Status"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"result":{"anyOf":[{"$ref":"#/components/schemas/JsonValue"},{"type":"null"}]}},"additionalProperties":true,"type":"object","required":["status"],"title":"TaskStateResponse","description":"Task payload with stable state fields and pipeline-specific extensions."},"TextChunk":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text","description":"The text of the chunk."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"inserted_at":{"type":"string","format":"date-time","title":"Inserted At","description":"The date and time the chunk was inserted."},"brain_version":{"type":"string","title":"Brain Version","description":"The version of the brain when the chunk was inserted.","default":"0.0.0"}},"type":"object","required":["text"],"title":"TextChunk","description":"Text chunk model."},"TextChunkListResponse":{"properties":{"message":{"type":"string","title":"Message"},"data":{"items":{"$ref":"#/components/schemas/TextChunk"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["message","data","total"],"title":"TextChunkListResponse"},"TokenCreation":{"properties":{"brain_id":{"type":"string","title":"Brain Id"},"label":{"type":"string","maxLength":100,"minLength":1,"title":"Label"},"permissions":{"items":{"type":"string"},"type":"array","maxItems":4,"minItems":1,"title":"Permissions"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["brain_id","label","permissions"],"title":"TokenCreation"},"Triple":{"properties":{"subject":{"$ref":"#/components/schemas/Node"},"predicate":{"$ref":"#/components/schemas/Predicate"},"object":{"$ref":"#/components/schemas/Node"}},"type":"object","required":["subject","predicate","object"],"title":"Triple","description":"Triple model."},"TypeListResponse":{"properties":{"message":{"type":"string","title":"Message"},"types":{"items":{"type":"string"},"type":"array","title":"Types"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["message","types","count"],"title":"TypeListResponse"},"UpdateEntityRequest":{"properties":{"uuid":{"type":"string","title":"Uuid"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"new_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Name"},"new_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Description"},"new_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"New Labels"},"new_properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"New Properties"},"properties_to_remove":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Properties To Remove"}},"type":"object","required":["uuid"],"title":"UpdateEntityRequest","description":"Request model for updating an existing entity in the graph."},"UpdateRelationshipRequest":{"properties":{"uuid":{"type":"string","title":"Uuid"},"brain_id":{"type":"string","title":"Brain Id","default":"default"},"new_properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"New Properties"},"properties_to_remove":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Properties To Remove"}},"type":"object","required":["uuid"],"title":"UpdateRelationshipRequest","description":"Request model for updating an existing relationship's properties."},"UpdateWorkspaceRequest":{"properties":{"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"}},"type":"object","title":"UpdateWorkspaceRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Vector":{"properties":{"id":{"type":"string","title":"Id"},"embeddings":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Embeddings"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"distance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance","description":"Cosine distance between the query and the result where lower is nearer. This is only available for search results."}},"type":"object","required":["id","metadata"],"title":"Vector","description":"Embedding node model."},"VectorListResponse":{"properties":{"message":{"type":"string","title":"Message"},"store":{"type":"string","title":"Store"},"vectors":{"items":{"$ref":"#/components/schemas/Vector"},"type":"array","title":"Vectors"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["message","store","vectors","total"],"title":"VectorListResponse"},"VectorStoreInfo":{"properties":{"name":{"type":"string","title":"Name"},"dimension":{"type":"integer","title":"Dimension"}},"type":"object","required":["name","dimension"],"title":"VectorStoreInfo"},"VectorStoreListResponse":{"properties":{"stores":{"items":{"$ref":"#/components/schemas/VectorStoreInfo"},"type":"array","title":"Stores"}},"type":"object","required":["stores"],"title":"VectorStoreListResponse"},"GenericObjectResponse":{"type":"object","description":"An operation-specific JSON object from an installed extension.","additionalProperties":true}},"securitySchemes":{"BrainPAT":{"type":"apiKey","in":"header","name":"BrainPAT","description":"BrainAPI personal access token."},"BearerAuth":{"type":"http","scheme":"bearer","description":"BrainAPI PAT sent as a Bearer token."}}},"servers":[{"url":"http://localhost:8000","description":"Local BrainAPI"}]}