Api

Welche Endpunkte gibt es?

/api/get_queries/

Dieser Endpunkt gibt eine Liste von Arrays zurück, welche die Queries enthalten.

[
  {
    "query_id": "17",
    "user_id": "16",
    "content": "sadsadad"
  },
  {
    "query_id": "18",
    "user_id": "16",
    "content": "Erkläre den Plot von Titanic in nur einem Satz"
  },
  {
    "query_id": "19",
    "user_id": "16",
    "content": "Erkläre den Plot von Star Wars"
  }
]

/api/get_tokens/

Dieser Endpunkt gibt bei übergabe des Keys die Anzahl der aktuell verbleibenden Tokens zurück.

[
  {
    "tokens": "1475"
  }
]

/api/ask_chatgpt/

[
  {
    "sucess": "Deine Antwort"
  }
]

Dieser Endpunkt gibt bei übergabe einer zustätzlichen query_id eine Antwort zurück. Die Query_id wird aus dem call von get queries ausgelesen.

Wie funktioniert die Kommunikation?

Die Kommunikation erfolgt über HTTP POST Requests. Die Daten werden als JSON übertragen. Jeder Call benötigt einen Token, welcher aus der Serverseitigen Anwendung generiert wird. Der api key wird dann als Teil des request bodys eingebettet. ‘api_key’

Weitere Informationen

Die API Dokumentation ist im Ordner tests hinterlegt. Dort befinden sich http files, welche in einen http client eingespeist werden können, um die jeweiligen calls zu generieren.

Fehler 

Die Implementierung der Api ist fail-fast und gibt bei einer Falschen eingabe eine 401 zurück. Außerdem wird die Fehlermeldung ausgegeben.