# ai_mentor_orgs_users_retrieve

API ViewSet for managing mentors.

Provides endpoints to retrieve, create, update, and delete mentor data.

Permissions:
    - Accessible to both tenant admins and students.

Endpoint: GET /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Query parameters:

  - `department_id` (integer)
    Department to filter by

  - `filter_by` (string)
    Filter options include, date, name, default is date

  - `metadata_key` (string)
    Metadata key to be queried with

  - `metadata_value` (string)
    Metadata value to be filter for

  - `return_session_information` (boolean)
    Declares if session information should be included in the mentor data

  - `visibility` (string)
    visibility type  to be queried with

## Path parameters:

  - `name` (string, required)

  - `org` (string, required)

  - `user_id` (string, required)

## Response 200 fields (application/json):

  - `name` (string, required)

  - `unique_id` (string)

  - `flow` (any, required)
    The langflow json for the mentor

  - `slug` (string)

  - `platform` (string)

  - `allow_anonymous` (boolean)

  - `metadata` (any,null)

  - `enable_moderation` (boolean)

  - `enable_post_processing_system` (boolean)

  - `enable_openai_assistant` (boolean)
    (Deprecated) Set template mentor to openai-agent instead.

  - `enable_total_grounding` (boolean)
    Whether to force mentor to only use information within the provided documents.

  - `enable_suggested_prompts` (boolean)
    Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.

  - `enable_guided_prompts` (boolean)
    Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.

  - `guided_prompt_instructions` (string)
    Instructions to determine how prompt suggestions are generated.

  - `google_voice` (integer,null)

  - `openai_voice` (integer,null)

  - `categories` (array, required)

  - `categories.id` (integer, required)

  - `categories.description` (string,null)

  - `categories.category_group` (integer,null)

  - `categories.audience` (object, required)

  - `categories.audiences` (array, required)

  - `proactive_prompt` (string)
    Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally

  - `moderation_system_prompt` (string)
    The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.

  - `post_processing_prompt` (string)
    Prompt to be used to alter or modify final llm response into any desired form.

  - `moderation_response` (string)
    Desired feedback to return to the user when their prompt is deemed inappropriate.

  - `safety_system_prompt` (string)
    Prompt to check whether the models response is appropriate or not.

  - `safety_response` (string)
    Feedback given to the user when a model generates an inappropriate response

  - `enable_safety_system` (boolean)

  - `proactive_response` (string)
    Response to start a conversation with a user.

  - `greeting_method` (string)
    How the mentor should greet the user. proactive_prompt: Allow the LLM to respond to proactive_prompt msg. proactive_response: use proactive_response template without performing an LLM call.

*  - Proactive Prompt
*  - Proactive Response
    Enum: "proactive_prompt", "proactive_response"

  - `call_configuration` (object)

  - `call_configuration.mentor` (integer, required)

  - `call_configuration.mode` (string)
    *  - Realtime
*  - Inference
    Enum: "realtime", "inference"

  - `call_configuration.tts_provider` (string)
    *  - Openai
*  - Google
*  - Elevenlabs
    Enum: "openai", "google", "elevenlabs"

  - `call_configuration.stt_provider` (string)
    *  - Openai
*  - Google
*  - Deepgram
*  - Cartesia
    Enum: "openai", "google", "deepgram", "cartesia"

  - `call_configuration.llm_provider` (string)
    *  - Openai
*  - Google
    Enum: "openai", "google"

  - `call_configuration.use_function_calling_for_rag` (boolean)
    Whether to use function calls in the agent or force RAG calls before LLM generation

  - `call_configuration.openai_voice_id` (integer,null, required)

  - `call_configuration.google_voice_id` (integer,null, required)

  - `call_configuration.enable_video` (boolean)
    Whether to enable video for the call. (applicable only for realtime mode)

  - `call_configuration.platform_key` (string, required)

  - `mcp_servers` (array, required)

  - `mcp_servers.url` (string, required)
    The url of the MCP server.

  - `mcp_servers.transport` (string)
    *  - Sse
*  - Websocket
    Enum: "sse", "websocket"

  - `mcp_servers.headers` (any)
    Headers to send to the MCP server. Useful for authentication,

  - `mcp_servers.created_at` (string, required)

  - `mcp_servers.updated_at` (string, required)

  - `last_accessed_by` (integer,null)
    edX user ID

  - `recently_accessed_at` (string,null)

  - `created_by` (string,null)