openapi: 3.2.0
info:
  title: Fanar Chat API
  description: You can interact with FanarAPI for seamless chat completion and text processing using Fanar.
  termsOfService: https://fanar.qa/terms-of-services
  contact:
    name: Fanar Support
    url: https://fanar.qa/
    email: support@fanar.qa
  version: 1.0.0
  x-logo:
    url: /static/white-logo.svg
    alt: logo
security:
- Bearer: []
tags:
- name: Chat
paths:
  /v1/chat/completions:
    post:
      tags:
      - Chat
      summary: Create Chat Completion
      description: 'This endpoint is compatible with the OpenAI library. If certain parameters are not supported by the OpenAI library, they can be provided in the `extra_body` field of the OpenAI request.

        When creating the OpenAI object, set the `base_url` as the API domain followed by `/v1`.'
      operationId: create_chat_completion_v1_chat_completions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatCompletionRequest'
        required: true
      responses:
        '200':
          description: Chat completion response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionResponse'
            text/event-stream:
              schema:
                oneOf:
                - $ref: '#/components/schemas/TokenChunk'
                - $ref: '#/components/schemas/ToolCallChunk'
                - $ref: '#/components/schemas/ToolResultChunk'
                - $ref: '#/components/schemas/ProgressChunk'
                - $ref: '#/components/schemas/DoneChunk'
                - $ref: '#/components/schemas/ErrorChunk'
        '400':
          description: The content was filtered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: content_filter
                  message: The content was filtered
                  status: 400
                  param: prompt
                  type: safety
        '401':
          description: Invalid authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_authentication
                  message: Invalid authentication
                  status: 401
        '403':
          description: Invalid authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_authorization
                  message: Invalid authorization
                  status: 403
        '429':
          description: Rate limit reached or Exceeded quota
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: exceeded_quota
                  message: Exceeded quota
                  status: 429
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: internal_server_error
                  message: Internal server error
                  status: 500
        '503':
          description: Service overloaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: overloaded
                  message: Service overloaded
                  status: 503
        '504':
          description: Request timed out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: timeout
                  message: Request timed out
                  status: 504
        '413':
          description: Request entity too large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: too_large
                  message: Request entity too large
                  status: 413
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: unprocessable
                  message: Unprocessable
                  status: 422
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: conflict
                  message: Conflict
                  status: 409
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: Not found
                  message: Not found
                  status: 404
        '410':
          description: No longer supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: no_longer_supported
                  message: No longer supported
                  status: 410
        '499':
          description: Client closed request before completion
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: client_closed_request
                  message: Client closed request before completion
                  status: 499
      security:
      - Bearer: []
      x-codeSamples:
      - lang: Curl
        label: cURL
        source: "curl -X POST \"https://api.fanar.qa/v1/chat/completions\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY_HERE\" \\\n  -d '{\n    \"model\": \"Fanar\",\n    \"messages\": [\n      {\n        \"role\": \"user\",\n        \"content\": \"Your message here\"\n      }\n    ]\n  }'\n"
      - lang: Python
        label: Python - OpenAI
        source: "from openai import OpenAI\n\nclient = OpenAI(\n    base_url=\"https://api.fanar.qa/v1\",\n    api_key=\"YOUR_API_KEY_HERE\",\n)\n\nmodel_name = \"Fanar\"\nmessages = [\n    {\"role\": \"user\", \"content\": \"Your message here\"}\n]\n\nresponse = client.chat.completions.create(\n    model=model_name,\n    messages=messages,\n)\n\nprint(\"Assistant Response:\\n\")\nprint(response.choices[0].message.content)\n"
      - lang: Python - OpenAI Stream
        label: Python - OpenAI Stream
        source: "from openai import AsyncOpenAI\n\nclient = AsyncOpenAI(\n    base_url=\"https://api.fanar.qa/v1\",\n    api_key=\"YOUR_API_KEY_HERE\",\n)\n\nmessages = [\n    {\"role\": \"user\", \"content\": \"Your message here\"}\n]\n\nstream = await client.chat.completions.create(\n    model=\"Fanar\",\n    messages=messages,\n    stream=True\n)\n\nprint(\"Assistant Response:\\n\")\n\ncontent = \"\"\nreferences = None\n\nasync for chunk in stream:\n    if chunk.choices and chunk.choices[0].delta:\n        delta = chunk.choices[0].delta\n        \n        # Capture references from the first chunk\n        if hasattr(delta, 'references') and delta.references:\n            references = delta.references\n        \n        # Stream content as it arrives\n        if delta.content:\n            content += delta.content\n            print(delta.content, end=\"\", flush=True)\n\nprint(\"\\n\")\n\n# Print references if present\nif references:\n    print(\"\\nReferences:\")\n    for ref in references:\n        number = ref.get(\"number\", \"-\")\n        source = ref.get(\"source\", \"Unknown source\")\n        ref_content = ref.get(\"content\", \"\")\n        print(f\"\\n[{number}] {source}\\n{ref_content}\")\n"
      - lang: Python - Fanar-Sadiq
        label: Python - Fanar-Sadiq
        source: "import requests\n\ndef model_api(messages, model):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": model,\n        \"messages\": messages,\n        \"max_tokens\": 750,\n    }\n\n    response = requests.post(\n        \"https://api.fanar.qa/v1/chat/completions\", \n        json=payload, \n        headers=headers\n    )\n    return response.json()\n\nmodel = \"Fanar-Sadiq\"\n\nprompt = \"What are the Islamic values?\"\n\nmessages = [\n    {\"role\": \"user\", \"content\": prompt}\n]\n\nresponse = model_api(messages=messages, model=model)\n\n# Extract the assistant's answer\ncontent = response[\"choices\"][0][\"message\"][\"content\"]\nprint(\"Assistant Response:\\n\")\nprint(content)\n\n# Print reference sources if present\nreferences = response[\"choices\"][0][\"message\"].get(\"references\", [])\nif references:\n    print(\"\\nReferences:\")\n    for ref in references:\n        number = ref.get(\"number\", \"-\")\n        source = ref.get(\"source\", \"Unknown source\")\n        ref_content = ref.get(\"content\", \"\")\n        print(f\"\\n[{number}] {source}\\n{ref_content}\")\nelse:\n    print(\"\\nNo references returned.\")\n"
      - lang: Python - Fanar-Sadiq with persona
        label: Python - Fanar-Sadiq with persona
        source: "# The \"persona\" parameter controls the assistant's voice and identity.\n# It is only supported for the Fanar-Sadiq model.\n\nimport requests\n\ndef model_api(messages, persona=None):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": \"Fanar-Sadiq\",\n        \"messages\": messages,\n        \"max_tokens\": 750,\n    }\n    if persona:\n        payload[\"persona\"] = persona\n\n    response = requests.post(\n        \"https://api.fanar.qa/v1/chat/completions\",\n        json=payload,\n        headers=headers,\n    )\n    return response.json()\n\nmessages = [\n    {\"role\": \"user\", \"content\": \"What are the Islamic values?\"}\n]\n\n# Customize the assistant's voice/identity for this call.\npersona = \"You are a warm, patient teacher who explains concepts simply for young students.\"\n\nresponse = model_api(messages=messages, persona=persona)\n\ncontent = response[\"choices\"][0][\"message\"][\"content\"]\nprint(\"Assistant Response:\\n\")\nprint(content)\n\n# Print reference sources if present\nreferences = response[\"choices\"][0][\"message\"].get(\"references\", [])\nif references:\n    print(\"\\nReferences:\")\n    for ref in references:\n        number = ref.get(\"number\", \"-\")\n        source = ref.get(\"source\", \"Unknown source\")\n        ref_content = ref.get(\"content\", \"\")\n        print(f\"\\n[{number}] {source}\\n{ref_content}\")\nelse:\n    print(\"\\nNo references returned.\")\n"
      - lang: Python - Fanar-Sadiq-2
        label: Python - Fanar-Sadiq-2
        source: "# Fanar-Sadiq-2 requires additional authorization and is not allowed by default.\n\nimport requests\n\ndef model_api(messages, madhab=None):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": \"Fanar-Sadiq-2\",\n        \"messages\": messages,\n    }\n    if madhab:\n        payload[\"madhab\"] = madhab\n\n    response = requests.post(\n        \"https://api.fanar.qa/v1/chat/completions\",\n        json=payload,\n        headers=headers,\n    )\n    return response.json()\n\nmessages = [\n    {\"role\": \"user\", \"content\": \"What are the conditions for Zakat on gold according to the Hanafi school?\"}\n]\n\nresponse = model_api(messages=messages, madhab=[\"hanafi\"])\n\ncontent = response[\"choices\"][0][\"message\"][\"content\"]\nprint(\"Assistant Response:\\n\")\nprint(content)\n\n# Print reference sources if present\nreferences = response[\"choices\"][0][\"message\"].get(\"references\", [])\nif references:\n    print(\"\\nReferences:\")\n    for ref in references:\n        number = ref.get(\"number\", \"-\")\n        source = ref.get(\"source\", \"Unknown source\")\n        ref_content = ref.get(\"content\", \"\")\n        print(f\"\\n[{number}] {source}\\n{ref_content}\")\n"
      - lang: Python - Thinking mode (Fanar-C-1-8.7B)
        label: Python - Thinking mode (Fanar-C-1-8.7B)
        source: "# Thinking mode requires additional authorization and is not allowed by default.\n\nimport requests\n\ndef model_api(messages, max_tokens=500):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": \"Fanar-C-1-8.7B\",\n        \"messages\": messages,\n        \"max_tokens\": max_tokens,\n    }\n\n    response = requests.post(\n        \"https://api.fanar.qa/v1/chat/completions\", \n        json=payload, \n        headers=headers\n    )\n    return response.json()\n\n# Step 1: User message with \"thinking_user\" role\nmessages = [\n  {\"role\": \"thinking_user\", \"content\": user_input}\n]\n\n# Step 2: Send request to model with extended max tokens\nresponse = model_api(\n    messages=messages,\n    max_tokens=2000,\n)\n\noutput = response[\"choices\"][0][\"message\"][\"content\"]\nfinish_reason = response[\"choices\"][0][\"finish_reason\"]\n\n# Step 3: Check if thinking mode continuation is needed\nhas_think_tag = \"</think>\" in output\nhit_length_limit = finish_reason == \"length\"\n\nif has_think_tag or hit_length_limit:\n    # Extract thinking output\n    thinking_output = output.split(\"</think>\")[0] if has_think_tag else output\n\n    # Modify the last \"thinking_user\" role message to \"user\"\n    for msg in reversed(messages):\n        if msg[\"role\"] == \"thinking_user\":\n            msg[\"role\"] = \"user\"\n            break\n\n    # Add new \"thinking\" role message with extracted output\n    messages.append({\"role\": \"thinking\", \"content\": thinking_output})\n\n    # Re-run model with updated messages, shorter max tokens\n    final_response = model_api(\n        messages=messages,\n        max_tokens=1000,\n    )\n\n    final_output = final_response[\"choices\"][0][\"message\"][\"content\"]\nelse:\n    final_output = output\n\n# final_output now contains the full response after handling thinking mode\nprint(\"Assistant Response:\\n\")\nprint(final_output)\n"
      - lang: Python - Thinking mode (Fanar-C-2-27B)
        label: Python - Thinking mode (Fanar-C-2-27B)
        source: "# Thinking mode requires additional authorization and is not allowed by default.\n\nimport requests\n\ndef model_api(messages, max_tokens=4000):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": \"Fanar-C-2-27B\",\n        \"messages\": messages,\n        \"max_tokens\": max_tokens,\n        \"enable_thinking\": True\n    }\n\n    response = requests.post(\n        \"https://api.fanar.qa/v1/chat/completions\", \n        json=payload, \n        headers=headers\n    )\n    return response.json()\n\nmessages = [\n  {\"role\": \"user\", \"content\": user_input}\n]\n\nresponse = model_api(\n    messages=messages\n)\n\nprint(\"Assistant Response:\\n\")\nprint(response)\n"
      - lang: Python - Image understanding
        label: Python - Image understanding
        source: "# Image understanding requires additional authorization and is not allowed by default.\n\nimport requests\nimport base64\n\ndef model_api(messages):\n    headers = {\n        \"Authorization\": \"Bearer YOUR_API_KEY_HERE\",\n        \"Content-Type\": \"application/json\",\n    }\n\n    payload = {\n        \"model\": \"Fanar-Oryx-IVU-2\",\n        \"messages\": messages,\n        \"max_tokens\": 750,\n    }\n\n    response = requests.post(\"https://api.fanar.qa/v1/chat/completions\", json=payload, headers=headers)\n    return response.json()\n\nwith open(\"path/to/image.jpg\", \"rb\") as image_file:\n    raw_b64 = base64.b64encode(image_file.read()).decode(\"utf-8\")\n\nimage_b64_url = f\"data:image/jpeg;base64,{raw_b64}\"\n\nprompt = \"Tell me about this image.\"\n\nmessages = [\n    {\n        \"role\": \"user\",\n        \"content\": [\n            {\n                \"type\": \"text\",\n                \"text\": prompt\n            },\n            {\n                \"type\": \"image_url\",\n                \"image_url\": {\n                    \"url\": image_b64_url\n                }\n            }\n        ]\n    }\n]\n\nresponse = model_api(messages=messages)\n\ncontent = response[\"choices\"][0][\"message\"][\"content\"]\nprint(\"Assistant Response:\\n\")\nprint(content)\n"
components:
  schemas:
    ErrorCode:
      type: string
      enum:
      - content_filter
      - invalid_authentication
      - invalid_authorization
      - rate_limit_reached
      - exceeded_quota
      - internal_server_error
      - overloaded
      - timeout
      - too_large
      - unprocessable
      - conflict
      - Not found
      - no_longer_supported
      - client_closed_request
      title: ErrorCode
    ChatCompletionContentText:
      properties:
        type:
          type: string
          const: text
          title: Type
        text:
          type: string
          title: Text
      type: object
      required:
      - type
      - text
      title: ChatCompletionContentText
    ToolCallData:
      description: Tool call in delta.tool_calls
      properties:
        index:
          description: The index of the tool call in the list
          title: Index
          type: integer
        id:
          description: The unique identifier for the tool call
          title: Id
          type: string
        type:
          default: function
          description: The type of the tool call
          title: Type
          type: string
        function:
          $ref: '#/components/schemas/FunctionData'
      required:
      - index
      - id
      - function
      title: ToolCallData
      type: object
    ChatCompletionToolCall:
      properties:
        id:
          type: string
          title: id
          description: The unique identifier for the tool call
        name:
          type: string
          title: name
          description: The name of the tool called
        arguments:
          additionalProperties: true
          type: object
          title: arguments
          description: The arguments passed to the tool
        result:
          anyOf:
          - {}
          - type: 'null'
          title: result
          description: The result returned by the tool
        structured_content:
          anyOf:
          - {}
          - type: 'null'
          title: structured_content
          description: The structured content returned by the tool
        is_error:
          anyOf:
          - type: boolean
          - type: 'null'
          title: is_error
          description: Indicates if there was an error during the tool call
      type: object
      required:
      - id
      - name
      - arguments
      title: ChatCompletionToolCall
    ChoiceError:
      properties:
        index:
          default: 0
          title: Index
          type: integer
        delta:
          $ref: '#/components/schemas/DeltaContent'
        finish_reason:
          default: error
          title: Finish Reason
          type: string
      required:
      - delta
      title: ChoiceError
      type: object
    ChoiceToolResult:
      properties:
        index:
          default: 0
          title: Index
          type: integer
        finish_reason:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          description: The reason the model stopped generating
          title: Finish Reason
        delta:
          $ref: '#/components/schemas/DeltaToolResult'
      required:
      - delta
      title: ChoiceToolResult
      type: object
    ChatCompletionChoiceMessage-Output:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/ChatCompletionContentText'
              - $ref: '#/components/schemas/ChatCompletionContentImage'
              - $ref: '#/components/schemas/ChatCompletionContentAudio'
            type: array
          - type: 'null'
          title: Content
        role:
          type: string
          const: assistant
          title: Role
        references:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionChoiceMessageReference'
            type: array
          - type: 'null'
          title: references
          description: The list of references used in the response
        tool_calls:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionToolCall'
            type: array
          - type: 'null'
          title: tool_calls
          description: The list of tool calls made by the assistant.
      type: object
      required:
      - role
      title: ChatCompletionChoiceMessage
    ChoiceToken:
      properties:
        index:
          default: 0
          title: Index
          type: integer
        finish_reason:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          description: The reason the model stopped generating
          title: Finish Reason
        delta:
          $ref: '#/components/schemas/DeltaContent'
      required:
      - delta
      title: ChoiceToken
      type: object
    DeltaContent:
      properties:
        content:
          example: Hello
          title: Content
          type: string
      required:
      - content
      title: DeltaContent
      type: object
    Error:
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          title: Message
          default: Internal server error
        status:
          $ref: '#/components/schemas/ErrorStatus'
          default: 500
        param:
          anyOf:
          - type: string
          - type: 'null'
          title: Param
        type:
          anyOf:
          - $ref: '#/components/schemas/ErrorContentFilterType'
          - type: 'null'
      type: object
      title: Error
    ChatCompletionThinkingMessageParam:
      properties:
        role:
          type: string
          const: thinking
          title: Role
        content:
          type: string
          title: Content
      type: object
      required:
      - role
      - content
      title: ChatCompletionThinkingMessageParam
    SourcesEnum:
      type: string
      enum:
      - islam_qa
      - islamweb
      - islamweb_fatwa
      - islamweb_consult
      - islamweb_article
      - islamweb_library
      - sunnah
      - quran
      - tafsir
      - dorar
      - islamonline
      - shamela
      title: SourcesEnum
    ChatCompletionRequest:
      properties:
        messages:
          items:
            anyOf:
            - $ref: '#/components/schemas/ChatCompletionSystemMessageParam'
            - $ref: '#/components/schemas/ChatCompletionUserMessageParam'
            - $ref: '#/components/schemas/ChatCompletionAssistantMessageParam'
            - $ref: '#/components/schemas/ChatCompletionThinkingUserMessageParam'
            - $ref: '#/components/schemas/ChatCompletionThinkingMessageParam'
          type: array
          title: Messages
        model:
          $ref: '#/components/schemas/ChatCompletionLLM'
          description: The model to use for the completion. For the Fanar-Sadiq and Fanar-Sadiq-2 models, the following LLM parameters are not used.
        enable_thinking:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enable Thinking
          description: Whether to enable the thinking role in the conversation. This only applies if the model supports it. Currently, only the Fanar-C-2-27B model supports this parameter with additional authorization.
          default: false
        frequency_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Frequency Penalty
          description: A penalty for how much new tokens should avoid repeating existing ones.
          default: 0.0
        logit_bias:
          anyOf:
          - additionalProperties:
              type: number
            type: object
          - type: 'null'
          title: Logit Bias
          description: Modify the likelihood of specified tokens appearing in the completion.
        logprobs:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Logprobs
          description: Whether to return log probabilities of the output tokens or not.
        top_logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top Logprobs
          description: An integer between 0 and 20 specifying the number of most likely tokens toreturn at each token position, each with an associated log probability.
        max_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Tokens
          description: The maximum number of tokens that can be generated in the chat completion.
        n:
          anyOf:
          - type: integer
          - type: 'null'
          title: N
          description: How many chat completion choices to generate for each input message.
        presence_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Presence Penalty
          description: Number between -2.0 and 2.0. Positive values penalize new tokens based onwhether they appear in the text so far, increasing the model's likelihood totalk about new topics.
        stop:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop
          description: Up to 4 sequences where the API will stop generating further tokens.
        stream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Stream
          description: Whether to stream back partial progress as tokens are generated.
          default: false
        temperature:
          anyOf:
          - type: number
          - type: 'null'
          title: Temperature
          description: The sampling temperature, where 0.0 means deterministic output.
          default: 0.0
        top_p:
          anyOf:
          - type: number
          - type: 'null'
          title: Top P
          description: Controls the cumulative probability of the top tokens to consider.
        best_of:
          anyOf:
          - type: integer
          - type: 'null'
          title: Best Of
          description: Number of output sequences that are generated from the prompt.
        top_k:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top K
          description: Controls the number of top tokens to consider.
        min_p:
          anyOf:
          - type: number
          - type: 'null'
          title: Min P
          description: Represents the minimum probability for a token to be considered, relative to the probability of the most likely token.
        repetition_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Repetition Penalty
          description: A penalty for repeating the same tokens in the generated output.
          default: 1.1
        length_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Length Penalty
          description: Penalizes sequences based on their length. Used in beam search.
        early_stopping:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Early Stopping
          description: Controls the stopping condition for beam-based methods.
        stop_token_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Stop Token Ids
          description: List of tokens that stop the generation when they are generated.
        ignore_eos:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Ignore Eos
          description: Whether to ignore the EOS token and continue generating tokens after the EOS token is generated.
        min_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Tokens
          description: Minimum number of tokens to generate per output sequence before EOS or stop_token_ids can be generated.
        skip_special_tokens:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Skip Special Tokens
          description: Whether to skip special tokens in the output.
        spaces_between_special_tokens:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Spaces Between Special Tokens
          description: Whether to add spaces between special tokens in the output.
        truncate_prompt_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Truncate Prompt Tokens
          description: If set to an integer k, will use only the last k tokens from the prompt
        prompt_logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Logprobs
          description: Number of log probabilities to return per prompt token.
        book_names:
          anyOf:
          - items:
              $ref: '#/components/schemas/BookNamesEnum'
            type: array
          - type: 'null'
          title: Book Names
          description: List of book names to use for the Fanar-Sadiq model.
        preferred_sources:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/SourcesEnum'
              - type: string
            type: array
          - type: 'null'
          title: Preferred Sources
          description: List the preferred sources to use for the Fanar-Sadiq model, in order of priority, with fallback sources used if needed. Accepts predefined source names or values starting with 'digital_seerah'.
        exclude_sources:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/SourcesEnum'
              - type: string
            type: array
          - type: 'null'
          title: Exclude Sources
          description: List of sources to exclude from the Fanar-Sadiq model. Accepts predefined source names or values starting with 'digital_seerah'.
        filter_sources:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/SourcesEnum'
              - type: string
            type: array
          - type: 'null'
          title: Filter Sources
          description: List of sources to filter from the Fanar-Sadiq model. Accepts predefined source names or values starting with 'digital_seerah'.
        madhab:
          anyOf:
          - items:
              $ref: '#/components/schemas/MadhabEnum'
            type: array
          - type: 'null'
          title: Madhab
          description: List of madhab (Islamic school of thought) to filter by for the Fanar-Sadiq-2 model.
        restrict_to_islamic:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Restrict To Islamic
          description: When enabled for Fanar-Sadiq model, only Islamic content prompts will be accepted. Non-Islamic content will be rejected.
          default: false
        persona:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Persona
          description: Custom persona that controls the assistant's voice and identity for the Fanar-Sadiq model. Free-form text; only supported for Fanar-Sadiq.
      type: object
      required:
      - messages
      - model
      title: ChatCompletionRequest
      example:
        model: Fanar
        messages:
        - role: user
          content: Hello
    ChoiceToolCall:
      properties:
        index:
          default: 0
          title: Index
          type: integer
        finish_reason:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          description: The reason the model stopped generating
          title: Finish Reason
        delta:
          $ref: '#/components/schemas/DeltaToolCalls'
      required:
      - delta
      title: ChoiceToolCall
      type: object
    ToolCallChunk:
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        choices:
          description: A list of chat completion choices.Can be more than one if `n` is greater than 1.
          items:
            $ref: '#/components/schemas/ChoiceToolCall'
          title: Choices
          type: array
      required:
      - id
      - created
      - model
      - choices
      title: ToolCallChunk
      type: object
    MadhabEnum:
      type: string
      enum:
      - all
      - hanafi
      - maliki
      - shafii
      - hanbali
      title: MadhabEnum
    ChatCompletionLLM:
      type: string
      enum:
      - Fanar
      - Fanar-S-1-7B
      - Fanar-C-1-8.7B
      - Fanar-C-2-27B
      - Fanar-Sadiq
      - Fanar-Sadiq-2
      - Fanar-Oryx-IVU-2
      title: ChatCompletionLLM
    CompletionUsage:
      additionalProperties: true
      properties:
        completion_tokens:
          title: Completion Tokens
          type: integer
        prompt_tokens:
          title: Prompt Tokens
          type: integer
        total_tokens:
          title: Total Tokens
          type: integer
        completion_tokens_details:
          anyOf:
          - $ref: '#/components/schemas/CompletionTokensDetails'
          - type: 'null'
          default: null
        prompt_tokens_details:
          anyOf:
          - $ref: '#/components/schemas/PromptTokensDetails'
          - type: 'null'
          default: null
      required:
      - completion_tokens
      - prompt_tokens
      - total_tokens
      title: CompletionUsage
      type: object
    ProgressData:
      description: Progress event data
      properties:
        message:
          $ref: '#/components/schemas/ProgressMessage'
          description: Bilingual progress message indicating current processing step
      required:
      - message
      title: ProgressData
      type: object
    DoneChunk:
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        choices:
          description: List of choices with final delta
          items:
            $ref: '#/components/schemas/ChoiceFinal'
          title: Choices
          type: array
        usage:
          anyOf:
          - $ref: '#/components/schemas/CompletionUsage'
          - type: 'null'
          default: null
          description: Usage statistics for the completion request.
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          default: null
          description: Additional metadata associated with the completion.
          title: Metadata
      required:
      - id
      - created
      - model
      - choices
      title: DoneChunk
      type: object
    ErrorStatus:
      type: integer
      enum:
      - 400
      - 401
      - 403
      - 429
      - 429
      - 500
      - 503
      - 504
      - 413
      - 422
      - 409
      - 404
      - 410
      - 499
      title: ErrorStatus
    ChoiceLogprobs-Output:
      properties:
        content:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionTokenLogprob'
            type: array
          - type: 'null'
          title: Content
        refusal:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionTokenLogprob'
            type: array
          - type: 'null'
          title: Refusal
      additionalProperties: true
      type: object
      title: ChoiceLogprobs
    ChatCompletionContentImage:
      properties:
        type:
          type: string
          const: image_url
          title: Type
        image_url:
          $ref: '#/components/schemas/URL'
      type: object
      required:
      - type
      - image_url
      title: ChatCompletionContentImage
    PromptTokensDetails:
      additionalProperties: true
      properties:
        audio_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Audio Tokens
        cached_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Cached Tokens
      title: PromptTokensDetails
      type: object
    ChatCompletionThinkingUserMessageParam:
      properties:
        role:
          type: string
          const: thinking_user
          title: Role
        content:
          type: string
          title: Content
      type: object
      required:
      - role
      - content
      title: ChatCompletionThinkingUserMessageParam
    ChatCompletionContentPartVideoParam:
      properties:
        video_url:
          $ref: '#/components/schemas/VideoURL'
        type:
          type: string
          const: video_url
          title: Type
      type: object
      required:
      - video_url
      - type
      title: ChatCompletionContentPartVideoParam
    ChatCompletionContentPartTextParam:
      properties:
        text:
          type: string
          title: Text
        type:
          type: string
          const: text
          title: Type
      type: object
      required:
      - text
      - type
      title: ChatCompletionContentPartTextParam
    ProgressMessage:
      description: Bilingual progress message
      properties:
        en:
          description: Progress message in English
          title: En
          type: string
        ar:
          description: Progress message in Arabic
          title: Ar
          type: string
      required:
      - en
      - ar
      title: ProgressMessage
      type: object
    ChatCompletionTokenLogprob:
      properties:
        token:
          type: string
          title: Token
        bytes:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Bytes
        logprob:
          type: number
          title: Logprob
        top_logprobs:
          items:
            $ref: '#/components/schemas/TopLogprob'
          type: array
          title: Top Logprobs
      additionalProperties: true
      type: object
      required:
      - token
      - logprob
      - top_logprobs
      title: ChatCompletionTokenLogprob
    ChoiceFinal:
      properties:
        index:
          default: 0
          title: Index
          type: integer
        finish_reason:
          default: stop
          title: Finish Reason
          type: string
        delta:
          $ref: '#/components/schemas/DeltaReferences'
      required:
      - delta
      title: ChoiceFinal
      type: object
    DeltaToolCalls:
      properties:
        tool_calls:
          description: The list of tool calls that need to be executed.
          items:
            $ref: '#/components/schemas/ToolCallData'
          title: Tool Calls
          type: array
      required:
      - tool_calls
      title: DeltaToolCalls
      type: object
    FunctionData:
      description: Function call details
      properties:
        name:
          description: The name of the function to call
          title: Name
          type: string
        arguments:
          description: The arguments to pass to the function as JSON string
          title: Arguments
          type: string
      required:
      - name
      - arguments
      title: FunctionData
      type: object
    ErrorChunk:
      description: Error chunk
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        choices:
          items:
            $ref: '#/components/schemas/ChoiceError'
          title: Choices
          type: array
      required:
      - id
      - created
      - model
      - choices
      title: ErrorChunk
      type: object
    ProgressChunk:
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        progress:
          $ref: '#/components/schemas/ProgressData'
          description: Progress event indicating current processing step
      required:
      - id
      - created
      - model
      - progress
      title: ProgressChunk
      type: object
    ChatCompletionContentAudio:
      properties:
        type:
          type: string
          const: audio_url
          title: Type
        audio_url:
          $ref: '#/components/schemas/URL'
      type: object
      required:
      - type
      - audio_url
      title: ChatCompletionContentAudio
    TokenChunk:
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        choices:
          description: A list of chat completion choices.Can be more than one if `n` is greater than 1.
          items:
            $ref: '#/components/schemas/ChoiceToken'
          title: Choices
          type: array
      required:
      - id
      - created
      - model
      - choices
      title: TokenChunk
      type: object
    ChatCompletionChoiceMessageReference:
      properties:
        index:
          description: The location of the reference in the response
          title: index
          type: integer
        number:
          description: The reference number in the response
          title: number
          type: integer
        source:
          description: The source of the reference
          title: source
          type: string
        content:
          description: The content of the reference
          title: content
          type: string
      required:
      - index
      - number
      - source
      - content
      title: ChatCompletionChoiceMessageReference
      type: object
    ToolResultChunk:
      properties:
        id:
          description: A unique identifier for the chat completion
          title: Id
          type: string
        object:
          default: chat.completion.chunk
          description: The object type
          title: Object
          type: string
        created:
          description: The Unix timestamp (in seconds) of when the chat completion was created.
          title: Created
          type: integer
        model:
          description: The model used for the chat completion.
          title: Model
          type: string
        choices:
          description: A list of chat completion choices.Can be more than one if `n` is greater than 1.
          items:
            $ref: '#/components/schemas/ChoiceToolResult'
          title: Choices
          type: array
      required:
      - id
      - created
      - model
      - choices
      title: ToolResultChunk
      type: object
    ChatCompletionResponse:
      properties:
        id:
          type: string
          title: Id
          description: A unique identifier for the chat completion
        choices:
          items:
            $ref: '#/components/schemas/ChatCompletionChoice-Output'
          type: array
          title: Choices
          description: A list of chat completion choices.Can be more than one if `n` is greater than 1.
        created:
          type: integer
          title: Created
          description: The Unix timestamp (in seconds) of when the chat completion was created.
        model:
          type: string
          title: Model
          description: The model used for the chat completion.
        object:
          type: string
          const: chat.completion
          title: Object
          description: The object type
          default: chat.completion
        usage:
          anyOf:
          - $ref: '#/components/schemas/CompletionUsage'
          - type: 'null'
          description: Usage statistics for the completion request.
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
          description: Additional metadata associated with the completion.
      type: object
      required:
      - id
      - choices
      - created
      - model
      title: ChatCompletionResponse
    DeltaToolResult:
      properties:
        tool_result:
          $ref: '#/components/schemas/ToolResultData'
          description: The list of tool call results returned by the executed tools.
      required:
      - tool_result
      title: DeltaToolResult
      type: object
    ErrorContentFilterType:
      type: string
      enum:
      - safety
      - blocklist
      - incomplete
      title: ErrorContentFilterType
    URL:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: URL
    DeltaReferences:
      properties:
        references:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionChoiceMessageReference'
            type: array
          - type: 'null'
          default: null
          description: The list of references used in the response
          title: References
      title: DeltaReferences
      type: object
    ChatCompletionSystemMessageParam:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          title: Content
        role:
          type: string
          const: system
          title: Role
        name:
          type: string
          title: Name
      type: object
      required:
      - content
      - role
      title: ChatCompletionSystemMessageParam
    ChatCompletionAssistantMessageParam:
      properties:
        role:
          type: string
          const: assistant
          title: Role
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartRefusalParam'
            type: array
          - type: 'null'
          title: Content
        name:
          type: string
          title: Name
        tool_calls:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionToolCall'
            type: array
          - type: 'null'
          title: Tool Calls
      type: object
      required:
      - role
      title: ChatCompletionAssistantMessageParam
    CompletionTokensDetails:
      additionalProperties: true
      properties:
        accepted_prediction_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Accepted Prediction Tokens
        audio_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Audio Tokens
        reasoning_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Reasoning Tokens
        rejected_prediction_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          default: null
          title: Rejected Prediction Tokens
      title: CompletionTokensDetails
      type: object
    BookNamesEnum:
      type: string
      enum:
      - أصل الزراري شرح صحيح البخاري - مخطوط
      - جمهرة تراجم الفقهاء المالكية
      - مختصر تحفة المحتاج بشرح المنهاج
      - شرح رياض الصالحين - حطيبة
      - 'تفسير العثيمين: الزمر'
      - الموسوعة في صحيح السيرة النبوية - العهد المكي
      - تيسير التفسير للقطان
      - 'تفسير العثيمين: السجدة'
      - شرح زاد المستقنع - الشنقيطي - التفريغ
      - تقويم طرق تعليم القرآن الكريم في مراحل التعليم العام والتعليم الجامعي
      - شرح الورقات في أصول الفقه - الددو
      - السراج الوهاج
      - معلم التجويد
      - فتح القدير للكمال بن الهمام - ط الحلبي
      - دلائل الإعجاز بين أبي سعيد السيرافي والجرجاني
      - معلمة الفقه المالكي
      - الفرائض
      - غزوات النبي
      - فقه السيرة النبوية لمنير الغضبان
      - شرح صحيح مسلم - حسن أبو الأشبال
      - رسالة ابن القيم إلى أحد إخوانه - ط الشرق الأوسط
      - مجموع فتاوى ورسائل العثيمين
      - حاشية البجيرمي على الخطيب = تحفة الحبيب على شرح الخطيب
      - جواهر البلاغة في المعاني والبيان والبديع
      - أعلام السيرة النبوية في القرن الثاني للهجرة
      - شرح سنن النسائي - الراجحي
      - فتاوى واستشارات الإسلام اليوم
      - مذكرة أصول الفقه - الجامعة الإسلامية
      - الوفيات والأحداث
      - صحيح كنوز السنة النبوية
      - التفسير الميسر
      - فتح السلام شرح عمدة الأحكام من فتح الباري
      - المنتخب في ذكر نسب قبائل العرب
      - المنهاج الواضح للبلاغة
      - البيان والتعريف في أسباب ورود الحديث الشريف
      - متون طالب العلم - المستوى الخامس - 3
      - تفسير أسماء الله الحسنى للسعدي
      - شرح رياض الصالحين لابن عثيمين
      - يسألونك عن رمضان
      - تكملة المعاجم العربية
      - التفسير الوسيط - الزحيلي
      - التفسير القيم = تفسير القرآن الكريم لابن القيم
      - قاموس الإملاء
      - علوم البلاغة
      - السيرة النبوية لأبي الحسن الندوي
      - مدارج السالكين - ط عطاءات العلم
      - نونية ابن القيم الكافية الشافية - ط عطاءات العلم
      - المختصر في تفسير القرآن الكريم
      - نيل الأوطار شرح منتقى الأخبار - ط الحديث
      - التنوير شرح الجامع الصغير
      - قواعد التجويد على رواية حفص عن عاصم بن أبي النجود
      - شرح صحيح البخاري - عبد الكريم الخضير
      - منهج الإمام أحمد في إعلال الأحاديث
      - السيرة النبوية كما جاءت في الأحاديث الصحيحة
      - تقريب فتاوى ابن تيمية
      - ترجمة القرآن الكريم
      - 'تفسير العثيمين: الحجرات - الحديد'
      - تحرير تقريب التهذيب
      - المعتصر من شرح مختصر الأصول من علم الأصول
      - علوم البلاغة «البديع والبيان والمعاني»
      - الفقه المنهجي على مذهب الإمام الشافعي
      - الإعراب المفصل لكتاب الله المرتل
      - المختصر في المنطق
      - مفهوم التفسير والتأويل والاستنباط والتدبر والمفسر
      - الجرح والتعديل - اللاحم
      - فتاوى مهمة تتعلق بالحج والعمرة
      - الرسائل الحربية في عصر الدولة الأيوبية
      - حاشية ابن عابدين = رد المحتار ط الحلبي
      - عشائر العراق
      - مدخل إلى التفسير وعلوم القرآن
      - الإمام البخاري وكتابه الجامع الصحيح
      - فائدة جليلة في قواعد الأسماء الحسنى
      - التفسير الواضح
      - المعجم الوسيط
      - التسهيل في فقه الإمام أحمد - وزارة الأوقاف الكويتية
      - أيسر التفاسير للجزائري
      - أصول النحو 2 - جامعة المدينة
      - بغية المقتصد شرح بداية المجتهد
      - موجز التاريخ الإسلامي من عهد آدم إلى عصرنا الحاضر
      - السيرة النبوية الصحيحة محاولة لتطبيق قواعد المحدثين في نقد روايات السيرة النبوية
      - نضرة النعيم في مكارم أخلاق الرسول الكريم
      - قواعد الإملاء
      - الرحيق المختوم
      - البر والصلة لابن الجوزي
      - مقاصد الشريعة الإسلامية
      - دراسات في تاريخ العرب القديم
      - إتحاف الأريب بشرح الغاية والتقريب
      - سبل السلام شرح بلوغ المرام - ط الحديث
      - اللؤلؤ المكنون في سيرة النبي المأمون
      - نظرية المقاصد عند الإمام الشاطبي
      - سير أعلام النبلاء - ط الرسالة
      - القاموس المحيط
      - البدع والمخالفات في الحج
      - أساليب بلاغية
      - غاية المرام في تخريج أحاديث الحلال والحرام
      - الروح - ابن القيم - ط عطاءات العلم
      - هداية الحيارى في أجوبة اليهود والنصارى - ط عطاءات العلم
      - موسوعة المفاهيم الإسلامية العامة
      - شرح الأربعين النووية - العباد
      - 'تفسير العثيمين: النساء'
      - أصول الإيمان لمحمد بن عبد الوهاب - ت الجوابرة
      - عون المعبود وحاشية ابن القيم
      - تيسير اللطيف المنان في خلاصة تفسير القرآن - ط الأوقاف السعودية
      - شرح عمدة الأحكام - عبد الكريم الخضير
      - الوجيز في إيضاح قواعد الفقة الكلية
      - حاشية السندي على سنن ابن ماجه
      - 'تفسير العثيمين: النمل'
      - السيرة النبوية والدعوة في العهد المكي
      - بغية الإيضاح لتلخيص المفتاح في علوم البلاغة
      - قصة الحضارة
      - فيض الباري على صحيح البخاري
      - مناظرة بين الإسلام والنصرانية
      - النظم البلاغي بين النظرية والتطبيق
      - بحوث في تاريخ السنة المشرفة
      - الوجيز في حكم تجويد الكتاب العزيز
      - التخريج عند الفقهاء والأصوليين
      - 'تفسير العثيمين: الشعراء'
      - الأسلوب
      - المسند الجامع
      - حاشية الصاوي على الشرح الصغير = بلغة السالك لأقرب المسالك
      - تلخيص فقة الفرائض
      - فقه السيرة للغزالي
      - فقه المعاملات
      - مختصر في قواعد التفسير
      - سلسلة الآداب - المنجد
      - الدرر البهية من الفتاوى الكويتية
      - شرح الأربعين النووية للعثيمين
      - التحرير والتنوير
      - فتح القدير للشوكاني
      - العقود الدرية في تنقيح الفتاوى الحامدية
      - سلسلة الأحاديث الصحيحة وشيء من فقهها وفوائدها
      - تفسير القرطبي = الجامع لأحكام القرآن
      - فقه العبادات على المذهب الشافعي
      - التحفة الندية شرح العقيدة الواسطية - عبد الرحمن العقل
      - سلسلة الفوائد الحديثية والفقهية
      - شرح المحرر في الحديث - عبد الكريم الخضير
      - معجم تصحيح لغة الإعلام العربي
      - آداب البحث والمناظرة
      - شرح سنن الترمذي - عبد الكريم الخضير
      - المجتبى من مشكل إعراب القرآن
      - المختصر المفيد في أحكام التجويد - بآخر مصحف القراءات والتجويد
      - مواهب الجليل من أدلة خليل
      - التذهيب في أدلة متن الغاية والتقريب
      - السيرة النبوية - راغب السرجاني
      - معالم مكة التأريخية والأثرية
      - 'تفسير العثيمين: الأنعام'
      - حياة محمد صلى الله عليه وآله وسلم
      - متون طالب العلم - الإضافية - 2
      - التجريد لبغية المريد في القراءات السبع - ت ضاري
      - الأحاديث الواردة في فضائل الصحابة
      - لطائف قرآنية
      - المتشابه
      - تفسير البيضاوي = أنوار التنزيل وأسرار التأويل
      - خصائص التراكيب دارسة تحليلية لمسائل علم المعاني
      - 'تفسير العثيمين: فصلت'
      - فقه النوازل في العبادات
      - الوابل الصيب - ط دار الحديث
      - السيرة النبوية بين الآثار المروية والآيات القرآنية
      - فتاوى دار الإفتاء المصرية
      - زوائد الأحاديث الواردة في فضائل الصحابة
      - شرح المدائح النبوية
      - جامع تفاسير الأحلام = تنبيه الأفهام بتأويل الأحلام
      - الطبقات للنسائي
      - أصول الإيمان لابن باز
      - صحيح السيرة النبوية للألباني
      - 'تفسير العثيمين: لقمان'
      - شرح جامع الترمذي - الراجحي
      - مدونة أحكام الوقف الفقهية
      - معجم المعالم الجغرافية في السيرة النبوية
      - الأديان والمذاهب - جامعة المدينة
      - الفتح المبين بشرح الأربعين
      - تحفة المودود بأحكام المولود - ط عطاءات العلم
      - لا تحزن
      - موسوعة الفرق المنتسبة للإسلام
      - مائة من عظماء أمة الإسلام غيروا مجرى التاريخ
      - منهج الإمام الطاهر بن عاشور في التفسير
      - حاشية السيوطي على سنن النسائي
      - السيرة النبوية منهجية دراستها واستعراض أحداثها
      - 'تفسير العثيمين: القصص'
      - 'تفسير العثيمين: النور'
      - تذكرة الأريب في تفسير الغريب
      - أثر العقيدة الإسلامية في تضامن ووحدة الأمة الإسلامية
      - السياسة الشرعية - جامعة المدينة
      - فتاوى إسلامية
      - فقه السيرة النبوية مع موجز لتاريخ الخلافة الراشدة
      - معجم الشعراء العرب
      - القواعد الفقهية وتطبيقاتها في المذاهب الأربعة
      - منهاج أهل السنة والجماعة في العقيدة والعمل
      - الجنايات في الفقه الإسلامي دراسة مقارنة بين الفقه الإسلامي والقانون
      - تسهيل الفرائض
      - 'تفسير العثيمين: الفاتحة والبقرة'
      - شرح كتاب الإيمان - يوسف الغفيص
      - صيد الخاطر
      - المنيحة بسلسلة الأحاديث الصحيحة
      - شرح صحيح البخاري - أسامة سليمان
      - تلخيص الأصول
      - الشامل في زكاة الأسهم واستثمار أموال الزكاة
      - حاشية السندي على سنن الترمذي
      - موسوعة أحكام الطهارة - الدبيان - ط 3
      - الموسوعة القرآنية
      - المدخل في تاريخ السنة
      - تطور كتابة المصحف الشريف وطباعته
      - الأشباه والنظائر - ابن نجيم
      - معجم قبائل المملكة العربية السعودية
      - الدر المنثور في التفسير بالمأثور
      - طبائع الاستبداد ومصارع الاستعباد
      - الفوائد لابن القيم - ط عطاءات العلم
      - موسوعة الأخلاق الإسلامية
      - المدخل إلي جامع الترمذي
      - العلاج والرقى
      - تاريخ القرآن الكريم
      - فتاوى الشبكة الإسلامية
      - دولة الإسلام في الأندلس
      - فتح الباري بشرح البخاري - ط السلفية
      - شرح سنن أبي داود للعباد
      - من شرح بلوغ المرام للطريفي
      - التفسير الموضوعي 2 - جامعة المدينة
      - المفصل فى تاريخ العرب قبل الإسلام
      - الإعلام بأحكام المال الحرام
      - إعانة الطالب في بداية علم الفرائض
      - أسواق العرب في الجاهلية والإسلام
      - منة المنعم في شرح صحيح مسلم
      - شرح الأجرومية للأسمري
      - يسألونك عن الزكاة
      - شرح صحيح ابن خزيمة - الراجحي
      - الآداب الإسلامية
      - الأندلس من الفتح إلى السقوط
      - تهذيب التهذيب - ط دبي
      - شرح بلوغ المرام - اللهيميد
      - العذب النمير من مجالس الشنقيطي في التفسير
      - كيف تربي ولدك
      - القطارة النحوية على المقدمة الآجرومية
      - درر الحكام في شرح مجلة الأحكام
      - مجموعة الوثائق السياسية للعهد النبوي والخلافة الراشدة
      - الأحكام الشرعية المتعلقة بالوباء والطاعون مع دراسة فقهية للأحكام المتعلقة بفيروس كورونا
      - مقالات موقع الدرر السنية
      - التفسير الوسيط - مجمع البحوث
      - تاريخ العرب وحضارتهم في الأندلس
      - متون طالب العلم - المستوى التمهيدي
      - الشفعة بين الجمع العثماني والأحرف السبعة
      - الشورى في الشريعة الإسلامية
      - تحفة الأريب بما في القرآن من الغريب
      - التعريف بالقرآن الكريم
      - موسوعة الملل والأديان
      - شرح الآجرومية - حسن حفظي
      - الميسر في القراءات الأربع عشرة
      - آيات متشابهات الألفاظ في القرآن الكريم وكيف التمييز بينها
      - موجز دائرة المعارف الإسلامية
      - التعريف بالإسلام
      - معجم الصواب اللغوي
      - مختصر تفسير البغوي المسمى بمعالم التنزيل
      - 'تفسير العثيمين: من جزء قد سمع وتبارك - ط مكتبة الطبري'
      - شرح تفسير ابن كثير - الراجحي
      - الداء والدواء = الجواب الكافي - ط دار المعرفة
      - الفتاوى الاقتصادية
      - القواعد الأصولية والفقهية المتعلقة بالمسلم غير المجتهد
      - فقه الأسرة
      - ورد اليوم والليلة
      - معجم الدخيل في اللغة العربية الحديثة ولهجاتها
      - الدرة السنية منظومة في علم الفرائض
      - المال والحكم في الإسلام
      - صحيح الكتب التسعة وزوائده
      - 'تفسير العثيمين: الأحزاب'
      - فتح الكريم المنان في آداب حملة القرآن
      - موسوعة الإعجاز العلمي في القرآن والسنة
      - تيسير أحكام التجويد - المستوى الأول
      - زاد المسير في علم التفسير
      - سبيل المهتدين إلى شرح الأربعين النووية
      - صحيح السيرة النبوية للعلي
      - المعالم الأثيرة في السنة والسيرة
      - 'تفسير العثيمين: فاطر'
      - مرويات السيرة لأكرم العمري
      - عدة الصابرين وذخيرة الشاكرين - ط عطاءات العلم
      - المعاجم المفهرسة لألفاظ القرآن الكريم
      - شرح صحيح البخاري للحويني
      - 'تفسير العثيمين: الشورى'
      - مناسبات الآيات والسور
      - 'تفسير العثيمين: العنكبوت'
      - 'تفسير العثيمين: الزخرف'
      - دراسات في أصول اللغات العربية
      - تاريخ العرب القديم
      - معجزات القرآن العلمية
      - شرح المعتمد في أصول الفقه
      - الوجيز في علم التجويد
      - مسائل مهمات تتعلق بفقه الصوم والتراويح والقراءة على الأموات
      - الأزهر وأثره في النهضة الأدبية الحديثة
      - تفسير أسماء الله الحسنى للزجاج
      - تراجم منتخبة من «التهذيب» و «الميزان» - ضمن «آثار المعلمي»
      - لسان العرب
      - قواعد الفقه
      - الهادي شرح طيبة النشر في القراءات العشر
      - خاتم النبيين صلى الله عليه وآله وسلم
      - البلاغة 2 - المعاني - جامعة المدينة
      - صفوة التفاسير
      - رسائل وفتاوى عبد العزيز آل الشيخ
      - موسوعة القواعد الفقهية
      - غريب الحديث - ابن الجوزي
      - الإمام مسلم وصحيحه
      - الكوكب الدري على جامع الترمذي
      - معجم وتفسير لغوى لكلمات القرآن
      - دراسات في فقه اللغة
      - الفقه الميسر في ضوء الكتاب والسنة
      - فقه العبادات على المذهب الحنفي
      - تيسير العلام شرح عمدة الأحكام
      - المنتخب في تفسير القرآن الكريم
      - المدخل إلى دراسة المدارس والمذاهب الفقهية
      - الموسوعة العقدية
      - أثر اختلاف الأسانيد والمتون في اختلاف الفقهاء
      - الروضة الندية شرح متن الجزرية
      - الطبقات السنية في تراجم الحنفية
      - اللغة وعلم اللغة
      - المسائل الفقهية التي عليها الفتوى عند متأخري الحنفية - جمعا ودراسة-
      - أصول الفقه الذي لا يسع الفقيه جهله
      - التذييل على تهذيب التهذيب
      - الرسول القائد
      - العقد الثمين في شرح منظومة الشيخ ابن عثيمين
      - متون طالب العلم - المستوى الثاني
      - موسوعة المذاهب الفكرية المعاصرة
      - الخلافة
      - إعلام الموقعين عن رب العالمين - ط العلمية
      - الخلاصة الفقهية على مذهب السادة المالكية
      - الإسلام وأوضاعنا القانونية
      - 'تفسير العثيمين: سبأ'
      - 'تفسير العثيمين: المائدة'
      - الأديان الوضعية - جامعة المدينة
      - فتح العلام في دراسة أحاديث بلوغ المرام ط 4
      - القواعد والضوابط الفقهية المتضمنة للتيسير
      - معجم الجرح والتعديل لرجال السنن الكبرى
      - شرح مسند أبي حنيفة
      - البحر المحيط الثجاج في شرح صحيح الإمام مسلم بن الحجاج
      - شرح سنن النسائي المسمى شروق أنوار المنن الكبرى الإلهية بكشف أسرار السنن الصغرى النسائية
      - التوجيه والإرشاد النفسي
      - فقه العبادات على المذهب المالكي
      - الفتاوى الكبرى لابن تيمية
      - متون طالب العلم - الإضافية - 1
      - جمع القرآن الكريم في عهد الخلفاء الراشدين - عبد القيوم السندي
      - محاضرات في علوم الحديث
      - علم الجرح والتعديل
      - موسوعة تفسير الأحلام
      - لمسات بيانية في نصوص من التنزيل - كتاب
      - شرح المقدمة الحضرمية المسمى بشرى الكريم بشرح مسائل التعليم
      - شرح القواعد الفقهية
      - 'تفسير العثيمين: يس'
      - الرقية الشرعية
      - مدرسة الحديث في مصر
      - شرح الأربعين النووية - عبد الكريم الخضير
      - شرح العقيدة الواسطية - الغنيمان
      - التفسير القرآني للقرآن
      - القاموس الفقهي
      - المغني لابن قدامة - ت التركي
      - تفسير ابن رجب الحنبلي
      - صفة الصفوة
      - متون طالب العلم - المستوى الخامس - 2
      - موسوعة مرآة الحرمين الشريفين وجزيرة العرب
      - فتاوى اللجنة الدائمة - المجموعة الأولى
      - جوامع الدعاء
      - تاريخ نزول القرآن
      - تاريخ شبه الجزيرة العربية في عصورها القديمة
      - حياة الصحابة
      - مدخل في علوم القراءات
      - بينات الرسول صلى الله عليه وآله وسلم ومعجزاته
      - موسوعة التفسير المأثور
      - نحو معجم تاريخي للمصطلحات القرآنية المعرفة
      - توفيق الرب المنعم بشرح صحيح الإمام مسلم
      - مجموعة رسائل وفتاوى في مسائل مهمة تمس إليها حاجة العصر
      - شرح مسند الدارمي
      - 'تفسير العثيمين: جزء عم'
      - الإيمان حقيقته، خوارمه، نواقضه عند أهل السنة والجماعة
      - اللغة العربية معناها ومبناها
      - 'تفسير العثيمين: غافر'
      - السرايا والبعوث النبوية حول المدينة ومكة
      - جمهرة الأجزاء الحديثية
      - الإسلام وأوضاعنا السياسية
      - القرآن وإعجازه العلمي
      - متون طالب العلم - الإضافية - 4
      - الكواشف الجلية في حكم قراءة القرآن بالمقامات الموسيقية
      - معالم أصول الفقه عند أهل السنة والجماعة
      - صفحات في علوم القراءات
      - المدخل إلى صحيح البخاري
      - المجالس الفقهية
      - زاد المعاد في هدي خير العباد - ط عطاءات العلم
      - الموسوعة التاريخية
      - شرح سنن أبي داود - الراجحي
      - البديع عند الحريري
      - تقريب التهذيب
      - صحيح الأثر وجميل العبر من سيرة خير البشر (صلى الله عليه وسلم)
      - فقه الدعوة الإسلامية في الغرب ووجوب تجديدها على الحكمة والوسطية والاعتدال
      - متون طالب العلم - الإضافية - 10
      - اللباب في قواعد اللغة وآلات الأدب النحو والصرف والبلاغة والعروض واللغة والمثل
      - شذرات الذهب دراسة في البلاغة القرآنية
      - علم اللغة مقدمة للقارئ العربي
      - شرح التدمرية - محمد بن خليفة التميمي
      - المنهج الحركي للسيرة النبوية
      - شرح عمدة الأحكام لابن جبرين
      - السيرة النبوية - دروس وعبر
      - شرح مقدمة في أصول التفسير لابن تيمية
      - الجامع لكتب الضعفاء والمتروكين والكذابين
      - شرح كتاب الفتن من صحيح البخاري - عبد الكريم الخضير
      - تفسير ابن كثير - ط ابن الجوزي
      - تفسير القرآن الكريم - المقدم
      - البلاغة 1 - البيان والبديع - جامعة المدينة
      - شرح مائة المعاني والبيان
      - الخلاصة البهية في ترتيب أحداث السيرة النبوية
      - الدرر الثرية من الفتاوى البازية
      - فتح الودود في شرح سنن أبي داود
      - علم البديع
      - طريق الهجرتين وباب السعادتين - ط عطاءات العلم
      - المنهل العذب المورود شرح سنن أبي داود
      - الموسوعة القرآنية المتخصصة
      - متون طالب العلم - الإضافية - 8
      - بحوث ومقالات في اللغة
      - إغاثة اللهفان في مصايد الشيطان - ت الفقي
      - منتقى الأذكار
      - الفقه الميسر
      - سلسلة القصص - المنجد
      - الصحاح تاج اللغة وصحاح العربية
      - إكمال تهذيب الكمال - ط العلمية
      - البدهيات في القرآن الكريم
      - القيم الإسلامية
      - المسلمون في بلاد الغربة
      - موسوعة سفير للتاريخ الإسلامي
      - مهمات في أحكام المواريث
      - الفتاوى اليومية من المسائل الفقهية
      - 'تفسير العثيمين: الروم'
      - كيف تحفظ القرآن الكريم
      - مقدمات في علم القراءات
      - فتح المنعم شرح صحيح مسلم
      - الإتقان في ضوابط تسجيل القرآن
      - نزول القران الكريم وتاريخه وما يتعلق به
      - شرح الموطأ - عبد الكريم الخضير
      - موجز عن الفتوحات الإسلامية
      - الاستقصا لأخبار دول المغرب الأقصى
      - الرسالة الندية في القواعد الفقهية
      - فقه الهندسة المالية الإسلامية
      - التربية الإسلامية أصولها ومنهجها ومعلمها
      - موسوعة القبائل العربية
      - تفسير السعدي = تيسير الكريم الرحمن
      - شرح سنن ابن ماجه للهرري = مرشد ذوي الحجا والحاجة إلى سنن ابن ماجه
      - متون طالب العلم - الإضافية - 3
      - المدخل إلى دراسة المذاهب الفقهية
      - التفسير الموضوعي للقرآن الكريم ونماذج منه
      - معجم قبائل العرب القديمة والحديثة
      - محمد صلى الله عليه وسلم
      - فقه الأدعية والأذكار
      - يسألونك عن المعاملات المالية المعاصرة
      - شرح العقيدة الأصفهانية
      - الطبقات الكبرى - ط الخانجي
      - الفقه والشريعة
      - شرح سنن ابن ماجة - الراجحي
      - الجامع في أمثال القرآن
      - سبل السلام من صحيح سيرة خير الأنام عليه الصلاة والسلام
      - موسوعة صناعة الحلال
      - تفسير غريب ما في الصحيحين البخاري ومسلم
      - 'تفسير العثيمين: الفرقان'
      - شرح الترغيب والترهيب للمنذرى - حطيبة
      - خطب مختارة
      - روضة المحبين ونزهة المشتاقين - ط عطاءات العلم
      - الحديث الموضوعي المنهج والتأصيل والتمثيل
      - مدخل إلى علوم الشريعة
      - الإسلام والحكم
      - 'تفسير العثيمين: ص'
      - المعجم الجامع في تراجم المعاصرين
      - البلاغة العربية
      - متون طالب العلم - المستوى الأول
      - الأخلاق في الإسلام
      - الموسوعة الفقهية
      - البحر المديد في تفسير القرآن المجيد
      - علم البيان
      - التشريع الجنائي الإسلامي مقارنا بالقانون الوضعي
      - 'تفسير العثيمين: آل عمران'
      - الأساس في السنة وفقهها - السيرة النبوية
      - التوضيح والبيان لشجرة الإيمان
      - معرفة القراء الكبار على الطبقات والأعصار
      - تفسير البغوي - طيبة
      - فتح القوي المتين في شرح الأربعين وتتمة الخمسين للنووي وابن رجب رحمهما الله
      - علم الفرائض والمواريث في الشريعة الإسلامية والقانون السوري
      - نزول القرآن الكريم والعناية به في عهد الرسول صلى الله عليه وسلم
      - بذل المجهود في حل سنن أبي داود
      - مناهج البحث في العلوم السياسية
      - فتاوى الطب والمرضى
      - متون طالب العلم - الإضافية - 5
      - تفسير الشعراوي
      - برنامجك في رمضان
      - شرح بلوغ المرام - عبد الكريم الخضير
      - علم المعاني
      - المنتخب من وصايا الآباء للأبناء
      - مختصر سيرة الرسول صلى الله عليه وسلم لمحمد بن عبد الوهاب
      - آل الجرباء في التاريخ والأدب
      - البلاغة الصافية في المعاني والبيان والبديع
      - شرح رسالة لطيفة جامعة في أصول الفقه المهمة
      - 'تفسير العثيمين: الصافات'
      - التعريفات الفقهية
      - متون طالب العلم - الإضافية - 6
      - شرح العقيدة السفارينية
      - تاريخ الدولة العلية العثمانية
      - الجامع الصحيح للسيرة النبوية
      - إسعاف الأعيان في أنساب أهل عمان
      - أسرار البيان في التعبير القرآني - كتاب
      - النظام القضائي في الفقه الإسلامي
      - علم اللغة
      - الفتاوى العالمكيرية = الفتاوى الهندية
      - روح البيان
      - اصطلاح المذهب عند المالكية
      - التفسير الوسيط لطنطاوي
      - مجموعة الرسائل والمسائل النجدية (الجزء الرابع، القسم الثاني)
      - فقه عمل اليوم والليلة
      - أصول الإيمان في ضوء الكتاب والسنة
      - الإيمان لابن تيمية
      - شرح العقيدة الطحاوية - عبد العزيز الراجحي
      - 'تفسير العثيمين: الكهف'
      - أصول النحو 1 - جامعة المدينة
      - وجوب تطبيق الشريعة الإسلامية في كل عصر
      - الموسوعة الفقهية الكويتية
      - موسوعة الإجماع في الفقه الإسلامي - ط الفضيلة
      - صحيح سنن أبي داود ط غراس
      - إعراب القرآن الكريم - ط دار الصحابة
      - التفسير النبوي
      - شرح العقيدة الواسطية - العثيمين
      - المغني في ضبط الأسماء لرواة الأنباء
      - كتاب سيرة النبي صلى الله عليه وسلم
      - نور اليقين في سيرة سيد المرسلين
      - لمحات مهمة في الوصية
      - مختصر زاد المعاد
      - العقيدة الصحيحة وما يضادها ونواقض الإسلام
      - المعاجم العربية مع اعتناء خاص بمعجم العين للخليل بن أحمد
      - مقتطفات من السيرة
      - معجم اللغة العربية المعاصرة
      - مدخل إلى تفسير القرآن وعلومه
      - فقه النكاح والفرائض
      - الحافظ العراقي وكتابه تكملة شرح الترمذي - مجلة الهند
      - شرح العقيدة الطحاوية - صالح آل الشيخ = إتحاف السائل بما في الطحاوية من مسائل
      - تفسير الألوسي = روح المعاني
      - سلسلة الآثار الصحيحة أو الصحيح المسند من أقوال الصحابة والتابعين
      - حاشية السندي على سنن النسائي
      - معجم لغة الفقهاء
      - متون طالب العلم - المستوى الخامس - 1
      - مختصر تفسير ابن كثير
      - أوضح التفاسير
      - شرح صحيح ابن حبان - الراجحي
      - التحفة المكية في توضيح أهم القواعد الفقهية
      - تاريخ الخلفاء الراشدين الفتوحات والإنجازات السياسية
      - شرح متن أبي شجاع - محمد حسن عبد الغفار
      - 'تفسير العثيمين: من سورة محمد - ط مكتبة الطبري'
      - تجريد القواعد والفوائد الأصولية
      - شمائل الرسول صلى الله عليه وآله وسلم
      - المنهج التأصيلي لدراسة التفسير التحليلي
      - شرح مقدمة سنن ابن ماجه
      - نظام الإثبات في الفقه الإسلامي
      - الرسالة التبوكية زاد المهاجر إلى ربه - ت غازي
      - شرح كتاب الإيمان الأوسط لابن تيمية - الراجحي
      - موسوعة الأعلام - الأوقاف المصرية
      - الكوكب الوهاج شرح صحيح مسلم بن الحجاج
      - صحيح سنن النسائي
      - شرح اختصار علوم الحديث - اللاحم
      - مختار الصحاح
      - أضواء البيان في إيضاح القرآن بالقرآن - ط عطاءات العلم
      - مجلة الأحكام العدلية
      - أسرار المحبين في رمضان
      - السياسة الشرعية في الشئون الدستورية والخارجية والمالية
      - نزول القرآن على سبعة أحرف
      - دليل الحاج والمعتمر وزائر مسجد الرسول صلى الله عليه وسلم
      - فتاوى عاجلة لمنسوبي الصحة
      - المغالطات المنطقية
      - فقه السنة
      - من قضايا البلاغة والنقد عند عبد القادر الجرجاني
      - مجموعة الرسائل والمسائل النجدية (الجزء الأول)
      - متون طالب العلم - المستوى الثالث
      - متون طالب العلم - المستوى الرابع
      - تفسير القرآن الكريم وإعرابه وبيانه - الدرة
      - فتاوى اللجنة الدائمة - المجموعة الثانية
      - الموسوعة الميسرة في الأديان والمذاهب والأحزاب المعاصرة
      - التحالف السياسي في الإسلام
      title: BookNamesEnum
    TopLogprob:
      properties:
        token:
          type: string
          title: Token
        bytes:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Bytes
        logprob:
          type: number
          title: Logprob
      additionalProperties: true
      type: object
      required:
      - token
      - logprob
      title: TopLogprob
    ChatCompletionChoice-Output:
      properties:
        finish_reason:
          type: string
          enum:
          - stop
          - length
          - tool_calls
          - content_filter
          - function_call
          title: Finish Reason
        index:
          type: integer
          title: Index
        logprobs:
          anyOf:
          - $ref: '#/components/schemas/ChoiceLogprobs-Output'
          - type: 'null'
        message:
          $ref: '#/components/schemas/ChatCompletionChoiceMessage-Output'
      additionalProperties: true
      type: object
      required:
      - finish_reason
      - index
      - message
      title: ChatCompletionChoice
    ChatCompletionContentPartImageParam:
      properties:
        image_url:
          $ref: '#/components/schemas/ImageURL'
        type:
          type: string
          const: image_url
          title: Type
      type: object
      required:
      - image_url
      - type
      title: ChatCompletionContentPartImageParam
    ChatCompletionContentPartRefusalParam:
      properties:
        refusal:
          type: string
          title: Refusal
        type:
          type: string
          const: refusal
          title: Type
      type: object
      required:
      - refusal
      - type
      title: ChatCompletionContentPartRefusalParam
    ToolResultData:
      description: Tool result data
      properties:
        id:
          description: The unique identifier for the tool call
          title: Id
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          description: The name of the tool called
          title: Name
        arguments:
          additionalProperties: true
          description: The arguments passed to the tool
          title: Arguments
          type: object
        result:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          description: The result returned by the tool
          title: Result
        structured_content:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          default: null
          description: The structured content returned by the tool
          title: Structured Content
        is_error:
          default: false
          description: Indicates if there was an error during the tool call
          title: Is Error
          type: boolean
      required:
      - id
      title: ToolResultData
      type: object
    ChatCompletionUserMessageParam:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartVideoParam'
            type: array
          title: Content
        role:
          type: string
          const: user
          title: Role
        name:
          type: string
          title: Name
      type: object
      required:
      - content
      - role
      title: ChatCompletionUserMessageParam
    VideoURL:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: VideoURL
    ImageURL:
      properties:
        url:
          type: string
          title: Url
        detail:
          type: string
          enum:
          - auto
          - low
          - high
          title: Detail
      type: object
      required:
      - url
      title: ImageURL
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: Provide your API key in the Authorization header using the Bearer scheme.