Authentication - Ever Gauzy™ Platform

login

Login to Gauzy with email and password and create a session

login

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "login",
    "arguments": {
        "email": "user@example.com",
        "password": "string",
        "createSession": true
      }
  }
}

const result = await client.callTool({
  "name": "login",
  "arguments": {
    "email": "user@example.com",
    "password": "string",
    "createSession": true
  }
});

result = await session.call_tool("login", arguments={
  "email": "user@example.com",
  "password": "string",
  "createSession": true
})

logout

Logout from Gauzy, clear authentication tokens, and cleanup sessions

logout

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "logout",
    "arguments": {
        "cleanupAllSessions": true
      }
  }
}

const result = await client.callTool({
  "name": "logout",
  "arguments": {
    "cleanupAllSessions": true
  }
});

result = await session.call_tool("logout", arguments={
  "cleanupAllSessions": true
})

Parameters

cleanupAllSessionsboolean

Whether to cleanup all user sessions (default: true)

get_auth_status

Get current authentication status, user information, and session details

get_auth_status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_auth_status",
    "arguments": {
        "includeSessionInfo": true
      }
  }
}

const result = await client.callTool({
  "name": "get_auth_status",
  "arguments": {
    "includeSessionInfo": true
  }
});

result = await session.call_tool("get_auth_status", arguments={
  "includeSessionInfo": true
})

Parameters

includeSessionInfoboolean

Whether to include session information (default: true)

refresh_auth_token

Manually refresh the authentication token and update session context

refresh_auth_token

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "refresh_auth_token",
    "arguments": {
        "updateSessionActivity": true
      }
  }
}

const result = await client.callTool({
  "name": "refresh_auth_token",
  "arguments": {
    "updateSessionActivity": true
  }
});

result = await session.call_tool("refresh_auth_token", arguments={
  "updateSessionActivity": true
})

Parameters

updateSessionActivityboolean

Whether to update session activity (default: true)

get_session_info

Get detailed information about current or user sessions

get_session_info

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_session_info",
    "arguments": {
        "targetSessionId": "string",
        "includeConnections": true
      }
  }
}

const result = await client.callTool({
  "name": "get_session_info",
  "arguments": {
    "targetSessionId": "string",
    "includeConnections": true
  }
});

result = await session.call_tool("get_session_info", arguments={
  "targetSessionId": "string",
  "includeConnections": true
})

Parameters

targetSessionIdstring

Specific session ID to query (default: current session)

includeConnectionsboolean

Whether to include connection details (default: false)

cleanup_sessions

Cleanup expired sessions and get session statistics

cleanup_sessions

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cleanup_sessions",
    "arguments": {}
  }
}

const result = await client.callTool({
  "name": "cleanup_sessions",
  "arguments": {}
});

result = await session.call_tool("cleanup_sessions", arguments={})