Skip to content

API Reference

app

API Gateway for Solver Service.

root 

root() -> dict

Get API information and metadata.

Returns:

Name Type Description
dict dict

Dictionary containing API name, version, description, documentation link, environment, developer info, and contact details.
Source code in src/api/app.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
@app.get("/")
def root() -> dict:
    """Get API information and metadata.

    Returns:
        dict: Dictionary containing API name, version, description, documentation
              link, environment, developer info, and contact details.
    """
    return {
        "API Name": "Automated Reasoning API",
        "API Version": __version__,
        "Description": "An automated reasoning API (FastAPI Framework) via IP, CSP and search algorithms.",
        "Documentation": "https://giraycoskun.github.io/automated-reasoning-api/",
        "Environment": ENVIRONMENT,
        "Developer": "giraycoskun",
        "Contact": "giraycoskun.dev@gmail.com",
    }

ping async 

ping() -> str

Health check endpoint.

Returns:

Name Type Description
str str

"pong" response to indicate the API is running and healthy.
Source code in src/api/app.py 
58
59
60
61
62
63
64
65
@app.get("/ping")
async def ping() -> str:
    """Health check endpoint.

    Returns:
        str: "pong" response to indicate the API is running and healthy.
    """
    return "pong"