Additional REST API methods

Additional REST API methods

YobiYoba's REST API can also be used to interact with your account. Consult your remaining time, your files, your folders, etc...
Additional methods can be used via the following URL:

• cURL sample

As with the basic methods, the API key must be added as an HTTP "api-key" header.
Additional methods are always returned in JSON format. Returns contain definition structures based on Entity definitions.

Allowed query-string parameters :

• fields : This parameter is used to select the fields to be returned by the REST API.
  If not specified, the default entity fields will be returned.\n The fields value must be a sequence of values separated by a comma (U+002C COMMA, “,”).\n If you request a set of fields for a given entity type, the response will not include the default fields.\n If an entity field is itself an entity, the fields parameter can also be used to select the fields to be returned (sub_entity_field_name.field_name).\n The wildcard char (*) can be used to return all fields.
  
• page : End-points that retrieve a complete list of an Entity type have a paginated result. The page number must therefore be passed as a parameter. If this parameter is not supplied, the default value interpreted is 1.
  
• size : The page size of paginated returns can be modified with this parameter. This parameter has a default value and a maximum value for each compatible method.
  
• log : Allows you to log an API call. The expected value is true (log=true). Log calls can be found on the "Call logs" page.
  

• Sample use of query-string parameters

Entities

Our REST API provides access to various Entities, enabling you to manage your files and your account.

• Pagination : A Pagination object is added to all API endpoints that support pagination features.
• APIKey : Contains information about your API key, such as creation date or key name.
• ExportOption : An ExportOption object is used to define parameters for exporting transcriptions.
• File : Represents an audio file that exists or has existed on your account. A File is created when you send a file from the web interface or when you import a Treatment from the API.
• Folder : Represents a directory created by the user to organize his File.
• Language : A Language object containing information about a language.
• Result : Corresponds to the result of processing available from the web interface. A Result is created when the user executes a process from the web interface or when a Treatment is imported from the API.
• Revision : This is a text revision of a Result, created from the editor.
• Summary : Contains information about a resume generated from Result (and Revision).
• SummaryOption : Object containing the options used to generate a transcript summary
• TimeCounter : This is the user's time counter. It indicates the time available for processing.
• TimeRestriction : Corresponds to a time limit applied to the account by its master account.
• TranslationPair : A TranslationPair object allows you to define a language pair used for translation.
• Treatment : Represents a process executed from an API call. Only calls to the basic API methods (bs_* and cts_*) result in the creation of a Treatement.

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

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

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

APIKey Entity 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 Entity sample #1{
    "format": "pdf"
}                                            

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

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

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

File Entity 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 Entity 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 Entity 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 Entity sample #1{
    "code": "eng",
    "label": "English"
}                                            

Language Entity sample #2{
    "code": "fre",
    "label": "French"
}                                            

Result Entity 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 Entity sample{
    "id": "dBi8",
    "number": 2,
    "dateupdate": "2026-06-18T19:06:53+00:00"
}                                            

Summary Entity 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 Entity sample{
    "include_speakers": true
}                                            

TimeCounter Entity sample{
    "id": "Op",
    "remaining_second": 12.6
}                                            

TimeRestriction Entity 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 Entity sample{
    "from": {
        "code": "eng",
        "label": "English"
    },
    "to": {
        "code": "fre",
        "label": "French"
    }
}                                            

Treatment Entity 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***************"
    }
}                                            

Available end points

API Key

• GET/api/v1/apikeys : Returns the list of your APIKey.
• GET/api/v1/apikeys/{apikey_id[,another_apikey_id,...]} : Returns one or more APIKey according to the given parameters.
• PUT/api/v1/apikey : Updates APIKey data.




Translation Language

• GET/api/v1/translation/pairs : Returns the list of language pairs available for translation.




Files

• GET/api/v1/files : Returns the list of your File.
• GET/api/v1/files/{file_id[,another_file_id,...]} : Returns on or more File according to the given parameters.
• PUT/api/v1/file : Updates File data.
• DELETE/api/v1/file/{file_id} : Permanently deletes a File from your account.
• GET/api/v1/export/files : Exports all Revision of all Result of one or more File in the selected format. If more than one Revision is to be exported, an archive will be generated.




Folders

• GET/api/v1/folders : Returns the list of your Folder.
• GET/api/v1/folders/{folder_id[,another_folder_id,...]} : Returns on or more Folder according to the given parameters.
• PUT/api/v1/folder : Updates Folder data.
• POST/api/v1/folder : Create a Folder
• DELETE/api/v1/folder/{folder_id} : Permanently deletes a Folder.




Available Time

• GET/api/v1/timecounter : Returns your TimeCounter.
• GET/api/v1/account/timerestrictions/ : Return the list of TimeRestriction applied to your account.




Treatment via Basic Methods

• GET/api/v1/treatments : Returns the list of your Treatment.
• GET/api/v1/treatments/{treatment_id[,another_treatment_id,...]} : Returns one or more Treatment according to the given parameters.
• GET/api/v1/archive/treatments : Returns a list of your Treatment that have been archived in our system.
• GET/api/v1/archive/treatments/{treatment_id[,another_treatment_id,...]} : Returns one or more archived Treatment according to the given parameters.
• POST/api/v1/treatments/import : Import one or more Treatment into your File/Result lists.
• GET/api/v1/export/treatments : Export one or more Treatment in the chosen format.




Treatment Results

• GET/api/v1/results : Returns the list of your Result.
• GET/api/v1/results/{result_id[,another_result_id,...]} : Returns one or more Result according to the given parameters.
• GET/api/v1/export/results : Exports all Revision of one or more Result in the selected format.
• DELETE/api/v1/result/{result_id} : Permanently deletes a Result from your account.




Transcription Revisions

• GET/api/v1/export/revisions : Exports one or more Revision in the selected format.




Transcription Summary

• GET/api/v1/summaries : Returns the list of your Summary.
• GET/api/v1/summaries/{summary_id[,another_summary_id,...]} : Returns one or more Summary according to the given parameters.
• POST/api/v1/summary : Request generation of a Summary.

API Key

Manage your API keys

GET /api/v1/apikeys

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

PUT /api/v1/apikey

Translation Language

Access information required to perform translations

GET /api/v1/translation/pairs

Files

Manage your files

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

Folders

Manage your folders

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}

Available Time

Access information about your available time or restrictions on its use.

GET /api/v1/timecounter

GET /api/v1/account/timerestrictions/

Treatment via Basic Methods

Interact with your treatments performed using the basic methods.

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

Treatment Results

Interact with your treatment results, launched via the graphical interface or imported from a treatment.

GET /api/v1/results

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

GET /api/v1/export/results

DELETE /api/v1/result/{result_id}

Transcription Revisions

Interact with the different revisions created when editing a transcription (Result) in the editor.

GET /api/v1/export/revisions

Transcription Summary

Manage your transcription summaries.

GET /api/v1/summaries

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

POST /api/v1/summary