Qodex.ai

API Documentation #reference

Number of APIs: 4

API Endpoints

Read Root

  • Endpoint: /

  • Method: GET

  • Summary: Read Root

  • Operation ID: read_root__get

  • Responses:

    • 200: Successful Response

Health

  • Endpoint: /health

  • Method: GET

  • Summary: Health

  • Operation ID: health_health_get

  • Responses:

    • 200: Successful Response

Readiness Check

  • Endpoint: /ready

  • Method: GET

  • Summary: Readiness Check

  • Operation ID: readiness_check_ready_get

  • Responses:

    • 200: Successful Response

Generate Session Id

  • Endpoint: /generate_session_id

  • Method: POST

  • Summary: Generate Session Id

  • Operation ID: generate_session_id_generate_session_id_post

  • Responses:

    • 200: Successful Response

Get Similars

  • Endpoint: /similars

  • Method: POST

  • Summary: Get Similars

  • Operation ID: get_similars_similars_post

  • Request Body:

    • Content Type: application/json
    • { question: string, session_id: string, model_name: string or null}

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

Get Chat History

  • Endpoint: /chat_history

  • Method: GET

  • Summary: Get Chat History

  • Operation ID: get_chat_history_chat_history_get

  • Parameters:

    • session_id (query): string (required)

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

Clear Chat History

  • Endpoint: /chat_history

  • Method: DELETE

  • Summary: Clear Chat History

  • Operation ID: clear_chat_history_chat_history_delete

  • Parameters:

    • session_id (query): string (required)

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

  1. Chat history - Get chat history GET https://abowfzl.com/api/chat_history?session_id=9af76196-55ff-00d5-11a7-81ed640ad23c

  2. Chat history - Clear chat history DELETE https://abowfzl.com/api/chat_history?session_id=9af76196-55ff-00d5-11a7-81ed640ad23c

  3. Similar - Get similar POST https://abowfzl.com/api/similars?question= "میخوام به کویر سفر کنم، کجا را پیشنهاد میدی؟"&session_id="9af76196-55ff-00d5-11a7-81ed640ad23c"

  4. Session Id - Generate session Id POST https://abowfzl.com/api/generate_session_id