Register Agent Endpoint

Register agent endpoint — POST /api/v1/agents/register.

Request Parameters

• agent_session_name (str): A unique name for this agent connection. Combined with the authenticated user’s ID to identify the connection.
• dataset_ids (List[str]): UUIDs of the datasets (from GET /api/v1/datasets).
• dataset_names (List[str]): Names of the datasets this agent connection reads from and writes to.
• memory_mode (Literal[‘session’, ‘cognee’, ‘hybrid’, ‘none’, ‘unknown’]): One of: ‘session’, ‘cognee’, ‘hybrid’, ‘none’, ‘unknown’. Defaults to ‘unknown’.
• metadata (Dict[str, Any]): Free-form metadata object.
• origin_function (Optional[str]): Name of the calling function or tool that triggered the registration, stored on the connection.
• session_id (Optional[str]): Client-supplied session identifier — the same value passed as session_id to POST /api/v1/remember.
• source (Literal[‘agent_memory’, ‘session_trace’, ‘serve’, ‘api_key’, ‘mcp’, ‘api’]): One of: ‘agent_memory’, ‘session_trace’, ‘serve’, ‘api_key’, ‘mcp’, ‘api’. Defaults to ‘api’.
• type (str): Connection type label recorded for the registered agent. Defaults to ‘api’.