{{ t('intro.title') }}

{{ t('intro.desc') }}

{{ t('intro.auth_title') }}

{{ t('intro.auth_desc') }}

Authorization: Bearer <YOUR_API_KEY>

{{ t('lang.title') }}

{{ t('lang.source') }} (From)

{{ l }}

{{ t('lang.target') }} (To)

{{ l }}
POST

{{ t('api.create.title') }}

/external/translations

{{ t('api.create.desc') }}

Header

  • Authorization: Bearer API_KEY
  • Content-Type: multipart/form-data

Body Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
file File {{ t('req.one_of') }} {{ t('api.create.p_file') }}
fileURL String {{ t('req.one_of') }} {{ t('api.create.p_fileURL') }}
from String {{ t('req.yes') }} {{ t('api.create.p_from') }}
to String {{ t('req.yes') }} {{ t('api.create.p_to') }}
engine String {{ t('req.yes') }} {{ t('api.create.p_engine') }}
model String {{ t('req.yes') }} {{ t('api.create.p_model') }}
name String {{ t('req.no') }} {{ t('api.create.p_name') }}
spaceId String {{ t('req.no') }} {{ t('api.create.p_spaceId') }}
useGlossary Boolean {{ t('req.no') }} {{ t('api.create.p_useGlossary') }}
imageTranslate Boolean {{ t('req.no') }} {{ t('api.create.p_img') }}
notifyURL String {{ t('req.no') }} {{ t('api.create.p_notify') }}

Response Example

{
    "notifyCount": 0,
    "id": "U5ed3DGTif2Ig",
    "spaceId": "<your_space_id>",
    "type": "translation",
    "status": "initial",
    "params": {
        "key": "2026-04/f5/f5045847-fdec-4cf2-a58b-8485b367c468.pptx",
        "hash": "<file_hash>",
        "bytes": 36863,
        "name": "API Call Test Task Name",
        "engine": "gemini",
        "model": "gemini-flash",
        "from": "zh",
        "to": "en",
        "useGlossary": false,
        "imageTranslate": false,
        "notifyURL": "https://your.domain/notify/callback"
    },
    "creatorId": "<user_id>",
    "notifyURL": "https://your.domain/notify/callback",
    "updatedAt": "2026-04-23T09:05:16.486Z",
    "createdAt": "2026-04-23T09:05:16.486Z"
}
GET

{{ t('api.get_gen.title') }}

/external/tasks/:id

{{ t('api.get_gen.desc') }}

Header

  • Authorization: Bearer API_KEY

Path Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
idString{{ t('req.yes') }}{{ t('api.get_gen.p_id') }}

Response Example

{
    "id": "U5ed3DGTif2Ig",
    "spaceId": "<your_space_id>",
    "type": "translation",
    "status": "success",
    "error": null,
    "progress": 100,
    "params": {
        "to": "en",
        "key": "2026-04/f5/f5045847-fdec-4cf2-a58b-8485b367c468.pptx",
        "from": "zh",
        "hash": "<file_hash>",
        "name": "API call test task name",
        "bytes": 36863,
        "model": "gemini-flash",
        "engine": "gemini",
        "notifyURL": "https://your.domain/notify/callback",
        "useGlossary": false,
        "imageTranslate": false
    },
    "consumedMS": 5944,
    "receivedAt": null,
    "notifyURL": "https://your.domain/notify/callback",
    "notifyCount": 6,
    "creatorId": "<user_id>",
    "createdAt": "2026-04-23T09:05:16.000Z",
    "updatedAt": "2026-04-23T09:05:22.000Z"
}
GET

{{ t('api.get.title') }}

/external/translations/:id/result

{{ t('api.get.desc') }}

Header

  • Authorization: Bearer API_KEY

Path Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.desc') }}
id String {{ t('api.get.p_id') }}

Response Example (Finished)

{
    "downloadURL": "https://.../result.pptx",
    "bytes": 34483,
    "md5": "<file_md5_hash>"
}
POST

{{ t('api.create_gen.title') }}

/external/generations

{{ t('api.create_gen.desc') }}

Header

  • Authorization: Bearer API_KEY
  • Content-Type: multipart/form-data

Body Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
inputTextString{{ t('req.one_of') }}{{ t('api.create_gen.p_inputText') }}
filesFile{{ t('req.one_of') }}{{ t('api.create_gen.p_files') }}
spaceIdString{{ t('req.no') }}{{ t('api.create_gen.p_spaceId') }}
enableSearchBoolean{{ t('req.no') }}{{ t('api.create_gen.p_enableSearch') }}
advancedModelBoolean{{ t('req.no') }}{{ t('api.create_gen.p_advancedModel') }}
fastModeBoolean{{ t('req.no') }}{{ t('api.create_gen.p_fastMode') }}
intentString{{ t('req.no') }}{{ t('api.create_gen.p_intent') }}
audienceString{{ t('req.no') }}{{ t('api.create_gen.p_audience') }}
pageCountInteger{{ t('req.no') }}{{ t('api.create_gen.p_pageCount') }}
authorString{{ t('req.no') }}{{ t('api.create_gen.p_author') }}
notifyURLString{{ t('req.no') }}{{ t('api.create_gen.p_notifyURL') }}

Response Example

{
    "notifyCount": 0,
    "id": "Pt1AtI67yauC",
    "spaceId": "<your_space_id>",
    "type": "generation",
    "status": "initial",
    "params": {
        "inputText": "How to learn Node.js development quickly",
        "files": [
            {
                "name": "detailed-node-guide.pptx",
                "size": 1441205
            }
        ],
        "enableSearch": true,
        "advancedModel": false,
        "intent": "Teach them to develop simple agents using Node.js",
        "audience": "Students",
        "pageCount": 10,
        "author": "<author_name>",
        "notifyURL": "https://your.domain/notify/callback",
        "userAgent": "Apifox/1.0.0 (https://apifox.com)"
    },
    "creatorId": "<user_id>",
    "notifyURL": "https://your.domain/notify/callback",
    "updatedAt": "2026-04-23T08:41:26.481Z",
    "createdAt": "2026-04-23T08:41:26.481Z"
}
GET

{{ t('api.get_gen.title') }}

/external/tasks/:id

{{ t('api.get_gen.desc') }}

Header

  • Authorization: Bearer API_KEY

Path Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
idString{{ t('req.yes') }}{{ t('api.get_gen.p_id') }}

Response Example

{
    "id": "U5ed3DGTif2Ig",
    "spaceId": "<your_space_id>",
    "type": "translation",
    "status": "success",
    "error": null,
    "progress": 100,
    "params": {
        "to": "en",
        "key": "2026-04/f5/f5045847-fdec-4cf2-a58b-8485b367c468.pptx",
        "from": "zh",
        "hash": "<file_hash>",
        "name": "API call test task name",
        "bytes": 36863,
        "model": "gemini-flash",
        "engine": "gemini",
        "notifyURL": "https://your.domain/notify/callback",
        "useGlossary": false,
        "imageTranslate": false
    },
    "consumedMS": 5944,
    "receivedAt": null,
    "notifyURL": "https://your.domain/notify/callback",
    "notifyCount": 6,
    "creatorId": "<user_id>",
    "createdAt": "2026-04-23T09:05:16.000Z",
    "updatedAt": "2026-04-23T09:05:22.000Z"
}
GET

{{ t('api.get_gen_result.title') }}

/external/generations/:id/result

{{ t('api.get_gen_result.desc') }}

Header

  • Authorization: Bearer API_KEY

Path Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
idString{{ t('req.yes') }}{{ t('api.get_gen_result.p_id') }}

Query Parameters

{{ t('table.name') }} {{ t('table.type') }} {{ t('table.required') }} {{ t('table.desc') }}
typeString{{ t('req.yes') }}{{ t('api.get_gen_result.p_type') }}

Response Example (Finished)

{
  "id": "gen_AbcdeFG12345",
  ...
  "downloadURL": "https://.../result.pptx"
}

🛠️ {{ t('play.title') }}

{{ t('play.cors_warn') }}

{{ t('play.config') }}

Endpoints

{{ t('nav.create_task') }}

- OR -

{{ t('nav.get_task') }}

{{ t('nav.create_generation') }}

- OR -

{{ t('nav.get_generation') }}

{{ t('nav.get_generation_result') }}

Response Output Status: {{ responseStatus }} 

                  

                    {{ t('play.waiting') }}