Zusätzliche REST API-Methoden

Zusätzliche REST API-Methoden

Die REST API von YobiYoba kann auch zur Interaktion mit Ihrem Konto verwendet werden. Überprüfen Sie Ihre verbleibende Zeit, Ihre Dateien, Ihre Ordner, etc...
Zusätzliche Methoden können über folgende URL verwendet werden:

• cURL-Beispiel

Wie bei den Grundmethoden muss der API-Schlüssel als HTTP-"api-key"-Header hinzugefügt werden.
Zusätzliche Methoden werden immer im JSON-Format zurückgegeben. Rückgaben enthalten Definitionsstrukturen basierend auf Entität-Definitionen.

Erlaubte Query-String-Parameter:

• fields : Dieser Parameter wird verwendet, um die Felder auszuwählen, die von der REST-API zurückgegeben werden sollen.
  Wenn nichts angegeben ist, werden die Standard-Entitätsfelder zurückgegeben.\n Der Wert „fields” muss eine durch Kommas (U+002C COMMA, „,”) getrennte Folge von Werten sein.\n Wenn Sie eine Reihe von Feldern für einen bestimmten Entitätstyp anfordern, enthält die Antwort keine Standardfelder.\n Wenn ein Entitätsfeld selbst eine Entität ist, kann der Parameter „fields” auch zur Auswahl der zurückzugebenden Felder verwendet werden (sub_entity_field_name.field_name).\n Mit dem Platzhalterzeichen (*) können alle Felder zurückgegeben werden.
  
• page : Endpunkte, die eine vollständige Liste eines Typs Entität abrufen, liefern ein paginiertes Ergebnis. Die Seitenzahl muss daher als Parameter übergeben werden. Wenn dieser Parameter nicht angegeben wird, wird der Standardwert 1 interpretiert.
  
• size : Die Seitengröße von paginierten Rückgaben kann mit diesem Parameter geändert werden. Dieser Parameter hat einen Standardwert und einen Maximalwert für jede kompatible Methode.
  
• log : Ermöglicht die Protokollierung eines API-Aufrufs. Der erwartete Wert ist true (log=true). Protokollierte Aufrufe finden Sie auf der Seite „Anrufprotokolle“.
  

• Beispiel für die Verwendung von Query-String-Parametern

Entitäten

Unsere REST-API bietet Zugriff auf verschiedene Entitäten, mit denen Sie Ihre Dateien und Ihr Konto verwalten können.

• Pagination : Ein Pagination-Objekt wird zu allen API-Endpunkten hinzugefügt, die Pagination-Funktionen unterstützen.
• APIKey : Enthält Informationen zu Ihrem API-Schlüssel, wie z. B. das Erstellungsdatum oder den Schlüsselnamen.
• ExportOption : Ein ExportOption-Objekt wird verwendet, um Parameter für den Export von Transkriptionen zu definieren.
• File : Stellt eine Audiodatei dar, die in Ihrem Konto vorhanden ist oder war. Eine Datei wird erstellt, wenn Sie eine Datei über die Weboberfläche senden oder wenn Sie eine Bearbeitung über die API importieren.
• Folder : Stellt ein vom Benutzer erstelltes Verzeichnis zur Organisation seiner Dateien dar.
• Language : Ein Sprache-Objekt, das Informationen über eine Sprache enthält.
• Result : Entspricht dem Ergebnis der Verarbeitung, das über die Webschnittstelle verfügbar ist. Ein Ergebnis wird erstellt, wenn der Benutzer einen Prozess über die Webschnittstelle ausführt oder wenn eine Behandlung über die API importiert wird.
• Revision : Dies ist eine Textüberarbeitung eines Ergebnisses, die vom Editor erstellt wurde.
• Summary : Enthält Informationen zu einem Lebenslauf, der aus dem Ergebnis (und der Überarbeitung) generiert wurde.
• SummaryOption : Objekt, das die Optionen enthält, die zum Erstellen einer Zusammenfassung des Transkripts verwendet werden
• TimeCounter : Dies ist der Zeitzähler des Benutzers. Er gibt die für die Verarbeitung verfügbare Zeit an.
• TimeRestriction : Entspricht einer zeitlichen Begrenzung, die vom Hauptkonto für das Konto festgelegt wurde.
• TranslationPair : Mit einem TranslationPair-Objekt können Sie ein Sprachpaar definieren, das für die Übersetzung verwendet wird.
• Treatment : Stellt einen Prozess dar, der über einen API-Aufruf ausgeführt wird. Nur Aufrufe der grundlegenden API-Methoden (bs_* und cts_*) führen zur Erstellung einer Behandlung.

Pagination Entität sample #1{
    "current": "<url_current>",
    "last": "<url_last_page>",
    "next": "<url_next_page>"
}                                            

Pagination Entität sample #2{
    "current": "<url_current>",
    "last": "<url_last_page>",
    "previous": "<url_previous_page>"
}                                            

Pagination Entität sample #3{
    "current": "<url_current>",
    "last": "<url_last_page>",
    "previous": "<url_previous_page>",
    "next": "<url_next_page>"
}                                            

APIKey Entität sample{
    "id": "YG",
    "name": "Documentation team's key",
    "creation_date": "2026-06-18T19:06:53+00:00",
    "deactivation_date": null,
    "expiration_date": "2027-12-18T07:06:53+00:00",
    "key": "rNFg7Gu***************",
    "state": 0
}                                            

ExportOption Entität sample #1{
    "format": "pdf"
}                                            

ExportOption Entität sample #2{
    "format": "pdf",
    "options": [
        "include_speakername",
        "include_timecode"
    ]
}                                            

ExportOption Entität sample #3{
    "format": "pdf",
    "options": [
        "include_speakername",
        "include_timecode",
        "merge_transcription",
        "add_title"
    ],
    "title": "Export Title"
}                                            

ExportOption Entität sample #4{
    "format": "pdf",
    "options": [
        "translation"
    ],
    "translation_pairs": [
        {
            "from": {
                "code": "eng"
            },
            "to": {
                "code": "fre"
            }
        }
    ]
}                                            

File Entität sample{
    "id": "VO",
    "originalname": "My_File_1.mp3",
    "displayablename": "",
    "name": "0e2f5fb315d0-0000007f-0000007f-6e5e-d6c65ac081d4d7fdf252e4624b55de96",
    "creationdate": "2026-06-18T19:06:53+00:00",
    "duration": 2340,
    "bytes": 10240,
    "process_state": 3,
    "deleted": true,
    "folder": {
        "id": "PQ",
        "name": "My directory 1"
    },
    "results": []
}                                            

Folder Entität sample #1{
    "id": "PQ",
    "parentId": null,
    "name": "My directory 1",
    "children": [
        {
            "id": "81",
            "name": "My sub-directory of My directory 1"
        }
    ],
    "files": [
        {
            "id": "7YrV",
            "originalname": "Interview 5 - Membre du collectif 3.MP3",
            "name": "0eb32ca6dc5e-00000025-00000059-21f1-0fb103bcc7e1311871181f371a4d30d2"
        },
        {
            "id": "4pk",
            "originalname": "Interview 4 - YP.MP3",
            "name": "0e7fa3020e60-00000025-000000b9-1c40-a30c7d41c203590a24e0c26a4bb1080c"
        },
        {
            "id": "kkV",
            "originalname": "Interview 3 - Maire.MP3",
            "name": "0e78fe03f375-00000025-00000059-3cdd-b20aa537dcead286176b2fe27b4419d6"
        }
    ]
}                                            

Folder Entität sample #2{
    "id": "81",
    "parentId": "PQ",
    "name": "My sub-directory of My directory 1",
    "children": [],
    "files": [
        {
            "id": "wJM5",
            "originalname": "Entretien 4 - ALD.MP3",
            "name": "0eb58f4afda1-00000025-00000059-7ea8-c9d50353afcf93f4440b90baba4e260b"
        },
        {
            "id": "Kw1o",
            "originalname": "Entretien 1 - VR.MP3",
            "name": "0eb32ed751a7-00000025-00000059-243f-a35a0b22392e808b9c41ea7b5778b0c7"
        },
        {
            "id": "Lem1",
            "originalname": "Entretien 2 - B.MP3",
            "name": "0eb32ea5ae90-00000025-00000059-2501-3d85ee94f49af165d1019da633440570"
        },
        {
            "id": "j9PP",
            "originalname": "Entretien 3 - AL.MP3",
            "name": "0eb414a2587f-00000025-00000059-7193-0a7d9cfa0bb67068acc4f293a45f920a"
        }
    ]
}                                            

Language Entität sample #1{
    "code": "eng",
    "label": "English"
}                                            

Language Entität sample #2{
    "code": "fre",
    "label": "French"
}                                            

Result Entität sample{
    "id": "mv",
    "datestart": "2026-06-18T19:06:33+00:00",
    "dateend": "2026-06-18T19:06:53+00:00",
    "deleted": true,
    "process_state": 2,
    "spokenduration": 157,
    "signalduration": 234,
    "file": {
        "id": "VO",
        "originalname": "My_File_1.mp3",
        "name": "0e2f5fb315d0-0000007f-0000007f-6e5e-d6c65ac081d4d7fdf252e4624b55de96"
    },
    "treatment": {
        "id": "Xn",
        "filename": "My_File_1.mp3",
        "in_process": true
    },
    "revisions": null,
    "summaries": null
}                                            

Revision Entität sample{
    "id": "dBi8",
    "number": 2,
    "dateupdate": "2026-06-18T19:06:53+00:00"
}                                            

Summary Entität sample{
    "id": "KG6",
    "creation_date": "2025-01-23T17:30:00+00:00",
    "title": "Conversation between two people.",
    "text": "Alice and Mark discussed their weekend plans. Alice suggested going hiking, while Mark preferred a movie night because the weather forecast predicted rain. They agreed to check the weather on Saturday morning and decide then.",
    "language": "eng",
    "process_state": 2,
    "progression": 1,
    "deleted": false,
    "result": {
        "id": "mv"
    }
}                                            

SummaryOption Entität sample{
    "include_speakers": true
}                                            

TimeCounter Entität sample{
    "id": "Op",
    "remaining_second": 12.6
}                                            

TimeRestriction Entität sample{
    "minutes_used": 25,
    "minutes_limit": 600,
    "period_start": "2026-06-18T00:00:00+00:00",
    "period_end": "2026-07-18T00:00:00+00:00",
    "period_type": "monthly"
}                                            

TranslationPair Entität sample{
    "from": {
        "code": "eng",
        "label": "English"
    },
    "to": {
        "code": "fre",
        "label": "French"
    }
}                                            

Treatment Entität sample{
    "id": "Xn",
    "filename": "My_File_1.mp3",
    "sessionId": "60182c65-7f000101-567a",
    "datestart": "2026-06-18T19:06:33+00:00",
    "dateend": "2026-06-18T19:06:53+00:00",
    "language": "eng",
    "type": "brodcast",
    "in_process": true,
    "error_message": null,
    "results": [],
    "apikey": {
        "id": "YG",
        "name": "Documentation team's key",
        "key": "rNFg7Gu***************"
    }
}                                            

Verfügbare Endpunkte

API-Schlüssel

• GET/api/v1/apikeys : Gibt die Liste Ihrer APIKey zurück.
• GET/api/v1/apikeys/{apikey_id[,another_apikey_id,...]} : Gibt einen oder mehrere APIKey gemäß den angegebenen Parametern zurück.
• PUT/api/v1/apikey : Aktualisiert APIKey-Daten.




Übersetzungssprache

• GET/api/v1/translation/pairs : Gibt die Liste der für die Übersetzung verfügbaren Sprachpaare zurück.




Dateien

• GET/api/v1/files : Gibt die Liste Ihrer Dateien zurück.
• GET/api/v1/files/{file_id[,another_file_id,...]} : Gibt eine oder mehrere Dateien gemäß den angegebenen Parametern zurück.
• PUT/api/v1/file : Aktualisiert Dateidaten.
• DELETE/api/v1/file/{file_id} : Löscht eine Datei dauerhaft aus Ihrem Konto.
• GET/api/v1/export/files : Exportiert alle Revisionen aller Ergebnisse einer oder mehrerer Dateien im ausgewählten Format. Wenn mehr als eine Revision exportiert werden soll, wird ein Archiv erstellt.




Ordner

• GET/api/v1/folders : Gibt die Liste Ihrer Ordner zurück.
• GET/api/v1/folders/{folder_id[,another_folder_id,...]} : Gibt einen oder mehrere Ordner gemäß den angegebenen Parametern zurück.
• PUT/api/v1/folder : Aktualisiert Ordnerdaten.
• POST/api/v1/folder : Ordner erstellen
• DELETE/api/v1/folder/{folder_id} : Löscht einen Ordner dauerhaft.




Verfügbare Zeit

• GET/api/v1/timecounter : Gibt Ihren TimeCounter zurück.
• GET/api/v1/account/timerestrictions/ : Gibt die Liste der für Ihr Konto geltenden Zeitbeschränkungen zurück.




Behandlung mit grundlegenden Methoden

• GET/api/v1/treatments : Gibt die Liste Ihrer Behandlungen zurück.
• GET/api/v1/treatments/{treatment_id[,another_treatment_id,...]} : Gibt eine oder mehrere Behandlungen gemäß den angegebenen Parametern zurück.
• GET/api/v1/archive/treatments : Gibt eine Liste Ihrer Behandlungen zurück, die in unserem System archiviert wurden.
• GET/api/v1/archive/treatments/{treatment_id[,another_treatment_id,...]} : Gibt eine oder mehrere archivierte Behandlungen gemäß den angegebenen Parametern zurück.
• POST/api/v1/treatments/import : Importiert eine oder mehrere Behandlungen in Ihre Datei-/Ergebnislisten.
• GET/api/v1/export/treatments : Exportieren Sie eine oder mehrere Behandlungen im ausgewählten Format.




Behandlungsergebnisse

• GET/api/v1/results : Gibt die Liste Ihrer Ergebnisse zurück.
• GET/api/v1/results/{result_id[,another_result_id,...]} : Gibt ein oder mehrere Ergebnisse gemäß den angegebenen Parametern zurück.
• GET/api/v1/export/results : Exportiert alle Revisionen eines oder mehrerer Ergebnisse im ausgewählten Format.
• DELETE/api/v1/result/{result_id} : Löscht ein Ergebnis dauerhaft aus Ihrem Konto.




Transkriptionsrevisionen

• GET/api/v1/export/revisions : Exportiert eine oder mehrere Revisionen im ausgewählten Format.




Transkriptionszusammenfassung

• GET/api/v1/summaries : Gibt die Liste Ihrer Zusammenfassungen zurück.
• GET/api/v1/summaries/{summary_id[,another_summary_id,...]} : Gibt eine oder mehrere Zusammenfassungen gemäß den angegebenen Parametern zurück.
• POST/api/v1/summary : Erstellung einer Zusammenfassung anfordern.

API-Schlüssel

Verwalten Sie Ihre API-Schlüssel

GET /api/v1/apikeys

GET /api/v1/apikeys/{apikey_id[,another_apikey_id,...]}

PUT /api/v1/apikey

Übersetzungssprache

Zugriff auf Informationen, die für die Durchführung von Übersetzungen erforderlich sind

GET /api/v1/translation/pairs

Dateien

Verwalten Sie Ihre Dateien

GET /api/v1/files

GET /api/v1/files/{file_id[,another_file_id,...]}

PUT /api/v1/file

DELETE /api/v1/file/{file_id}

GET /api/v1/export/files

Ordner

Verwalten Sie Ihre Ordner

GET /api/v1/folders

GET /api/v1/folders/{folder_id[,another_folder_id,...]}

PUT /api/v1/folder

POST /api/v1/folder

DELETE /api/v1/folder/{folder_id}

Verfügbare Zeit

Informationen zu Ihrer verfügbaren Zeit oder Einschränkungen hinsichtlich ihrer Nutzung abrufen.

GET /api/v1/timecounter

GET /api/v1/account/timerestrictions/

Behandlung mit grundlegenden Methoden

Interagieren Sie mit Ihren Behandlungen, die mit den grundlegenden Methoden durchgeführt wurden.

GET /api/v1/treatments

GET /api/v1/treatments/{treatment_id[,another_treatment_id,...]}

GET /api/v1/archive/treatments

GET /api/v1/archive/treatments/{treatment_id[,another_treatment_id,...]}

POST /api/v1/treatments/import

GET /api/v1/export/treatments

Behandlungsergebnisse

Interagieren Sie mit Ihren Behandlungsergebnissen, die über die grafische Benutzeroberfläche gestartet oder aus einer Behandlung importiert wurden.

GET /api/v1/results

GET /api/v1/results/{result_id[,another_result_id,...]}

GET /api/v1/export/results

DELETE /api/v1/result/{result_id}

Transkriptionsrevisionen

Interagieren Sie mit den verschiedenen Revisionen, die beim Bearbeiten einer Transkription (Ergebnis) im Editor erstellt wurden.

GET /api/v1/export/revisions

Transkriptionszusammenfassung

Verwalten Sie Ihre Transkriptionszusammenfassungen.

GET /api/v1/summaries

GET /api/v1/summaries/{summary_id[,another_summary_id,...]}

POST /api/v1/summary