GET
/api/v1/alttexts
Generiert für ein als URL übergebenes Bild einen Alternativtext.
Autorisierung
notwendig
Parameter
| Name | Datentyp | Beschreibung |
|---|---|---|
| model | string | zu verwendendes LLM, mögliche Optionen siehe GET /api/v1/models |
| url | string |
Pfad zu einer Bilddatei, die Adresse muss öffentlich zugänglich sein und ein Bild in einem unterstützten Format enthalten Hinweis: Je größer das übergebene Bild ist, umso länger dauert die Verarbeitung, auch wenn sich die Qualität des generierten Texts nicht mehr verbessert. Das übergebene Bild darf daher eine maximale Kantenlänge von 512 Pixeln nicht überschreiten. |
| language | string | Sprache (de, en) |
| caption | string | Bildunterschrift, die beispielsweise auf dem Foto abgebildete Personen oder Orte benennt |
Beispiel
GET /api/v1/alttexts?url=https%3A//www.wegewerk.com/fileadmin/_processed_/f/2/csm_250918_wissenswerk_einleitung_2fd0defc45.jpg&language=de&caption=Juri+Maier
Antwort-Status
{
"remote-ip": "127.0.0.1",
"status": "OK",
"alttext": "Juri Maier steht vor einer Gruppe von Menschen in einem Raum mit Bildern an der Wand. Er h\u00e4lt ein Blatt Papier und spricht, w\u00e4hrend die Zuh\u00f6rer aufmerksam zuh\u00f6ren.",
"duration": 13.812115207
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "submitted data is not valid JSON"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Unauthorized"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Not enough credits",
"credits": {
"total": "200",
"remaining": "0",
"valid_from": "2025-01-01",
"valid_until": "2025-01-30"
}
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authentication required"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authorization malformatted"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "image too large: 2000px x 2000px, max size: 512px x 512px"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "unsupported image type: application\/octet-stream"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "[language] must be one of: {de,en}"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "missing parameter: [url]"
}
POST
/api/v1/alttexts
Generiert für ein übergebenes Bild einen Alternativtext.
Autorisierung
notwendig
Parameter
| Name | Datentyp | Beschreibung |
|---|---|---|
| model | string | zu verwendendes LLM, mögliche Optionen siehe GET /api/v1/models |
| image | string |
Binärdaten einer Bilddatei, base64-codiert Hinweis: Je größer das übergebene Bild ist, umso länger dauert die Verarbeitung, auch wenn sich die Qualität des generierten Texts nicht mehr verbessert. Das übergebene Bild sollte daher eine maximale Kantenlänge von 512 Pixeln nicht überschreiten. |
| language | string | Sprache (de, en), Default: de |
| caption | string | Bildunterschrift, die beispielsweise auf dem Foto abgebildete Personen oder Orte benennt |
Beispiel
{
"model": "mistral-small3.2:latest",
"image": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAAAKnRFWHRDcmVhdGlvbiBUaW1lAERvIDIgT2t0IDIwMjUgMTY6MjY6NTIgKzAxMDCmjMTcAAAAB3RJTUUH6QoCDhsMtziaewAAAAlwSFlzAAALEgAACxIB0t1+\/AAAAARnQU1BAACxjwv8YQUAAAAGdFJOUwD\/AP8A\/zdYG30AAAIVSURBVHja7dJBDcAgAMBAmD98IRsTa0jInYI+OsfaA\/723Q7gTcYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEsYiYSwSxiJhLBLGImEsEgd8NwJlydAVwAAAAABJRU5ErkJggg==",
"language": "de"
}
Antwort-Status
{
"remote-ip": "127.0.0.1",
"status": "OK",
"alttext": "Einfarbiges blaues Rechteck.",
"duration": 2.959546149
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "submitted data is not valid JSON"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Unauthorized"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Not enough credits",
"credits": {
"total": "200",
"remaining": "0",
"valid_from": "2025-01-01",
"valid_until": "2025-01-30"
}
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authentication required"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authorization malformatted"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "image too large: 2000px x 2000px, max size: 512px x 512px"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "unsupported image type: application\/octet-stream"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "[language] must be one of: {de,en}"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "missing parameter: [image]"
}