> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cattix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get  Formatted Gemini Prompt

> Get the formatted Gemini prompt for the given prompt type.
Args:
    prompt_id (int): The ID of the Gemini prompt
    campaign_id (int): The ID of the campaign
    customer_id (int): The ID of the Google Ads customer
    login_customer_id (int | None): The ID of the Google Ads login customer
    prompt_request (GetFormattedPromptRequestSchema | None): The request to get the formatted prompt
    as_user_id (int | None): The ID of the user to impersonate
    admin_user (User): The current user

Returns:
    FormattedGeminiPromptSchema: The formatted Gemini prompt



## OpenAPI

````yaml https://dev-api.cattix.com/openapi.json post /api/v1/chat/get_formatted_gemini_prompts/{prompt_id}
openapi: 3.1.0
info:
  title: CATTIX API
  description: CATTIX Backend API
  version: 0.107.0
servers:
  - url: http://localhost:8000
    description: Local
  - url: https://dev-api.cattix.com
    description: Development
  - url: https://staging-api.cattix.com
    description: Staging
  - url: https://api.cattix.com
    description: Production
security: []
paths:
  /api/v1/chat/get_formatted_gemini_prompts/{prompt_id}:
    post:
      tags:
        - Chat
      summary: Get  Formatted Gemini Prompt
      description: |-
        Get the formatted Gemini prompt for the given prompt type.
        Args:
            prompt_id (int): The ID of the Gemini prompt
            campaign_id (int): The ID of the campaign
            customer_id (int): The ID of the Google Ads customer
            login_customer_id (int | None): The ID of the Google Ads login customer
            prompt_request (GetFormattedPromptRequestSchema | None): The request to get the formatted prompt
            as_user_id (int | None): The ID of the user to impersonate
            admin_user (User): The current user

        Returns:
            FormattedGeminiPromptSchema: The formatted Gemini prompt
      operationId: >-
        get__formatted_gemini_prompt_api_v1_chat_get_formatted_gemini_prompts__prompt_id__post
      parameters:
        - name: prompt_id
          in: path
          required: true
          schema:
            type: integer
            title: Prompt Id
        - name: campaign_id
          in: query
          required: true
          schema:
            type: integer
            title: Campaign Id
        - name: customer_id
          in: query
          required: true
          schema:
            type: integer
            title: Customer Id
        - name: login_customer_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Login Customer Id
        - name: as_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: As User Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/GetFormattedPromptRequestSchema'
                - type: 'null'
              title: Prompt Request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormattedGeminiPromptSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    GetFormattedPromptRequestSchema:
      properties:
        extra_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra Data
      type: object
      title: GetFormattedPromptRequestSchema
      description: The schema for a request to get a formatted prompt.
    FormattedGeminiPromptSchema:
      properties:
        type:
          $ref: '#/components/schemas/GeminiPromptTypes'
          title: The type of the prompt
        prompt:
          type: string
          title: The prompt
        id:
          type: integer
          title: The ID of the prompt
        prompt_variables:
          items:
            type: string
          type: array
          title: The prompt variables
        prompt_formatting_data:
          additionalProperties: true
          type: object
          title: The prompt formatting data
        formatted_prompt:
          type: string
          title: The formatted prompt
        date_added:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: The date the prompt was added
        date_updated:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: The date the prompt was updated
        model_name:
          anyOf:
            - type: string
            - type: 'null'
          title: The name of the model
        temperature:
          anyOf:
            - type: number
            - type: 'null'
          title: The temperature of the model
      type: object
      required:
        - type
        - prompt
        - id
        - prompt_variables
        - prompt_formatting_data
        - formatted_prompt
      title: FormattedGeminiPromptSchema
      description: The schema for a formatted Gemini prompt.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GeminiPromptTypes:
      type: string
      enum:
        - negative_keyword_recommendations
        - negative_keyword_shopping_pmax_recommendations
        - keyword_pause_recommendations
        - double_check_pause_keywords_recommendation
        - keyword_pause_context_validation
        - headline_recommendations
        - description_recommendations
        - keyword_to_ad_groups_splitting
        - rsa_generation
        - extension_generation
      title: GeminiPromptTypes
      description: The types of prompts for the Gemini API.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: api/v1/users/authorization/token

````