# ai-prompt ## ai_prompt_orgs_metadata_create - [POST /api/ai-prompt/orgs/{org}/metadata/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_metadata_create.md): Create or update metadata for a prompt. Args: request: The HTTP request containing the metadata. org: The organization/tenant identifier. Returns: Response: The created or updated prompt metadata. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_all_chats_memory_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_retrieve.md): Retrieve chat memory for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve chat memory for. Returns: Response: The user's chat memory entries. Raises: NotFound: If no chat memory exists for the user. ## ai_prompt_orgs_users_all_chats_memory_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_create.md): Create a new chat memory entry for a user. Args: request: The HTTP request containing the chat memory data. org: The organization/tenant identifier. user_id: The ID of the user to create chat memory for. Returns: Response: The created chat memory entry. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_all_chats_memory_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_update.md): Update chat memory for a specific user. Args: request: The HTTP request containing the updated chat memory data. org: The organization/tenant identifier. user_id: The ID of the user to update chat memory for. Returns: Response: A confirmation of the scheduled update task. Raises: BadRequest: If the provided data is invalid. NotFound: If no chat memory exists for the user. ## ai_prompt_orgs_users_all_chats_memory_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_destroy.md): Delete all chat memory for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to delete chat memory for. Returns: Response: A success message if the memory was deleted. Raises: NotFound: If no chat memory exists for the user. ## ai_prompt_orgs_users_all_chats_memory_update_2 - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/{memory_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_update_2.md): Update a specific chat memory entry. Args: request: The HTTP request containing the updated chat memory data. org: The organization/tenant identifier. user_id: The ID of the user who owns the memory. memory_id: The ID of the specific memory entry to update. Returns: Response: The updated chat memory entry. Raises: BadRequest: If the provided data is invalid. NotFound: If the specified memory entry does not exist. ## ai_prompt_orgs_users_all_chats_memory_destroy_2 - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/all-chats-memory/{memory_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_all_chats_memory_destroy_2.md): Delete a specific chat memory entry. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user who owns the memory. memory_id: The ID of the specific memory entry to delete. Returns: Response: A success message if the memory was deleted. Raises: NotFound: If the specified memory entry does not exist. ## ai_prompt_orgs_users_chat_memory_status_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/chat-memory-status/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_chat_memory_status_retrieve.md): Retrieve the chat memory status for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve memory status for. Returns: Response: The user's chat memory status. Raises: NotFound: If no memory status exists for the user. ## ai_prompt_orgs_users_chat_memory_status_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/chat-memory-status/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_chat_memory_status_update.md): Update the chat memory status for a specific user. Args: request: The HTTP request containing the updated status. org: The organization/tenant identifier. user_id: The ID of the user to update memory status for. Returns: Response: The updated chat memory status. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_languages_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/languages/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_languages_retrieve.md): Retrieve all available prompt languages. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user making the request. Returns: Response: A list of available prompt languages. ## ai_prompt_orgs_users_languages_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/languages/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_languages_create.md): Create a new prompt language. Args: request: The HTTP request containing the language data. org: The organization/tenant identifier. user_id: The ID of the user creating the language. Returns: Response: The created prompt language. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_languages_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/languages/{language_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_languages_update.md): Update a specific prompt language. Args: request: The HTTP request containing the updated language data. org: The organization/tenant identifier. user_id: The ID of the user making the request. language_id: The ID of the language to update. Returns: Response: The updated prompt language. Raises: BadRequest: If the provided data is invalid. NotFound: If the specified language does not exist. ## ai_prompt_orgs_users_languages_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/languages/{language_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_languages_destroy.md): Delete a specific prompt language. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user making the request. language_id: The ID of the language to delete. Returns: Response: A success message if the language was deleted. Raises: NotFound: If the specified language does not exist. ## ai_prompt_orgs_users_memory_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_retrieve.md): Retrieve catalog item memory for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve catalog item memory for. Returns: Response: The user's catalog item memory entries. Raises: NotFound: If no catalog item memory exists for the user. ## ai_prompt_orgs_users_memory_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_create.md): Create a new catalog item memory entry for a user. Args: request: The HTTP request containing the catalog item memory data. org: The organization/tenant identifier. user_id: The ID of the user to create catalog item memory for. Returns: Response: The created catalog item memory entry. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_memory_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/memory/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_destroy.md): Delete all catalog item memory for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to delete catalog item memory for. Returns: Response: A success message if the memory was deleted. Raises: NotFound: If no catalog item memory exists for the user. ## ai_prompt_orgs_users_memory_context_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_context_retrieve.md): Retrieve a user's memory context settings. ## ai_prompt_orgs_users_memory_context_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_context_update.md): Updates the user's memory context settings. Returns: 200: list of user memory context data. ## ai_prompt_orgs_users_memory_status_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_status_retrieve.md): Retrieve the memory status for a specific user. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve memory status for. Returns: Response: The user's memory status. Raises: NotFound: If no memory status exists for the user. ## ai_prompt_orgs_users_memory_status_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_status_update.md): Update the memory status for a specific user. Args: request: The HTTP request containing the updated status. org: The organization/tenant identifier. user_id: The ID of the user to update memory status for. Returns: Response: The updated memory status. Raises: BadRequest: If the provided data is invalid. ## ai_prompt_orgs_users_memory_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_update.md): Update a specific catalog item memory entry. Args: request: The HTTP request containing the updated catalog item memory data. org: The organization/tenant identifier. user_id: The ID of the user who owns the memory. memory_id: The ID of the specific memory entry to update. Returns: Response: The updated catalog item memory entry. Raises: BadRequest: If the provided data is invalid. NotFound: If the specified memory entry does not exist. ## ai_prompt_orgs_users_memory_destroy_2 - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_memory_destroy_2.md): Delete a specific catalog item memory entry. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user who owns the memory. memory_id: The ID of the specific memory entry to delete. Returns: Response: A success message if the memory was deleted. Raises: NotFound: If the specified memory entry does not exist. ## ai_prompt_orgs_users_metadata_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/metadata](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_metadata_retrieve.md): Retrieve metadata for a prompt. Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user making the request. Returns: Response: The prompt metadata. Raises: NotFound: If no metadata exists for the specific prompt ## ai_prompt_orgs_users_prompt_list - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_list.md): API viewset for managing prompts. This view allows tenant admins and students to create, retrieve, update, and filter prompts based on various parameters. Permissions: - Accessible to both tenant administrators and students ## ai_prompt_orgs_users_prompt_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_create.md): Create a new prompt. Args: request: HTTP request containing prompt data. Returns: Response with created prompt details. Raises: ValidationError: If the input data is invalid. ## ai_prompt_orgs_users_prompt_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_retrieve.md): API viewset for managing prompts. This view allows tenant admins and students to create, retrieve, update, and filter prompts based on various parameters. Permissions: - Accessible to both tenant administrators and students ## ai_prompt_orgs_users_prompt_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_update.md): Update an existing prompt. Args: request: HTTP request containing updated prompt data. Returns: Response with updated prompt details. Raises: ValidationError: If the input data is invalid. PermissionDenied: If the prompt is system-generated and cannot be edited. ## ai_prompt_orgs_users_prompt_partial_update - [PATCH /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_partial_update.md): API viewset for managing prompts. This view allows tenant admins and students to create, retrieve, update, and filter prompts based on various parameters. Permissions: - Accessible to both tenant administrators and students ## ai_prompt_orgs_users_prompt_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompt_destroy.md): API viewset for managing prompts. This view allows tenant admins and students to create, retrieve, update, and filter prompts based on various parameters. Permissions: - Accessible to both tenant administrators and students ## ai_prompt_orgs_users_prompts_category_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompts_category_retrieve.md): Retrieve a list of prompt categories. Query Parameters: - filter_by (optional): Sorts categories by name if set to "name". Args: request: The HTTP request. org: Organization key identifier. Returns: - 200: List of prompt categories. - 400: If query parameters are invalid. ## ai_prompt_orgs_users_prompts_category_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompts_category_create.md): Create a new prompt category. Args: request: The HTTP request containing category information. org: Organization key identifier. user_id: User performing the request. Returns: - 201: Created prompt category. - 401: If the user is not a tenant admin. - 400: If request data is invalid. ## ai_prompt_orgs_users_prompts_category_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompts_category_destroy.md): Delete a prompt category. Args: request: The HTTP request containing the category to delete. org: Organization key identifier. user_id: User performing the request. Returns: - 204: No Content (successful deletion). - 401: If the user is not a tenant admin. - 400: If request data is invalid. - 404: If the category does not exist. ## ai_prompt_orgs_users_prompts_public_list - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/public/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompts_public_list.md): API viewset for managing prompts. This view allows anyone to retrieve, and filter prompts based on various parameters. Permissions: - Accessible to anyone ## ai_prompt_orgs_users_prompts_public_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/public/{id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_prompts_public_retrieve.md): API viewset for managing prompts. This view allows anyone to retrieve, and filter prompts based on various parameters. Permissions: - Accessible to anyone ## Retrieve guided prompts for a chat session - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/sessions/{session_id}/guided-prompts/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_sessions_guided_prompts_retrieve.md): Fetches AI-generated guided prompts for a given session and organization. ## ai_prompt_orgs_users_styles_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/styles/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_styles_retrieve.md): Endpoint for getting prompt styles. Accessible to tenant admins and students. Returns: 200: List of styles. ## ai_prompt_orgs_users_styles_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/styles/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_styles_create.md): Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 201: style Object. 400: When data is not valid. ## ai_prompt_orgs_users_styles_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_styles_update.md): Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 200: style Object. 400: When data is not valid. ## ai_prompt_orgs_users_styles_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_styles_destroy.md): Endpoint for deleting prompt style. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. ## ai_prompt_orgs_users_tags_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/tags/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tags_retrieve.md): Endpoint for getting prompt tags. Accessible to tenant admins and students. Returns: 200: List of tags. ## ai_prompt_orgs_users_tags_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/tags/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tags_create.md): Endpoint for Adding prompt tag. Accessible to tenant admins and students. Returns: 201: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ Request: Response: { "name": "Programming", "description": "tags for programing prompts" } Response: { "id": 1, "name": "Programming", "description": "tags for programing prompts" } ## ai_prompt_orgs_users_tags_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tags_update.md): Endpoint for updating prompt tag. Accessible to tenant admins and students. Returns: 200: tag Object. 400: When data is not valid. ## ai_prompt_orgs_users_tags_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tags_destroy.md): Endpoint for deleting prompt tag. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. ## ai_prompt_orgs_users_tones_retrieve - [GET /api/ai-prompt/orgs/{org}/users/{user_id}/tones/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tones_retrieve.md): Endpoint for getting prompt tones. Accessible to tenant admins and students. Returns: 200: List of tones. ## ai_prompt_orgs_users_tones_create - [POST /api/ai-prompt/orgs/{org}/users/{user_id}/tones/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tones_create.md): Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: 201: tone Object. 400: When data is not valid. ## ai_prompt_orgs_users_tones_update - [PUT /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tones_update.md): Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: 200: tone Object. 400: When data is not valid. ## ai_prompt_orgs_users_tones_destroy - [DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/](https://docs.ibl.ai/apis/ibl/ai-prompt/ai_prompt_orgs_users_tones_destroy.md): Endpoint for deleting prompt tone. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid.