Calvinist Parrot

API Documentation: Parrot-QA Endpoint

Endpoint URL

https://calvinistparrot.com/api/parrot-qa

Overview

This API endpoint provides a structured question-and-answer service based on Christian theological perspectives. The endpoint processes user questions through categorization, reasoning, and review phases, synthesizing responses to theological and doctrinal queries. It supports multiple denominational modes to cater to various theological traditions. However, we will not compromise on the following essential doctrines:

Chat Endpoint

If you would like to use the Calvinist Parrot for your chat app. Please read the Parrot Chat API documentation.

How It Works

Request Body

The API expects a JSON object with the following fields:

Response Format

The API returns a streamed response with multiple stages, each represented as JSON objects:

  1. Progress Updates: 
    {"type":"progress","message":"[Status message]"}
  2. Categorization: 
    {"type":"categorization","data":{"category":"[Category]","subcategory":"[Subcategory]","issue_type":"[Type]"}}
  3. Agent Responses: 
    {"type":"agent_responses","data":{"first_answer":"[Agent 1's answer]","second_answer":"[Agent 2's answer]","third_answer":"[Agent 3's answer]"}}
  4. Calvin Review: 
    {"type":"calvin_review","content":"[Calvin's synthesized review]"}
  5. Reviewed Answer (Streamed): 
    {"type":"reviewed_answer","content":"[Final synthesized answer]"}

Reviewer Agent

So far, the API has one reviewer agent named Calvin. (Not for nothing this website is called Calvinist Parrot, hehe.)

Example Usage

This is the exact same way the API is used in the homepage of this website.

Request

POST https://calvinistparrot.com/api/parrot-qa
Content-Type: application/json

{
    "question": "Who is God?",
    "mode": "reformed-baptist"
}

Response

{"type":"progress","message":"Understanding question..."}
{"type":"categorization","data":{"reformatted_question":"No reformatting needed","category":"Theology","subcategory":"Doctrine of God (Theology Proper)","issue_type":"Primary"}}
{"type":"progress","message":"Asking the Counsel of Three..."}
{"type":"agent_responses","data":{"first_answer":"God is the creator of everything. He is all-powerful, all-knowing, and always present. He is loving, holy, and just.","second_answer":"God is the Creator of everything, existing as one God in three persons: the Father, the Son (Jesus Christ), and the Holy Spirit. He is holy, loving, and just. God is sovereign, meaning He has control over all things, and He is unchanging in His character. We can know Him through Scripture, which reveals His nature and His relationship with humanity. Through Jesus, we see God's love and grace, as He came to save us from our sins.","third_answer":"God is the Creator of all things, entirely sovereign, and supreme in power and authority. He is holy, loving, just, and merciful. God reveals Himself in the Bible and through creation, inviting us to know Him and live according to His will."}}
{"type":"progress","message":"Calvin is reviewing the answers..."}
{"type":"calvin_review","content":"All three answers provide a good understanding of who God is, but let’s clarify a few points.

1. **God as Creator**: All answers correctly state that God is the Creator of everything. This is foundational.

2. **God's Nature**: They all mention God's attributes—His holiness, love, justice, and mercy. This is important because it shows His character.

3. **The Trinity**: Agent B uniquely mentions the Trinity, which is essential in understanding God as one being in three persons: Father, Son, and Holy Spirit. This is a key doctrine in Christianity.

4. **Sovereignty**: Agent C emphasizes God's sovereignty, which means He is in control of all things. This is crucial for understanding His power and authority.

5. **Revelation**: All answers mention that God reveals Himself through the Bible and creation, which is vital for knowing Him.

To reflect on these answers, consider these questions:
- How does understanding God as a loving Father change your view of Him?
- Why is it important to recognize God’s sovereignty in our lives?
- How does the concept of the Trinity help us understand the relationship between God and humanity?

These reflections can deepen your understanding of God."}
{"type":"progress","message":"Synthesizing final answer..."}
{"type":"reviewed_answer","content":""}
{"type":"reviewed_answer","content":"God"}
{"type":"reviewed_answer","content":" is"}
{"type":"reviewed_answer","content":" the"}
{"type":"reviewed_answer","content":" Creator"}
{"type":"reviewed_answer","content":" of"}
{"type":"reviewed_answer","content":" everything"}
.
.
.

Explanation

As you can see, the API processes the question, categorizes it, generates responses from three agents, reviews the answers, and synthesizes a final response based on the theological perspective. The final answer is streamed in real-time for a dynamic user experience.

You can look here to see an example on how I implemented the front-end.

Modes

The endpoint supports the following modes:

  1. Reformed Baptist (default)
  2. Presbyterian
  3. Wesleyan
  4. Lutheran
  5. Anglican
  6. Pentecostal/Charismatic
  7. Non-Denominational Evangelical

Each mode tailors its responses according to distinct theological perspectives on secondary issues while sharing a common foundation on core doctrines.

Reformed Baptist

Notes

  1. This API uses OpenAI's 4o models to generate responses.
  2. All interactions are logged in a database for question history tracking.
  3. The endpoint streams responses in real-time for a dynamic user experience.

Contact

For further questions or support, please reach out!

This is open source, so if you're interested in helping me development this, check out the GitHub repo.

Freely you have received; freely give.

Soli Deo Gloria

Calvinist Parrot