The OOONA Tools API is used to control all possible operations in OOONA's Tools including projects, presets and automation.
\nThis API allows you to login to any user by supplying an email address so make sure to secure the secret key and the access to the integration as much as possible.
\nThis collection is a ready-to-run documentation with a pre-request script that runs the /token request and stores the access_token from the result as a collection variable to be used by the request.
The API tries to keep things as simple as possible for the integrating system. Each entity you create on the Tools side has a unique ID value (usually a GUID).
\nThe ID is generated by your system and is sent as part of the URL.
\nOoona Tools will check if the ID you sent exists, and if it does, it will open the project or configuration (depending on the endpoint) for editing. If it doesn’t exist, it will create the project or configuration and open it.
\nMost endpoints return a single-use session URL (e.g. /V2/external?token=...) that:
Automatically authenticates the user based on email
\nOpens a specific project or interface inside the OOONA Toolkit
\nIs valid only for a short period and from a single device/session
\nYou should redirect the user immediately to the single-use URL (don't send it via email) or open it in a new tab
\nIf the user (by email) doesn’t exist, they are created automatically
\nOne session per email is supported at any given time
\nThe token should not be cached or reused
\nImportant: This API provides full access to your OOONA environment, including user creation, project management, configuration templates, file handling, and export operations. Your API key is highly sensitive and must be stored in a secure environment. Never expose it in frontend code or logs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🧑💻️How to use our API?","slug":"how-to-use-our-api"}],"owner":"3921292","collectionId":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","publishedId":"2sAXxS7r31","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-11T20:41:58.000Z"},"item":[{"name":"🔑 Authentication","item":[{"name":"Token","id":"6e4ca480-9592-47d1-ba07-b1e1c421961f","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"OoonaOnlineToolkit"},{"key":"client_secret","value":"256336f74c624410915f2bb278b80d63cce896d5d2d24ef9bce314ab2e11ed3a"},{"key":"grant_type","value":"api"},{"key":"name","value":"{{api_name}}"},{"key":"key","value":"{{api_key}}"}]},"url":"{{base_url}}/token","description":"Exchanges your API credentials for a bearer access token. Every other request needs it in the Authorization: Bearer <access_token> header; the collection-level pre-request script calls this request and stores the token for you.
Sent as application/x-www-form-urlencoded (not JSON). No bearer token is needed for this call.
If the API key is restricted to an IP address, the call must come from that IP.
\n200 OK with JSON:
400 Bad Request with { \"error\": \"invalid_grant\", \"error_description\": ... } when the name or key are incorrect (The name or key are incorrect.) or the key is bound to a different IP (Illegal IP.). Failed attempts are logged. Missing or wrong client_id/client_secret returns 400 with invalid_client.
All API requests must contain an Authorization header with a bearer token constructed with a \"Bearer \" prefix together with the access_token generated using the /token endpoint. To get a token, make a request to /token with the name, key, client_id and client_secret you will be provided with.
It’s up to you to decide if you want to generate a different token for every request or cache the token until the “.expires” value and generate a new token as soon as it expires (or soon before).
Role: API or UserAPI.
Lists the import and export templates available to the calling user: the user's own templates plus the instance's global templates. Only templates of type ImportTemplate or ExportTemplate are listed.
No parameters.
\nOutput: 200 OK, JSON array; each item:
401 Unauthorized when the token's user can not be resolved.
Role: API or UserAPI.
Returns the stored JSON of one template: the user's own template with that id, or else a global template with that id. Unlike the list endpoint it is not limited to import/export types when the id belongs to the user.
\nRoute
\nOutput: 200 OK with the template JSON (SubtitlesConfiguration) as application/json. 404 Not Found when neither the user nor the global set has that id. 401 Unauthorized when the token's user can not be resolved.
Role: API or UserAPI.
Returns an empty template with every property at its default value (SubtitlesConfiguration). Use it as a starting point: change the properties you need and send the result to Create template or Update template. Despite being a POST it has no body and changes nothing.
No parameters, no body. Output: 200 OK with the JSON object.
Role: API or UserAPI.
Replaces the content of one of the calling user's own templates with the JSON you send. The template's name and type do not change. Global templates and other users' templates are not editable here (they answer 404).
Route
\nBody (JSON): a configuration object (SubtitlesConfiguration), required and at least 10 characters. Only known properties are kept; properties you omit are stored with their defaults (see Get default template). Typical properties for an export template: format, language1, language2, timecodeFormat, videoFormat, plus the format-specific options.
Output: 200 OK with an empty body. 404 Not Found when the user has no template with that id. An invalid or too short body is rejected with an error response and nothing is changed. 401 Unauthorized when the token's user can not be resolved.
Role: API or UserAPI.
Creates a new template owned by the calling user. A new id is generated and returned; the template is a fresh entry (this call never overwrites an existing one).
\nRoute
\nBody (JSON): a configuration object (SubtitlesConfiguration), required and at least 10 characters. Only known properties are kept; properties you omit are stored with their defaults (see Get default template). Typical properties for an export template: format, language1, language2, timecodeFormat, videoFormat, plus the format-specific options.
Output: 200 OK with the id of the new template as a JSON string, e.g. \"5d1f0c8e-...\". Use it with Get template, Update template, Duplicate template, Delete template. An invalid type or an invalid/too short body is rejected with an error response and nothing is created. 401 Unauthorized when the token's user can not be resolved.
Role: API or UserAPI.
Deletes one of the calling user's own templates. Global templates and other users' templates can not be deleted here.
\nRoute
\nOutput: 200 OK with an empty body when deleted; 404 Not Found when the user has no template with that id. 401 Unauthorized when the token's user can not be resolved.
Role: API or UserAPI.
Makes a copy of one of the calling user's own templates (same type and content, stored as a new file) and returns the new id. Global templates and other users' templates can not be duplicated here.
\nRoute
\nNo body.
\nOutput: 200 OK with the new template id as a JSON string. 404 Not Found when the user has no template with that id. 401 Unauthorized when the token's user can not be resolved.
Per-user import / export templates used with the Convert API (role API or UserAPI).
These are different from the API configuration templates in the parent folder:
\nTemplates of that user). Only the owner can update, duplicate or delete them.ImportTemplate and ExportTemplate can be created.global: true); those can be read but not changed through these endpoints.The template body is a configuration object (SubtitlesConfiguration). You may send a partial object: unknown properties are dropped and missing ones take their default values (see GET /external/configuration/default or POST /external/template/default for the complete shape). The body must be at least 10 characters of valid JSON.
Creates or edits a ProjectSettings configuration template through the hosted form.
\nThe form edits a complete project configuration (language, timecode/FPS, formatting, QC, etc.). Use it as the base configuration; language-specific and video-specific parts can be overridden by LanguageSettings / VideoSettings templates.
Role: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for ProjectSettings: after save, callbackUrl is called with query parameters language1, language2, fps (the template's timecode format) and the text body \"{language1} {fps}\". The call is best-effort; failures are only logged and do not affect the user's save.
Creates or edits a LanguageSettings configuration template through the hosted form.
\nThe form edits only the language-specific part of a configuration; it overrides the language settings of a ProjectSettings base when both are applied to a project.
Role: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for LanguageSettings: after save, callbackUrl is called with query parameters language1, language2 and the text body \"{language1}\". The call is best-effort; failures are only logged and do not affect the user's save.
Creates or edits a VideoSettings configuration template through the hosted form.
\nThe form edits only the video-specific part of a configuration (timecode format, video format); it overrides the video settings of a ProjectSettings base.
Role: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for VideoSettings: after save, callbackUrl is called with query parameters fps (the template's timecodeFormat) and videoFormat, and the text body \"{fps} {videoFormat}\". The call is best-effort; failures are only logged and do not affect the user's save.
Creates or edits a ImportSettings configuration template through the hosted form.
\nThe form edits file import settings (format and parsing options). They only apply when the imported file has the same format as the template.
\nRole: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for ImportSettings: after save, callbackUrl is called with query parameters language1, language2, format, fps and the text body \"{format} {language1} {fps}\". The call is best-effort; failures are only logged and do not affect the user's save.
Creates or edits a ExportSettings configuration template through the hosted form.
\nThe form edits file export settings (format and delivery specification). They are used when the user finishes a project and a file is exported in the background and POSTed to the project's callbackUrl.
Role: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for ExportSettings: after save, callbackUrl is called with query parameters language1, language2, format, fps and the text body \"{format} {language1} {fps}\". The call is best-effort; failures are only logged and do not affect the user's save.
Creates or edits a BatchExport configuration template through the hosted form.
\nThe form edits a batch export configuration: a list of named exports (each a set of export settings plus file naming). The saved JSON is an array. Reference it from POST /external/batchExport through items[].configurationGuid.
Role: API.
Starts a configuration-editing session for the {guid} in the URL. Nothing is saved as a template by this call: it stores a one-off \"external request\" and returns a URL. Redirect your user to that URL; they get a configuration form for the chosen configurationType. When they press save, the template is stored under {guid} (created, or updated if it already exists) and your callbackUrl (if any) is invoked. Afterwards the template can be read with GET /external/configuration/{guid} and used by id when opening projects, importing, exporting or running batch exports.
Each call issues a new single-use token. Posting the same {guid} again replaces that id's existing configuration request with the new body (same row, new single-use token) instead of adding another row, so send the full body each time: a field you omit is cleared, except the previous*Guid seed fields, which keep their stored value when omitted. The configuration id comes from the route and name from the request. A project id is never matched. When a template with this {guid} already exists the form shows the stored template, not configurationJson.
Route
\nBody (JSON) - same fields for every configurationType; the type decides which form is shown and what is sent to the callback.
Output: 200 OK with a JSON string: the URL to send the user to, \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
Callback for BatchExport: after save, callbackUrl is called with no query parameters, and the text body \"<N> exports (<name1>, <name2>, ...)\". The call is best-effort; failures are only logged and do not affect the user's save.
Role: API.
Copies one or more existing templates to new ids. The content is duplicated into a new stored file; the copy keeps the source's type and is flagged as an API template, so it shows up in GET /external/configurations. The copy's name is its new id.
The last URL segment is the literal copyConfigurations (not a guid).
Body (JSON): a single object, or an array of objects to make several copies in one call.
\nA pair is silently skipped when the source does not exist or when a template with the target id already exists (an existing template is never overwritten and no error is reported for it).
\nOutput: 200 OK with the JSON string \"Copied successfully\" once the request was processed, even if every pair was skipped. 404 Not Found only when the body is an empty array. Use GET /external/configuration/{targetConfigurationId} to confirm a copy was made.
Role: API.
Lists the configuration templates that were created through the API (via POST / PUT /external/configuration/{guid} or copyConfigurations). Templates created by users in the UI are not included.
No parameters.
\nOutput: 200 OK with a JSON array; each item:
The list does not include template contents; fetch them with GET /external/configuration/{id}.
Role: API.
Returns the default configuration object (SubtitlesConfiguration) with every property and its default value. Use it as the reference for the value of PUT /external/configuration/{guid} and for the bodies of the Convert templates endpoints.
No parameters. Output: 200 OK with the JSON object as application/json.
Role: API.
Returns the stored JSON of a configuration template by its id.
\nRoute
\nOutput: 200 OK with the template's JSON as application/json (a SubtitlesConfiguration object for project/import/export templates, an array of exports for batch export templates). 404 Not Found when no template has that id. The lookup is by id across all templates, not only API-created ones.
Role: API.
Creates or updates a configuration template directly, with no user interaction. This is the headless alternative to POST /external/configuration/{guid}: POST returns a URL for a person to fill in a form and the template is only stored once they save; PUT stores the template immediately from the JSON you send.
Route
\nBody (JSON)
\nid, creationTime and lastModified are not read from the body.
Output
\n201 Created when the template did not exist; the Location is /external/configuration/{guid}.200 OK with the text Updated successfully when it existed (name, type and content are replaced).GET /external/configurations.Role: API.
Permanently deletes a configuration template: its stored JSON file and its template record. The deletion is written to the action log. It cannot be undone.
\nRoute
\nOutput: 200 OK with an empty body when deleted; 404 Not Found when no template has that id.
Role: API.
Read-only report of how this Toolkit instance is actually configured. It answers questions such as \"does this instance have a key for engine X?\" without server access. Nothing is changed.
\nApplication settings can come from several layers. For every known setting key the report shows the effective value and which layer supplied it. Layers, highest precedence first: UserSetting, ClientSetting, Database, SecretsSite, SecretsGlobal, WebConfig (in a DEBUG build WebConfig wins over the secret layers).
Secrets are never returned in clear text. Sensitive values are masked (first 2 characters, a fixed run of asterisks, last character) and carry a short fingerprint (first 8 hex characters of the SHA-256 of the value), so two instances can be compared for \"same credential\" without exposing it.
No parameters.
\nOutput: 200 OK, JSON object:
Errors: 401/403 without the API role.
Configuration endpoints are used to manage settings presets for projects, imports, exports, etc...
\nThe base endpoint to create or edit a preset is /external/configuration/{guid}
The {guid} is a unique identified you should generate on your end and save to be able to address this template in the future (open a project with it or delete it).
This will return a URL you should redirect your user to. The user will be given a page with a configuration form.
If the {guid} already exists they will be able to edit it and save, otherwise, they will create a new entry for this {guid}.
Using the {guid} you provide in this request’s URL you can open new projects with the settings attached to it.
You can use the “ProjectSettings” template as base configuration and override language specific settings and video specific settings using “LanguageSettings” and “VideoSettings” templates. You can ignore “VideoSettings” and “LanguageSettings” and only work with complete configuration templates to simplify the process.“ImportSettings” is only relevant for projects that a file should be imported into either by the user or automatically using the “subtitlesUrl” option in the project API (the import settings will be ignored if the file being imported has a different format than the format in the template provided). “ExportSettings” is relevant when the user working on the project should export a file for delivery and you want to control the file specifications. These settings will be used when the user clicks on “Finish project” and a file will be exported in the background and POSTed to the “callbackUrl” provided when the project is opened.
API)The Convert templates sub-folder covers the separate per-user import/export templates used by the Convert API.
Lists the subtitle and caption file formats this instance can handle, with what each can do. Use key as a format key in the route of Convert / QC / Conform / Stitch, or as the format value in importOverrides / exportOverrides. Role: API or UserAPI. No input.
Access: bearer token with role API or UserAPI. The response is cached for 24 hours (server and client), independent of the query string.
Formats that require a role are filtered by the role of the caller, but the response is cached instance-wide for up to 24 hours without a per-user key, so the list may reflect another caller's roles.
\nOutput (200 OK, JSON array). Each item:
Lists the languages known to the Toolkit. Use key / name as the language value in custom JSON configuration (e.g. language1 in importOverrides / exportOverrides and in templates). Role: API or UserAPI. No input.
Access: bearer token with role API or UserAPI. The response is cached for 24 hours (server and client), independent of the query string.
Output (200 OK, JSON array). Each item:
Lists the format categories used by the category field of Get formats. Role: API or UserAPI. No input.
Access: bearer token with role API or UserAPI. The response is cached for 24 hours (server and client), independent of the query string.
Output (200 OK, JSON array of { \"key\", \"name\" }): OpenSubtitles, TimedText, ClosedCaptions, DVDImages (image-based formats; converting to these runs as an asynchronous job, see the Convert folder).
Lists the text encodings the Toolkit can read and write. Use value as the encoding in custom JSON configuration (e.g. encoding in importOverrides / exportOverrides). Role: API or UserAPI. No input.
Access: bearer token with role API or UserAPI. The response is cached for 24 hours (server and client), independent of the query string.
Output (200 OK, JSON array). Each item: code (integer, code page number), name (display name) and value (encoding name to use in configuration).
Metadata endpoints should help you map language names, file formats and encodings to use in custom JSON values in Convert and QC API.
\nAll four endpoints are read-only GET calls with no input, role API or UserAPI, return JSON and are cached for 24 hours.
Opens the Create Pro app for a project, creating the project on first use, and returns the one-time link to redirect your user to. This is the same POST external/project/{id} endpoint used for every app; only app and the inputs differ (see also Translate Pro Project, Review Project and MultilingualQC Project).
Route. id (required): the project GUID. You generate and keep it. First call creates, repeat calls with the same GUID re-open.
Behaviour. Role: API. The GUID in the route is the project id and you generate it and keep it.
previous... GUIDs keep their earlier values.?force=true to ignore that and hand the project to email (risk: two users overwriting each other). Outside that window ownership simply moves to email.Query string. force (optional, true/false, default false): as described above.
Success response (200 OK, JSON string): the absolute URL to redirect the user to, https://<host>/V2/external?token=<token>.
Errors. There is no validation response: the endpoint raises an error (an error response, not a field-level 4xx) for an empty body (\"Request body is empty.\"), malformed JSON, or when the user account for email cannot be created.
Body fields (JSON, camelCase; unknown fields are ignored). Everything is optional as far as the endpoint itself is concerned, but an app needs enough to open: in practice email, app and the inputs that app uses.
Identity and session
\nMedia and subtitle inputs
\nConfiguration. Each can be given as a saved-configuration GUID (...Guid); the first three also accept the settings inline as a JSON string (...Json).
The model also declares importConfigurationJson, exportConfigurationJson, sourceLanguageConfigurationJson, sourceImportConfigurationJson, languageConfigurationJson, fileNamingJson, videoConfigurationJson and the previous...Json variants. Only configurationJson, importConfigurationJson and exportConfigurationJson have a stored counterpart on the request record; prefer the ...Guid fields for everything else.
Editor permissions and UI
\nCallbacks
\nsplitLimitation object - open only a slice of a project; the Merge Projects request puts slices back together.
syncheck object: declared on the model for the Syncheck integration; not used by this endpoint.
Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"10fb45ac-fab2-48c2-b449-ec13da2c9456","name":"Create Pro Project with all parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"8f2fc2e7-5e8f-45a6-95ec-6b9d0df05490\",\r\n \"email\": \"Stanley77@example.org\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"Architect Oregon compelling drive Corporate\",\r\n \"adminEmail\": \"Fernando20@example.org\",\r\n \"video\": \"{\\\"src\\\":\\\"https://ines.info\\\",\\\"dat\\\":\\\"https://issac.biz\\\", \\\"type\\\":\\\"application/dash+xml\\\"}\",\r\n \"configurationGuid\": \"f012a69f-116a-43cf-b310-6009bce92009\",\r\n \"callbackUrl\": \"https://chanel.com\",\r\n \"subtitlesUrl\": \"https://marianna.info\",\r\n \"subtitlesFileName\": \"Wyoming JBOD Malagasy firewall circuit\",\r\n \"previousProjectGuid\": \"520b70d3-539a-4795-ade4-17fa2c9c3574\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"sourceLanguageConfigurationGuid\": \"118a529a-2b4e-4c58-ada2-a268d76e7faf\",\r\n \"sourceImportConfigurationGuid\": \"d0c9f58b-3974-4044-919c-2089f2464714\",\r\n \"languageConfigurationGuid\": \"3931705c-2da4-4091-9784-d151651dfb17\",\r\n \"importConfigurationGuid\": \"dc33fb6d-cb74-4aeb-919d-731cfd0ce192\",\r\n \"exportConfigurationGuid\": \"aaee1d48-ccba-48f1-8c6c-0a4ad07ac646\",\r\n \"videoConfigurationGuid\": \"0c2cd41c-b5be-483e-998b-553a5fa18ffa\",\r\n \"startTC\": \"00:00:00:00\",\r\n \"previousImportConfigurationGuid\": \"b68589a2-9075-488a-ac77-aa9e6e43fd68\",\r\n \"previousExportConfigurationGuid\": \"ffa8c13a-b855-44d3-9fbd-989388c02215\",\r\n \"previousLanguageConfigurationGuid\": \"86e337d1-5a63-444f-a2ac-08ceec4132f8\",\r\n \"previousSourceLanguageConfigurationGuid\": \"7f347127-b0d3-453f-b3a6-5fc9d0cc5da4\",\r\n \"previousSourceImportConfigurationGuid\": \"576483d8-2ab9-49bf-8233-28b083f4df0e\",\r\n \"previousVideoConfigurationGuid\": \"46ecb157-8f77-4083-9257-867360435d13\",\r\n \"userUrl\": \"https://jordy.net\",\r\n \"taskCompleteUrl\": \"https://ryley.net\",\r\n \"taskCompleteShowModal\": true,\r\n \"document\": \"https://toy.name\",\r\n \"resignDocumentUrl\": \"https://vilma.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/c7dbf396-52c1-45f0-a97b-ce6d0e5c65a5","host":["{{base_url}}"],"path":["external","project","39d8626f-05c8-4b0d-90d8-95a5c0fa8dd0"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=MvevAOPXmXQAbnToflgQoMiStI6gtPD2MCu0ZZSJug\""},{"id":"efc32b0d-30b5-4d32-873c-abcfa1abfbaf","name":"Create Pro Project with video URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"f0e03a2d-1b69-44f4-9d56-176fc55f369a\",\r\n \"email\": \"Quinton72@example.org\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"Rubber redefine\",\r\n \"adminEmail\": \"Bethel.Hintz24@example.org\",\r\n \"video\": \"https://stefan.name\",\r\n \"configurationGuid\": \"f012a69f-116a-43cf-b310-6009bce92009\",\r\n \"callbackUrl\": \"http://sarah.org\",\r\n \"subtitlesUrl\": \"https://lorenza.com\",\r\n \"subtitlesFileName\": \"zero web Chicken\",\r\n \"previousProjectGuid\": \"53226c7f-d345-4cb4-9b06-eaca17345c32\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"sourceLanguageConfigurationGuid\": \"c5353357-e6ca-4fe9-b6c7-cf1a7d0e7bbb\",\r\n \"sourceImportConfigurationGuid\": \"654d6503-6c49-473d-bfc3-561bc1170e0c\",\r\n \"languageConfigurationGuid\": \"c7addc3f-5ad6-4a5c-adb7-e617db9decdf\",\r\n \"importConfigurationGuid\": \"67fdab3e-d976-40e1-bf0f-66975dbb4ca3\",\r\n \"exportConfigurationGuid\": \"80c0e50a-7902-4ad3-a887-9a0d5f677266\",\r\n \"videoConfigurationGuid\": \"7fa69238-a6ac-4789-b8c7-b24d95ca60e5\",\r\n \"startTC\": \"00:00:00:00\",\r\n \"previousImportConfigurationGuid\": \"4ac7a477-7f5d-433a-8971-bd55e40687ea\",\r\n \"previousExportConfigurationGuid\": \"58cbe3c1-09b4-4015-b1f5-23d0100e3bde\",\r\n \"previousLanguageConfigurationGuid\": \"4da5bdbd-2c88-4bd5-8f33-5ec7258c1d80\",\r\n \"previousSourceLanguageConfigurationGuid\": \"8a2182cc-30c7-4503-b3e8-5a90fdc2a775\",\r\n \"previousSourceImportConfigurationGuid\": \"e392ceff-5359-445d-8eb1-79b17e043d18\",\r\n \"previousVideoConfigurationGuid\": \"5df48c32-6a2a-4f69-bc49-44e3375f1d25\",\r\n \"userUrl\": \"https://ken.info\",\r\n \"taskCompleteUrl\": \"https://jedediah.info\",\r\n \"taskCompleteShowModal\": true,\r\n \"document\": \"http://izaiah.biz\",\r\n \"resignDocumentUrl\": \"https://donnie.net\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/0f2ff877-50e7-44dd-8eb6-dc8b4648f047","host":["{{base_url}}"],"path":["external","project","5cd49ece-2e15-4072-a77a-bfcca07885de"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=MvevAOPXmXQAbnToflgQoMiStI6gtPD2MCu0ZZSJug\""},{"id":"29767b22-53d8-4d60-b01d-8e31b10723ec","name":"Create Pro Project with mp4 video and dat URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"a29935d0-894e-4664-86dd-457991032f62\",\r\n \"email\": \"Dorthy.Rohan@example.com\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"Key copy\",\r\n \"adminEmail\": \"Beth_Hills@example.net\",\r\n \"video\": \"{\\\"src\\\":\\\"https://kirstin.biz\\\",\\\"dat\\\":\\\"http://michale.net\\\"}\",\r\n \"configurationGuid\": \"f012a69f-116a-43cf-b310-6009bce92009\",\r\n \"callbackUrl\": \"https://janelle.com\",\r\n \"subtitlesUrl\": \"https://celestino.org\",\r\n \"subtitlesFileName\": \"withdrawal Licensed cross-platform face\",\r\n \"previousProjectGuid\": \"a812b68f-73cc-41c3-8752-ed66f6285d5e\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"sourceLanguageConfigurationGuid\": \"1bef598d-93cf-4c30-a386-4336aedda4f1\",\r\n \"sourceImportConfigurationGuid\": \"9c91d424-fced-45aa-80bb-abf3c2fe28eb\",\r\n \"languageConfigurationGuid\": \"e2156635-9cbb-4853-8d1a-8f94ad5e336a\",\r\n \"importConfigurationGuid\": \"4dc5f544-f6c0-4e87-87aa-0ca4fb3f9d5e\",\r\n \"exportConfigurationGuid\": \"afb07bc2-7389-4811-9531-718b25f56ed6\",\r\n \"videoConfigurationGuid\": \"d2ac89de-7421-4df2-8506-92e1d12bbb18\",\r\n \"startTC\": \"00:00:00:00\",\r\n \"previousImportConfigurationGuid\": \"6ec183f1-0bfe-4bfc-a1cc-49059f490e51\",\r\n \"previousExportConfigurationGuid\": \"9a9a24ae-9f4e-4e40-9994-03c6e55df26f\",\r\n \"previousLanguageConfigurationGuid\": \"90199dfd-18e6-45e2-865f-29ec29879b4a\",\r\n \"previousSourceLanguageConfigurationGuid\": \"09cc9399-71bf-451f-9898-be0998421137\",\r\n \"previousSourceImportConfigurationGuid\": \"9873459c-14c5-4935-83d8-7e2a78fd8497\",\r\n \"previousVideoConfigurationGuid\": \"de1f4a4c-e20c-484e-a501-d66d7e996ecb\",\r\n \"userUrl\": \"https://hilbert.net\",\r\n \"taskCompleteUrl\": \"http://janiya.net\",\r\n \"taskCompleteShowModal\": true,\r\n \"document\": \"http://orland.com\",\r\n \"resignDocumentUrl\": \"https://amir.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/023d09b8-4ce6-4809-94c8-ff784199eda1","host":["{{base_url}}"],"path":["external","project","5f400637-fdc7-4267-a7db-a41830c2c433"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=MvevAOPXmXQAbnToflgQoMiStI6gtPD2MCu0ZZSJug\""},{"id":"8c2a1afe-66d3-42f6-8c20-2c79b9735f2a","name":"Create Pro Project with split by time","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"c28e6127-1c65-44b3-8d08-73caa42a9cf2\",\r\n \"email\": \"Christine60@example.net\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"parsing Kentucky\",\r\n \"adminEmail\": \"Wayne_Lubowitz@example.net\",\r\n \"video\": \"{\\\"src\\\":\\\"http://sallie.info\\\",\\\"dat\\\":\\\"http://burnice.org\\\", \\\"type\\\":\\\"application/dash+xml\\\"}\",\r\n \"configurationGuid\": \"f012a69f-116a-43cf-b310-6009bce92009\",\r\n \"callbackUrl\": \"https://aurelio.com\",\r\n \"subtitlesUrl\": \"http://darrell.info\",\r\n \"subtitlesFileName\": \"Frozen Handcrafted calculating\",\r\n \"previousProjectGuid\": \"d6cbc2b6-e3b5-4a24-8341-14eb404d9c5a\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"sourceLanguageConfigurationGuid\": \"40d90e39-f118-41ae-8dca-a50c047bb37f\",\r\n \"sourceImportConfigurationGuid\": \"870b80fb-c3ee-45bc-a58a-1fa8d848a57d\",\r\n \"languageConfigurationGuid\": \"29376408-02a3-4b12-a0da-f7d7f95d83c0\",\r\n \"importConfigurationGuid\": \"49435044-06f2-4525-98b2-fea4e92af31e\",\r\n \"exportConfigurationGuid\": \"2cd6f2d2-95aa-4bb5-b251-be963046300b\",\r\n \"videoConfigurationGuid\": \"0d6c58b7-95a0-4583-8ce4-b6bdbc12642f\",\r\n \"startTC\": \"00:00:00:00\",\r\n \"previousImportConfigurationGuid\": \"d8148299-fae0-4154-b518-11ceaf387e65\",\r\n \"previousExportConfigurationGuid\": \"332107a8-19dc-4429-a514-58a1f571aced\",\r\n \"previousLanguageConfigurationGuid\": \"4c683cf3-9535-4be7-b2f7-4649a7e9a3b4\",\r\n \"previousSourceLanguageConfigurationGuid\": \"3043151a-c990-4a78-9c67-1eb7a6738a57\",\r\n \"previousSourceImportConfigurationGuid\": \"48f65b81-462a-41e2-862e-35f5063fe9b6\",\r\n \"previousVideoConfigurationGuid\": \"9764d3a0-c4b0-4895-b641-1cde7807c568\",\r\n \"userUrl\": \"https://bruce.name\",\r\n \"taskCompleteUrl\": \"https://erwin.name\",\r\n \"taskCompleteShowModal\": true,\r\n \"document\": \"https://tess.com\",\r\n \"resignDocumentUrl\": \"http://magali.org\",\r\n \"splitLimitation\": { \"fromDuration\": 870, \"toDuration\": 1340 }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/d0ac5fa6-c6ef-4a9c-bc20-75b45b817d4b","host":["{{base_url}}"],"path":["external","project","85c4b139-a55c-46f5-a5c5-eee1b8d49136"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"6df21604-7b66-4191-bc9c-05a1473b1893","name":"Create Pro Project with multiple files","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"86e22184-215d-46f6-9601-777cf9776b64\",\r\n \"email\": \"Novella_Waters@example.com\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"invoice Analyst alarm Home\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"video\": \"{ \\\"src\\\": \\\"https://public.ooona.net/video/MERIDIAN/231220-135012.mpd\\\", \\\"dat\\\": \\\"https://public.ooona.net/video/MERIDIAN/MERIDIAN_downconvert.dat\\\" }\",\r\n \"subtitlesUrl\": null,\r\n \"subtitlesList\": \"[{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ar.xml\\\",\\\"language\\\":\\\"Arabic\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ar.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.de.xml\\\",\\\"language\\\":\\\"German\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.de.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.el.xml\\\",\\\"language\\\":\\\"Greek\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.el.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.en.xml\\\",\\\"language\\\":\\\"English\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.en.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.es.xml\\\",\\\"language\\\":\\\"Spanish\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.es.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.fr.xml\\\",\\\"language\\\":\\\"French\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.fr.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.he.xml\\\",\\\"language\\\":\\\"Hebrew\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.he.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ja.xml\\\",\\\"language\\\":\\\"Japanese\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ja.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ko.xml\\\",\\\"language\\\":\\\"Korean\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ko.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.pt.xml\\\",\\\"language\\\":\\\"Portuguese\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.pt.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ru.xml\\\",\\\"language\\\":\\\"Russian\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ru.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.th.xml\\\",\\\"language\\\":\\\"Thai\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.th.xml\\\"}]\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/2eb207f5-e48e-43e1-90c9-c3e911e56cd1","host":["{{base_url}}"],"path":["external","project","bf87e96f-1b3e-407c-8c2f-86a02fda3fa3"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"132c30a9-cf43-420a-a702-c52ef89f363b"},{"name":"Translate Pro Project","id":"523286ed-a023-4aac-9030-9c798a7e8ae3","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"61d1e406-caa9-43a0-a143-fdb0e2bf0950\",\n \"email\": \"Rodger78@example.net\",\n \"ip\": \"::1\",\n \"projectName\": \"copying Checking\",\n \"adminEmail\": \"Jarrod_Von@example.com\",\n \"app\": \"TranslatePro\",\n \"editConfiguration\": true,\n \"allowDownload\": true,\n \"allowUpload\": true,\n \"allowMediaOpen\": true,\n \"video\": \"https://addison.net\",\n \"subtitlesUrl\": \"\",\n \"configurationGuid\": \"928d6ca2-b348-4dd9-8e11-1afdf6dc594d\",\n \"importConfigurationGuid\": \"459e6f11-d469-406a-8ce4-665eed36eb7e\",\n \"exportConfigurationGuid\": \"5bea0d3c-016d-4bfa-b2ab-0f74f53a779d\",\n \"languageConfigurationGuid\": \"1e39f676-b5c1-403c-9cda-0fbca0abc500\",\n \"sourceLanguageConfigurationGuid\": \"94942999-a66a-43e5-9543-646899747e84\",\n \"sourceImportConfigurationGuid\": \"182cfe48-d568-4b5c-be69-635e763be248\",\n \"callbackUrl\": \"https://karine.name\",\n \"taskCompleteUrl\": \"\",\n \"taskCompleteShowModal\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/project/179a4af4-0fdd-4eff-bce7-433763aaf181","description":"Opens the Translate Pro app. A Translate Pro project has a source column and a target column: supply the source subtitles through subtitlesUrl / subtitlesList (with sourceImportConfigurationGuid if the source needs different import settings), the target language through languageConfigurationGuid and the source language through sourceLanguageConfigurationGuid.
Same endpoint, route, query string, behaviour and response as Create Pro Project; the full field reference is in that request's description and applies unchanged. The sample body below shows the fields typically used for Translate Pro; add any other field from the reference as needed.
\nBehaviour. Role: API. The GUID in the route is the project id and you generate it and keep it.
previous... GUIDs keep their earlier values.?force=true to ignore that and hand the project to email (risk: two users overwriting each other). Outside that window ownership simply moves to email.Query string. force (optional, true/false, default false): as described above.
Success response (200 OK, JSON string): the absolute URL to redirect the user to, https://<host>/V2/external?token=<token>.
Errors. There is no validation response: the endpoint raises an error (an error response, not a field-level 4xx) for an empty body (\"Request body is empty.\"), malformed JSON, or when the user account for email cannot be created.
Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"62655072-ecce-4108-9c90-8eafba96f6fa","name":"Translate Pro Project","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"5f9a2b75-91f8-453e-b40b-b6a3216bd21b\",\r\n \"email\": \"Marilie.Jerde32@example.net\",\r\n \"ip\": \"::1\",\r\n \"projectName\": \"EXE Prairie Assistant\",\r\n \"adminEmail\": \"Reid.Wolff@example.com\",\r\n \"app\": \"TranslatePro\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"video\": \"http://carson.org\",\r\n \"subtitlesUrl\": \"\",\r\n \"configurationGuid\": \"f40e1f38-3863-4f6b-8d19-c3831cdf8fb1\",\r\n \"importConfigurationGuid\": \"bed739fd-41ab-4b66-9dfd-e6727167cf30\",\r\n \"exportConfigurationGuid\": \"84e7d52a-9e8d-4474-9a05-fe91d5133f1a\",\r\n \"languageConfigurationGuid\": \"0a2ab71e-9047-4197-b1d8-5c23406d0aa4\",\r\n \"callbackUrl\": \"https://veronica.biz\",\r\n \"taskCompleteUrl\": \"\",\r\n \"taskCompleteShowModal\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/a053cf7c-1552-4af7-ab07-50319af8ab6f","host":["{{base_url}}"],"path":["external","project","c99f4224-dd88-4c6f-a0c8-60937ea6df55"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"99"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=aN8hzjoQfLKPOaHZXvAoMPhvzqdYouewVH1jLvajWO4\""},{"id":"f7784317-f2b7-470a-89ef-2382d4ab7673","name":"Translate Pro Project with split by index","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"f316274b-1eca-4eac-92f8-832ebad26b0d\",\r\n \"email\": \"Landen.Shields93@example.org\",\r\n \"ip\": \"::1\",\r\n \"projectName\": \"backing Dynamic back\",\r\n \"adminEmail\": \"Toy15@example.com\",\r\n \"app\": \"TranslatePro\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"video\": \"https://marcus.biz\",\r\n \"subtitlesUrl\": \"\",\r\n \"configurationGuid\": \"fbf6f0b3-d93d-4df6-8f29-98a0ce3cc523\",\r\n \"importConfigurationGuid\": \"0aa3e8ab-d2e7-4a76-9fb7-5e57ba5f1a33\",\r\n \"exportConfigurationGuid\": \"f8d602cc-993e-458a-9540-e33b9c7cfedc\",\r\n \"languageConfigurationGuid\": \"c3b6e32e-a896-4f5a-9289-d4d51cdac649\",\r\n \"callbackUrl\": \"http://boris.org\",\r\n \"taskCompleteUrl\": \"\",\r\n \"taskCompleteShowModal\": false,\r\n \"splitLimitation\": { \"fromSubtitle\": 500, \"toSubtitle\": 950 }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/27f119b9-5d6f-4e01-b300-5ed0c6ada7a8","host":["{{base_url}}"],"path":["external","project","bba650b3-8d90-463a-85a8-82b2b1d7a630"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"523286ed-a023-4aac-9030-9c798a7e8ae3"},{"name":"Review Project","id":"08e0d2ae-6455-4bee-88cf-1e53c275b6ee","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"c3412530-11c5-4845-a653-6ade3f50f5e6\",\n \"email\": \"Jamal_Gorczany@example.com\",\n \"ip\": \"::1\",\n \"projectName\": \"Mayotte Rustic AGP Administrator\",\n \"adminEmail\": \"Murray_Frami@example.com\",\n \"app\": \"ReviewPro\",\n \"previousProjectGuid\": \"0a2e5125-25ba-47b9-a75d-b4d24f4007fc\",\n \"editConfiguration\": true,\n \"allowDownload\": true,\n \"allowUpload\": true,\n \"allowMediaOpen\": true,\n \"video\": \"\",\n \"subtitlesUrl\": \"\",\n \"configurationGuid\": \"1eb0090d-efdb-445e-9a6d-af4ba73e01e4\",\n \"importConfigurationGuid\": \"722b6374-07d2-4c2a-b490-f5a05df40615\",\n \"exportConfigurationGuid\": \"76876d48-ddd7-4a26-8dbb-6a8530eb2b3f\",\n \"languageConfigurationGuid\": \"e2254a95-0de4-4de5-bb20-1f446ef0639c\",\n \"callbackUrl\": \"http://herminia.name\",\n \"taskCompleteUrl\": \"\",\n \"taskCompleteShowModal\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/project/e0a7b1b3-072a-45bb-8746-bcc4d8acf3f1","description":"Opens the Review Pro app. Review compares the work against an earlier version: pass the GUID of the previous project in previousProjectGuid (its subtitles become the original the reviewer's edits are measured against; see Project Changes). video and subtitlesUrl may be left empty when the previous project already holds them.
Same endpoint, route, query string, behaviour and response as Create Pro Project; the full field reference is in that request's description and applies unchanged. The sample body below shows the fields typically used for Review Pro.
\nBehaviour. Role: API. The GUID in the route is the project id and you generate it and keep it.
previous... GUIDs keep their earlier values.?force=true to ignore that and hand the project to email (risk: two users overwriting each other). Outside that window ownership simply moves to email.Query string. force (optional, true/false, default false): as described above.
Success response (200 OK, JSON string): the absolute URL to redirect the user to, https://<host>/V2/external?token=<token>.
Errors. There is no validation response: the endpoint raises an error (an error response, not a field-level 4xx) for an empty body (\"Request body is empty.\"), malformed JSON, or when the user account for email cannot be created.
Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"f56c749a-ef46-4354-965a-383319fad9a7","name":"Review Project","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"c3dafb1f-5c7a-407b-8875-00635f6a55fe\",\r\n \"email\": \"Velma_Champlin5@example.org\",\r\n \"ip\": \"::1\",\r\n \"projectName\": \"Avon Designer\",\r\n \"adminEmail\": \"Myrtle18@example.com\",\r\n \"app\": \"ReviewPro\",\r\n \"previousProjectGuid\": \"a4da7fc6-bf50-44f9-8b50-a95e1c7adeff\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"video\": \"\",\r\n \"subtitlesUrl\": \"\",\r\n \"configurationGuid\": \"c7b93a57-fd98-41b6-b694-1fd4485b2979\",\r\n \"importConfigurationGuid\": \"ecf252ce-7fa9-4e84-bcc9-f4ee4ffcf10e\",\r\n \"exportConfigurationGuid\": \"d5b4c9c6-e787-43c1-aff9-318fec261297\",\r\n \"languageConfigurationGuid\": \"4f241fe6-0f86-40d2-b888-56d9628e2e95\",\r\n \"callbackUrl\": \"https://velma.com\",\r\n \"taskCompleteUrl\": \"\",\r\n \"taskCompleteShowModal\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/cfef2997-313b-4d34-82b3-09dde8eced6a","host":["{{base_url}}"],"path":["external","project","dd722363-f8ef-4232-83f7-db33574701fe"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"97"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=eOnZ4rDZoEy8EpDeicJ6cc6d9SeAi8jwKdlbINb40\""},{"id":"30fab5ca-322e-4f86-a2b7-2c9d6d57699f","name":"Review Project with multiple files","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"53dfb254-4fa1-4276-96d7-1311ed59c462\",\r\n \"email\": \"Ralph40@example.com\",\r\n \"ip\": \"::1\",\r\n \"app\": \"CreatePro\",\r\n \"projectName\": \"Berkshire red Regional Walks feed\",\r\n \"editConfiguration\": true,\r\n \"allowDownload\": true,\r\n \"allowUpload\": true,\r\n \"allowMediaOpen\": true,\r\n \"video\": \"{ \\\"src\\\": \\\"https://public.ooona.net/video/MERIDIAN/231220-135012.mpd\\\", \\\"dat\\\": \\\"https://public.ooona.net/video/MERIDIAN/MERIDIAN_downconvert.dat\\\" }\",\r\n \"subtitlesUrl\": null,\r\n \"subtitlesList\": \"[{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ar.xml\\\",\\\"language\\\":\\\"Arabic\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ar.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.de.xml\\\",\\\"language\\\":\\\"German\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.de.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.el.xml\\\",\\\"language\\\":\\\"Greek\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.el.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.en.xml\\\",\\\"language\\\":\\\"English\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.en.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.es.xml\\\",\\\"language\\\":\\\"Spanish\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.es.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.fr.xml\\\",\\\"language\\\":\\\"French\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.fr.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.he.xml\\\",\\\"language\\\":\\\"Hebrew\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.he.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ja.xml\\\",\\\"language\\\":\\\"Japanese\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ja.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ko.xml\\\",\\\"language\\\":\\\"Korean\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ko.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.pt.xml\\\",\\\"language\\\":\\\"Portuguese\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.pt.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.ru.xml\\\",\\\"language\\\":\\\"Russian\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.ru.xml\\\"},{\\\"url\\\":\\\"https://public.ooona.net/video/MERIDIAN/ttml/Meridian.th.xml\\\",\\\"language\\\":\\\"Thai\\\",\\\"fileType\\\":\\\"Subtitles\\\",\\\"description\\\":\\\"This is a dummy description for file Meridian.th.xml\\\"}]\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/c0ce1d64-44ef-4b63-b4f0-7faecabcd082","host":["{{base_url}}"],"path":["external","project","7751d686-2305-4f1f-a882-488b0829ee96"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"97"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=eOnZ4rDZoEy8EpDeicJ6cc6d9SeAi8jwKdlbINb40\""}],"_postman_id":"08e0d2ae-6455-4bee-88cf-1e53c275b6ee"},{"name":"MultilingualQC Project","id":"ee81e605-26ab-4718-9afb-5d3baf9f6366","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"projectGuid\": \"6c84a7a0-3458-4ba1-b640-dd548d58c0dd\",\n \"projectName\": \"Show S01E01 - French\",\n \"email\": \"Eva.Heller@example.net\",\n \"adminEmail\": \"Herman_Hoppe85@example.com\",\n \"ip\": \"::1\",\n \"video\": \"https://kaia.com\",\n \"subtitlesUrl\": \"http://rosemary.info\",\n \"subtitlesFileName\": \"Show.S01E01.fr.xml\",\n \"configurationGuid\": \"073b6980-ff8c-429a-a615-396b3f4031f7\",\n \"importConfigurationGuid\": \"9ca4c565-df3e-4be8-b400-d32156ad74f0\",\n \"exportConfigurationGuid\": \"c37c3791-c662-4198-91f9-50260cd1a9d5\",\n \"languageConfigurationGuid\": \"d0be6906-6c80-43b8-986c-cb6e8a4f147e\",\n \"startTC\": \"01:00:00:00\",\n \"editConfiguration\": true,\n \"allowDownload\": true,\n \"allowUpload\": true,\n \"allowMediaOpen\": true,\n \"callbackUrl\": \"http://judah.org\",\n \"unlock\": false\n },\n {\n \"projectGuid\": \"d5b5a60e-0c21-4ed5-95f6-db2dc4d87b48\",\n \"projectName\": \"Show S01E01 - German\",\n \"email\": \"Wilhelm33@example.com\",\n \"video\": \"http://evan.com\",\n \"subtitlesUrl\": \"http://emmanuelle.com\",\n \"subtitlesFileName\": \"Show.S01E01.de.xml\",\n \"languageConfigurationGuid\": \"4257a985-084f-41ac-bf3a-50bb804648e9\",\n \"startTC\": \"01:00:00:00\",\n \"unlock\": false\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/MultilingualQC/3f044ac3-0397-4093-a8bb-4f056f13521c","description":"Opens the MultilingualQC app: one editor session that holds several language projects (\"sub-projects\") of the same title side by side. Role: API. Two ways to call it:
POST external/MultilingualQC/{id} - {id} is the GUID of the root (container) project. The {id} segment is optional: POST external/MultilingualQC generates a new GUID for you.POST external/project/{id} with an array body does exactly the same; external/MultilingualQC simply forwards to it.Body. A JSON array with one entry per language project. Each entry is a normal project request: every field in the Create Pro Project reference applies (see that description for the complete table), plus:
\nThe root takes app = MultilingualQC and its session, permission and configuration fields from the first entry (email, adminEmail, ip, allow*, editConfiguration, baseUrl, configurationGuid / configurationJson, disabledMenuItems, enabledMenuItems, hideTabs, document, startTC, video, resignVideoUrl, userUrl, videoConfigurationGuid / videoConfigurationJson, previousVideoConfigurationGuid / previousVideoConfigurationJson, validationData). Its name is \"Multilingual \" plus the common prefix of all projectName values (or the first word of the first name when there is no common prefix). An empty array or body is rejected.
Behaviour. Same create/re-open, ownership and view-only (?force=true) rules as Create Pro Project; if any existing sub-project is owned by another recently active user the session also opens read-only. On creation one request record is stored per sub-project.
Success response (200 OK, JSON string): https://<host>/V2/external?token=<token> - redirect the user there.
Errors. As for Create Pro Project (an error is raised for an empty array/body or malformed JSON).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","MultilingualQC","9c33d758-81df-46cf-b14b-6f108334f615"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"d8efc8ee-1f93-4909-83e2-e4208ae2c434","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"projectGuid\": \"ac23862a-f910-4b80-b787-50d44e38440a\",\n \"projectName\": \"Show S01E01 - French\",\n \"email\": \"Cordell.Hagenes96@example.com\",\n \"adminEmail\": \"Annamae.Metz33@example.org\",\n \"ip\": \"::1\",\n \"video\": \"https://elissa.info\",\n \"subtitlesUrl\": \"http://lenna.net\",\n \"subtitlesFileName\": \"Show.S01E01.fr.xml\",\n \"configurationGuid\": \"3651b466-1fed-40c1-9dca-5d6ddb0a208c\",\n \"importConfigurationGuid\": \"0e7c9c9f-5fa2-4e4e-9847-e94e722470ad\",\n \"exportConfigurationGuid\": \"8bfe5eeb-b504-4eae-8068-88712198b1fd\",\n \"languageConfigurationGuid\": \"e3cdb706-4c0e-4488-ad9c-2743ca9075bd\",\n \"startTC\": \"01:00:00:00\",\n \"editConfiguration\": true,\n \"allowDownload\": true,\n \"allowUpload\": true,\n \"allowMediaOpen\": true,\n \"callbackUrl\": \"https://terrill.biz\",\n \"unlock\": false\n },\n {\n \"projectGuid\": \"d388cbcc-585e-4822-8464-5c9834a178f2\",\n \"projectName\": \"Show S01E01 - German\",\n \"email\": \"Melisa.Johns88@example.net\",\n \"video\": \"http://esperanza.org\",\n \"subtitlesUrl\": \"http://kavon.org\",\n \"subtitlesFileName\": \"Show.S01E01.de.xml\",\n \"languageConfigurationGuid\": \"f7a96ca4-7025-4b8e-8b09-b069f9609184\",\n \"startTC\": \"01:00:00:00\",\n \"unlock\": false\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/MultilingualQC/fc36b816-a09a-4ea9-9d18-244c33f693fb","host":["{{base_url}}"],"path":["external","MultilingualQC","c205adb7-5834-4786-8101-3b96326f2620"],"query":[{"key":"force","value":"false","description":"Optional. true = open for this e-mail even if another user saved the project in the last 180 seconds.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=MvevAOPXmXQAbnToflgQoMiStI6gtPD2MCu0ZZSJug\""}],"_postman_id":"ee81e605-26ab-4718-9afb-5d3baf9f6366"},{"name":"Open Compare","id":"e069e06a-e270-4680-95d1-6023c7e4e02f","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ac1a5a81-795f-4db9-9b81-79c981351b0f\",\n \"email\": \"Archibald32@example.net\",\n \"ip\": \"::1\",\n \"app\": \"Compare\",\n \"editConfiguration\": true,\n \"allowDownload\": false,\n \"allowUpload\": true,\n \"allowMediaOpen\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/app","description":"Opens a standalone app (here Compare) that is not tied to a project and returns the one-time link to redirect the user to. Role: API.
Behaviour. Every call creates a new open-request (there is no project GUID, so nothing is re-opened) and a new one-time token. The user account for email is created on the fly if it doesn't exist.
Body (JSON). Takes the same fields as the project request (see Create Pro Project for the full table); the ones that matter for a standalone app:
\nSuccess response (200 OK, JSON string): https://<host>/V2/external?token=<token>.
Errors. Malformed JSON or a failure to create the user raises an error response.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","app"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c1f8f1fa-46f1-4736-9943-e503d602919d","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"95d2a368-57db-47c8-9ee2-9b9738755970\",\n \"email\": \"Linwood_Morissette58@example.com\",\n \"ip\": \"::1\",\n \"app\": \"Compare\",\n \"editConfiguration\": true,\n \"allowDownload\": false,\n \"allowUpload\": true,\n \"allowMediaOpen\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/app"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"https://sandbox.ooonatools-test.net/V2/external?token=MvevAOPXmXQAbnToflgQoMiStI6gtPD2MCu0ZZSJug\""}],"_postman_id":"e069e06a-e270-4680-95d1-6023c7e4e02f"},{"name":"Project Status","id":"55d2491f-0f71-47cd-be9c-d38e63878938","request":{"method":"GET","header":[],"url":"{{base_url}}/external/status/ff561538-fa84-4e36-8f94-de9d7c397d04","description":"Returns the current state of a project. Role: API. Read-only.
Route. id (required): project GUID.
Success response (200 OK, JSON):
Errors. 404 Not Found (empty body) when the project doesn't exist.
Returns per-user work and idle time for a project, aggregated by e-mail address. Role: API. Read-only. See Project Activity Raw Data for the individual records.
Route. id (required): project GUID.
Success response (200 OK, JSON): an object keyed by user e-mail; each value has:
An empty object means no activity was recorded.
\nErrors. 404 Not Found (empty body) when the project doesn't exist.
Returns the individual activity records of a project (the data Project Activity aggregates). Role: API. Read-only. Overlapping heartbeats are merged so every moment is counted once.
Route. id (required): project GUID.
Success response (200 OK, JSON array). Each record:
Errors. 404 Not Found (empty body) when the project doesn't exist.
Returns content statistics and time tracking for a project. Role: API. Read-only.
Route. projectId (required): project GUID.
Success response (200 OK, JSON):
Errors. 400 Bad Request (\"Project ID is required.\") for an empty id; 404 Not Found when the project doesn't exist.
Reports how much the current subtitles of a Review Pro project differ from its original (the originalProject captured when the review began). Role: API. Read-only. Subtitles are paired by time or by index depending on the project's sync mode, with the project's minimum subtitle duration as time tolerance.
Route. id (required): project GUID.
Success response (200 OK, JSON):
If the project has no originalProject the call still returns 200 OK, with error: \"Project does not contain an originalProject.\", totalSubtitles filled and everything else 0.
Errors. 404 Not Found (empty body) when the project doesn't exist.
Returns the first in-cue, last out-cue and subtitle count for several projects in one call. Role: API. Read-only (POST only because it takes a list).
Body. A JSON array of project GUID strings (required, non-empty), e.g. [\"guid1\",\"guid2\"].
Success response (200 OK, JSON array, in request order), one object per GUID:
Errors. 400 Bad Request (\"Project IDs are required.\") for an empty or missing array.
Returns the project as OOONA project JSON. Role: API. Read-only (POST by design; nothing is changed, the export is written to the security log).
Route. id (required): project GUID.
Query string.
\nSuccess response (200 OK): the JSON document serialized as a JSON string (the body is a quoted string with escaped quotes, so JSON-decode the body once more to get the object).
Errors. 404 Not Found (empty body) when the project doesn't exist. To hand the project to a system that cannot send your API token, see Export Project Signed URL.
Optional: v1 or auto. Omit for plain project JSON.
\n","type":"text/plain"},"key":"extendedProjectDataFile","value":"v1"},{"description":{"content":"true = return only the subtitles part.
\n","type":"text/plain"},"key":"asSubtitles","value":"false"}],"variable":[]}},"response":[{"id":"7a32ea4b-b9f2-4749-91dc-7b68d6e2deba","name":"Export Project","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/external/export/da7b4462-eaa9-4e1c-ae25-413f0df6cb76?asSubtitles=false","host":["{{base_url}}"],"path":["external","export","da7b4462-eaa9-4e1c-ae25-413f0df6cb76"],"query":[{"key":"extendedProjectDataFile","value":"v1","description":"Optional: v1 or auto. Omit for plain project JSON.","disabled":true},{"key":"asSubtitles","value":"false","description":"true = return only the subtitles part."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43212"}],"cookie":[],"responseTime":null,"body":"\"{\\n \\\"app\\\": \\\"EditPro\\\",\\n \\\"settings\\\": {\\n \\\"isRtl\\\": false,\\n \\\"showZeroParagraphInTable\\\": false,\\n \\\"Cavena\\\": {\\n \\\"translatedTitle\\\": null,\\n \\\"originalTitle\\\": null,\\n \\\"tapeNumber\\\": null,\\n \\\"startOfMessage\\\": null,\\n \\\"producer\\\": null,\\n \\\"translatedEpisodeTitle\\\": null,\\n \\\"comments\\\": null,\\n \\\"translator\\\": null,\\n \\\"useEmptyLinesInsteadOfVPos\\\": true\\n },\\n \\\"sub\\\": {\\n \\\"useFullStopDelimiter\\\": false\\n },\\n \\\"exportTimecodeOffset\\\": 0,\\n \\\"readingSpeedCountSpaces\\\": true,\\n \\\"defaultOutline\\\": \\\"Outline\\\",\\n \\\"autoComplyTimingGap\\\": false,\\n \\\"absolutePositioning\\\": true,\\n \\\"display\\\": {\\n \\\"boxLeftMargin\\\": 18,\\n \\\"boxOpacity\\\": 35,\\n \\\"outlineColor\\\": \\\"#000000\\\",\\n \\\"textColorOverride\\\": \\\"\\\",\\n \\\"shadowColor\\\": \\\"#000000\\\",\\n \\\"boxBottomMargin\\\": 0,\\n \\\"outlineWidth\\\": 2,\\n \\\"shadowOffsetX\\\": 0,\\n \\\"boxType\\\": \\\"None\\\",\\n \\\"letterBox\\\": \\\"None\\\",\\n \\\"shadowOffsetY\\\": 0,\\n \\\"antiAliasingType\\\": \\\"OuterNormal\\\",\\n \\\"antiAliasingColor\\\": \\\"#808080\\\",\\n \\\"isBold\\\": false,\\n \\\"shadow1\\\": {\\n \\\"size\\\": 0,\\n \\\"color\\\": \\\"#000000\\\",\\n \\\"offsetX\\\": 0,\\n \\\"offsetY\\\": 0,\\n \\\"blur\\\": 0,\\n \\\"opacity\\\": 100,\\n \\\"visible\\\": true\\n },\\n \\\"shadow2\\\": {\\n \\\"size\\\": 0,\\n \\\"color\\\": \\\"#000000\\\",\\n \\\"offsetX\\\": 0,\\n \\\"offsetY\\\": 0,\\n \\\"blur\\\": 0,\\n \\\"opacity\\\": 100,\\n \\\"visible\\\": false\\n },\\n \\\"boxColor\\\": \\\"#000000\\\",\\n \\\"boxTopMargin\\\": 0,\\n \\\"outlineType\\\": \\\"Outline\\\",\\n \\\"boxRightMargin\\\": 18\\n },\\n \\\"exportEmptySubtitles\\\": \\\"ask\\\",\\n \\\"defaultColor\\\": null,\\n \\\"font1\\\": \\\"Arial\\\",\\n \\\"minSubDuration\\\": 0.8333,\\n \\\"lineGap\\\": 1,\\n \\\"engine\\\": \\\"OoonaConvert\\\",\\n \\\"SMPTE_428\\\": {\\n \\\"fontEffect\\\": \\\"none\\\",\\n \\\"spacing\\\": \\\"0\\\",\\n \\\"fontEffectColor\\\": \\\"\\\",\\n \\\"feather\\\": \\\"no\\\",\\n \\\"exportFont\\\": false,\\n \\\"fadeUpTime\\\": 0,\\n \\\"font2URI\\\": \\\"\\\",\\n \\\"fadeDownTime\\\": 0,\\n \\\"startTime\\\": 0,\\n \\\"writeStartTime\\\": false,\\n \\\"effectSize\\\": \\\"0.01\\\",\\n \\\"encoding\\\": \\\"UTF-8\\\",\\n \\\"version\\\": \\\"ST428-7-2007\\\",\\n \\\"language\\\": \\\"English\\\",\\n \\\"fadeDownUp\\\": false,\\n \\\"reel\\\": 1,\\n \\\"displayType\\\": \\\"\\\",\\n \\\"fontURI\\\": \\\"\\\"\\n },\\n \\\"alignAllLines\\\": true,\\n \\\"ccSettings\\\": {\\n \\\"defaultOutline\\\": \\\"Outline\\\",\\n \\\"minSubDuration\\\": 0.8333,\\n \\\"alignAllLines\\\": true,\\n \\\"defaultAlign\\\": \\\"Center\\\",\\n \\\"graphicalLineLengthFormat\\\": null,\\n \\\"preventTimingOverlap\\\": true,\\n \\\"timingFramesGap\\\": 2,\\n \\\"maxTimingGap\\\": null,\\n \\\"defaultBox\\\": \\\"FixedBox\\\",\\n \\\"graphicalLineLength\\\": false,\\n \\\"maxSubDuration\\\": 7,\\n \\\"defaultJustification\\\": \\\"Left\\\",\\n \\\"screenLines\\\": 15,\\n \\\"graphicalLineLengthFont1\\\": null,\\n \\\"maxParagraphLines\\\": 2,\\n \\\"graphicalLineLengthFont2\\\": null,\\n \\\"doubleHeight\\\": false,\\n \\\"EBU\\\": {\\n \\\"standard\\\": \\\"OpenSubtitles\\\"\\n },\\n \\\"lineLength\\\": 32\\n },\\n \\\"mode\\\": \\\"Open\\\",\\n \\\"font2\\\": \\\"Arial\\\",\\n \\\"autoRecognizeTimeFormat\\\": true,\\n \\\"importTimecodeStart\\\": null,\\n \\\"autoBreakLine\\\": true,\\n \\\"exportFontSize\\\": 48,\\n \\\"timeFormat\\\": \\\"SMPTE\\\",\\n \\\"defaultAlign\\\": \\\"Center\\\",\\n \\\"RTF\\\": {\\n \\\"includeInOutCues\\\": false,\\n \\\"includeSubtitleNumber\\\": false,\\n \\\"includeReadingSpeedInformation\\\": false,\\n \\\"isBold\\\": false,\\n \\\"includeItalicsUnderline\\\": false,\\n \\\"includeAlignment\\\": false,\\n \\\"includeColorsFormatting\\\": false\\n },\\n \\\"graphicalLineLengthFormat\\\": null,\\n \\\"preventTimingOverlap\\\": true,\\n \\\"tagsExportFilter\\\": null,\\n \\\"defaultBotenVertical\\\": \\\"﹅\\\",\\n \\\"replaceEllipsis\\\": 0,\\n \\\"preserveSafeArea\\\": false,\\n \\\"shotChangesSnapAreaFrames\\\": 8,\\n \\\"timingFramesGap\\\": 2,\\n \\\"pacCharacterSet1\\\": \\\"Latin\\\",\\n \\\"replaceAsianQuotes\\\": {\\n \\\"align\\\": true,\\n \\\"lowerQuotes\\\": false,\\n \\\"replace\\\": 0\\n },\\n \\\"track2\\\": null,\\n \\\"filename\\\": \\\"\\\",\\n \\\"overrides\\\": null,\\n \\\"overrideReadingSpeed\\\": false,\\n \\\"pacCharacterSet2\\\": \\\"Latin\\\",\\n \\\"hideOutCue\\\": false,\\n \\\"ai\\\": {\\n \\\"asr\\\": {\\n \\\"maxSentenceWordGap\\\": null,\\n \\\"provider\\\": null\\n },\\n \\\"mt\\\": {\\n \\\"provider\\\": null\\n },\\n \\\"tts\\\": {\\n \\\"pitch\\\": \\\"0%\\\",\\n \\\"languageCode\\\": null,\\n \\\"speed\\\": \\\"0%\\\",\\n \\\"voiceId\\\": null,\\n \\\"provider\\\": null,\\n \\\"country\\\": null,\\n \\\"language\\\": null,\\n \\\"volume\\\": \\\"0%\\\",\\n \\\"voiceName\\\": null\\n }\\n },\\n \\\"track3\\\": null,\\n \\\"DLP\\\": {\\n \\\"importDetectCenterLeftAligned\\\": true,\\n \\\"reelNumber\\\": 1,\\n \\\"overrideTextColorValue\\\": \\\"#FFFFFF\\\",\\n \\\"overrideTextEffects\\\": false,\\n \\\"overrideTextColor\\\": false,\\n \\\"importOverrideSafeArea\\\": false,\\n \\\"exportImages\\\": false,\\n \\\"overrideEffectsColor\\\": \\\"#000000\\\",\\n \\\"overrideEffectsType\\\": \\\"none\\\",\\n \\\"toFrameRate\\\": \\\"24 fps\\\",\\n \\\"useStandardFont\\\": true,\\n \\\"applyVideoFrameRateConversion\\\": false,\\n \\\"fadeUp\\\": 20,\\n \\\"version\\\": \\\"DCSubtitle 1.0\\\",\\n \\\"title\\\": \\\"\\\",\\n \\\"presentationList\\\": false,\\n \\\"fadeDownUp\\\": false,\\n \\\"compressTrueTypeFont\\\": false,\\n \\\"fontURI\\\": \\\"\\\",\\n \\\"fadeDown\\\": 20,\\n \\\"exportFontFile\\\": false\\n },\\n \\\"maxTimingGap\\\": null,\\n \\\"audioScrubbingEnabled\\\": true,\\n \\\"exportComments\\\": false,\\n \\\"previewScriptSubtitles\\\": null,\\n \\\"track4\\\": null,\\n \\\"specialFont1\\\": \\\"\\\",\\n \\\"fps\\\": 23.976,\\n \\\"countryKey\\\": \\\"USA\\\",\\n \\\"characterHalfWidth\\\": false,\\n \\\"appendStartIndex\\\": null,\\n \\\"sami\\\": {\\n \\\"mediaFile\\\": \\\"test@.wmv\\\",\\n \\\"normalFontName\\\": \\\"Arial\\\",\\n \\\"createHTMLFile\\\": true,\\n \\\"sourceIdFont\\\": 1,\\n \\\"createASXFile\\\": true,\\n \\\"sourceIdBackColor\\\": \\\"FF0000\\\",\\n \\\"sourceIdFontSize\\\": 12,\\n \\\"htmlCWHeight\\\": 80,\\n \\\"sourceIdFontStyles\\\": \\\"1\\\",\\n \\\"exportSourceId\\\": false,\\n \\\"closePSyncTags\\\": false,\\n \\\"normalFontColor\\\": \\\"FFFFFF\\\",\\n \\\"sourceIdFontName\\\": \\\"Arial\\\",\\n \\\"useHTMLRefs\\\": true,\\n \\\"normalBackColor\\\": \\\"000000\\\",\\n \\\"sourceId\\\": 0,\\n \\\"htmlVideoHeight\\\": 280,\\n \\\"normalFontSize\\\": 12,\\n \\\"normalFontStyles\\\": \\\"1\\\",\\n \\\"language\\\": \\\"English - United Kingdom\\\",\\n \\\"htmlVideoWigth\\\": 320,\\n \\\"htmlVideoBorder\\\": 1,\\n \\\"sourceIdFontColor\\\": \\\"00FFFF\\\",\\n \\\"normalFontNumber\\\": 0\\n },\\n \\\"specialFont2\\\": \\\"\\\",\\n \\\"autoDetectLanguage\\\": false,\\n \\\"defaultBox\\\": \\\"None\\\",\\n \\\"replaceLongEmDash\\\": false,\\n \\\"assForBurning\\\": false,\\n \\\"recalculate890ScreenSettings\\\": \\\"Default\\\",\\n \\\"STL\\\": {\\n \\\"includeItalic\\\": true,\\n \\\"isBold\\\": false,\\n \\\"isItalic\\\": false,\\n \\\"isUnderline\\\": false,\\n \\\"userDefinedFont\\\": false,\\n \\\"useTabChars\\\": false\\n },\\n \\\"readingSpeedCps\\\": 17,\\n \\\"openSettings\\\": {\\n \\\"defaultOutline\\\": \\\"Outline\\\",\\n \\\"minSubDuration\\\": 0.8333,\\n \\\"alignAllLines\\\": true,\\n \\\"defaultAlign\\\": \\\"Center\\\",\\n \\\"graphicalLineLengthFormat\\\": null,\\n \\\"preventTimingOverlap\\\": true,\\n \\\"timingFramesGap\\\": 2,\\n \\\"maxTimingGap\\\": null,\\n \\\"defaultBox\\\": \\\"None\\\",\\n \\\"graphicalLineLength\\\": false,\\n \\\"maxSubDuration\\\": 7,\\n \\\"defaultJustification\\\": \\\"None\\\",\\n \\\"screenLines\\\": 11,\\n \\\"graphicalLineLengthFont1\\\": null,\\n \\\"maxParagraphLines\\\": 2,\\n \\\"graphicalLineLengthFont2\\\": null,\\n \\\"doubleHeight\\\": false,\\n \\\"EBU\\\": {\\n \\\"standard\\\": \\\"OpenSubtitles\\\"\\n },\\n \\\"lineLength\\\": 42\\n },\\n \\\"readingSpeedCountPunctuations\\\": false,\\n \\\"graphicalLineLength\\\": false,\\n \\\"shotChangeSnapEndFrames\\\": 2,\\n \\\"lockTimecodes\\\": false,\\n \\\"scriptSettings\\\": {\\n \\\"defaultOutline\\\": \\\"Outline\\\",\\n \\\"minSubDuration\\\": 0.8333,\\n \\\"alignAllLines\\\": false,\\n \\\"defaultAlign\\\": \\\"Left\\\",\\n \\\"graphicalLineLengthFormat\\\": null,\\n \\\"preventTimingOverlap\\\": true,\\n \\\"timingFramesGap\\\": 2,\\n \\\"maxTimingGap\\\": null,\\n \\\"defaultBox\\\": \\\"None\\\",\\n \\\"graphicalLineLength\\\": false,\\n \\\"maxSubDuration\\\": 7,\\n \\\"defaultJustification\\\": \\\"None\\\",\\n \\\"screenLines\\\": 999,\\n \\\"graphicalLineLengthFont1\\\": null,\\n \\\"maxParagraphLines\\\": 999,\\n \\\"graphicalLineLengthFont2\\\": null,\\n \\\"doubleHeight\\\": false,\\n \\\"EBU\\\": {\\n \\\"standard\\\": \\\"OpenSubtitles\\\"\\n },\\n \\\"lineLength\\\": 80\\n },\\n \\\"spellcheckRussianEnforceStrictYo\\\": null,\\n \\\"batchExport\\\": false,\\n \\\"spellcheckEnableGrammarErrors\\\": null,\\n \\\"importClearTargetColumn\\\": false,\\n \\\"defaultBackground\\\": null,\\n \\\"assOmitBottomCenterPositioning\\\": false,\\n \\\"adjustMixedAlignmentsWithSpaces\\\": false,\\n \\\"verticalLineLength\\\": 13,\\n \\\"previewFontSizeFromVideoFormat\\\": true,\\n \\\"exportAnnotations\\\": false,\\n \\\"maxSubDuration\\\": 7,\\n \\\"verticalSubtitlesGroupNumbers\\\": 2,\\n \\\"convertLeftToCenterLeft\\\": false,\\n \\\"exportUntimedSubtitles\\\": \\\"ask\\\",\\n \\\"autoSaveInterval\\\": 2,\\n \\\"removeAllStyling\\\": false,\\n \\\"defaultJustification\\\": \\\"None\\\",\\n \\\"timecodeFormat\\\": \\\"24 fps\\\",\\n \\\"autoPopulateStartTCFromDatFile\\\": null,\\n \\\"autoTCDuration\\\": 30,\\n \\\"videoFormat\\\": \\\"HD 1920x1080\\\",\\n \\\"DVD\\\": {\\n \\\"edlClipNameInSeparateLine\\\": false,\\n \\\"languageCode\\\": \\\"ENG\\\",\\n \\\"imagePrefix\\\": \\\"@\\\",\\n \\\"imageLocation\\\": \\\"@\\\",\\n \\\"scriptFileName\\\": \\\"@\\\",\\n \\\"imageFormat\\\": \\\"PNG_8\\\",\\n \\\"backgroundColor\\\": \\\"\\\",\\n \\\"exportCropImage\\\": false,\\n \\\"fcpScriptVersion\\\": 0,\\n \\\"ultech1080ScanType\\\": 1\\n },\\n \\\"importTimecodeOffset\\\": null,\\n \\\"isRtl2\\\": false,\\n \\\"defaultBotenHorizontal\\\": \\\"●\\\",\\n \\\"encoding\\\": \\\"utf-8\\\",\\n \\\"screenLines\\\": 11,\\n \\\"overrideFileName\\\": \\\"\\\",\\n \\\"aspectRatio\\\": \\\"16:9\\\",\\n \\\"rawScript\\\": {\\n \\\"importRawScript\\\": false,\\n \\\"lineDoesntEndOn\\\": \\\"\\\",\\n \\\"lineEndPunctuation\\\": \\\":;\\\",\\n \\\"maxLineLength\\\": 42,\\n \\\"maxLinesPerSubtitle\\\": 2,\\n \\\"subtitleEndPunctuation\\\": \\\".?!\\\"\\n },\\n \\\"timelineOffset\\\": 0,\\n \\\"exportTimeOffset\\\": null,\\n \\\"shotChangeSnapStartFrames\\\": 0,\\n \\\"tracksExportFilter\\\": null,\\n \\\"selectNextSubAfterSettingTC\\\": true,\\n \\\"autoOutCue\\\": false,\\n \\\"graphicalLineLengthFont1\\\": null,\\n \\\"maxParagraphLines\\\": 2,\\n \\\"SRT\\\": {\\n \\\"exportColors\\\": false,\\n \\\"smpte\\\": false,\\n \\\"exportRaised\\\": false,\\n \\\"exportAlignment\\\": false,\\n \\\"exportItalics\\\": true,\\n \\\"rtlReorderWithMarks\\\": false,\\n \\\"RTLReorder\\\": false,\\n \\\"exportUnderline\\\": false,\\n \\\"exportInBold\\\": false\\n },\\n \\\"readingSpeedType\\\": \\\"cps\\\",\\n \\\"includeVTTDirectionCodes\\\": false,\\n \\\"templateId\\\": \\\"48184225-0d63-4750-be79-8640fa185db9\\\",\\n \\\"autoComplyTiming\\\": true,\\n \\\"graphicalLineLengthFont2\\\": null,\\n \\\"assSeprateLineFormatting\\\": false,\\n \\\"dictionary\\\": \\\"English en-US\\\",\\n \\\"allowSplitParagraphs\\\": false,\\n \\\"detectEncoding\\\": true,\\n \\\"VTT\\\": {\\n \\\"topAlignmentIndex\\\": 1,\\n \\\"writeDirectionCodes\\\": false,\\n \\\"writeHorizontalPosition\\\": true,\\n \\\"skipCenterAligned\\\": true,\\n \\\"writeSubtitleNumbers\\\": false,\\n \\\"writeRegionSize\\\": false,\\n \\\"addBoxAlignment\\\": false,\\n \\\"skipBottomAligned\\\": true,\\n \\\"includeStyleSection\\\": false,\\n \\\"writeVerticalPositionInPercentage\\\": false,\\n \\\"writeVerticalPosition\\\": true\\n },\\n \\\"dontCountCompositionCharacters\\\": false,\\n \\\"spellcheckIgnoreWordsInUppercase\\\": null,\\n \\\"previewFont\\\": \\\"\\\",\\n \\\"convertBlackBoxesToTopAligned\\\": false,\\n \\\"autoDetectFps\\\": false,\\n \\\"hideSecondTimeline\\\": null,\\n \\\"format\\\": \\\"Ooona\\\",\\n \\\"doubleHeight\\\": false,\\n \\\"previewFontSize\\\": 48,\\n \\\"mediaStartTimecode\\\": 0,\\n \\\"EBU\\\": {\\n \\\"forceStartBoxControlCodeAtTheBeginningOfLine\\\": false,\\n \\\"startOfProgramme\\\": null,\\n \\\"programOriginalTitle\\\": \\\"\\\",\\n \\\"forceDoubleHeight\\\": true,\\n \\\"forceNormalHeightAtTheBeginningOfLine\\\": false,\\n \\\"revisionNumber\\\": 0,\\n \\\"languageCode\\\": \\\"00\\\",\\n \\\"forceOpenSubtitles\\\": false,\\n \\\"episodeTranslatedTitle\\\": \\\"\\\",\\n \\\"headerCodePage\\\": \\\"\\\",\\n \\\"includeColorCodes\\\": true,\\n \\\"episodeOriginalTitle\\\": \\\"\\\",\\n \\\"dontTreatMidRowItalicsAsSpace\\\": false,\\n \\\"forceDoubleHeightAtTheBeginningOfLine\\\": false,\\n \\\"editorsName\\\": \\\"\\\",\\n \\\"exportItalicsAsLessAndMore\\\": false,\\n \\\"useOpenModeBoxingControlCodes\\\": false,\\n \\\"includeBoxOnOffControlCodes\\\": true,\\n \\\"country\\\": \\\"\\\",\\n \\\"treatLessAndMoreThanAsItalics\\\": true,\\n \\\"characterCodeTable\\\": 0,\\n \\\"alignWithSpaces\\\": true,\\n \\\"referenceCode\\\": \\\"\\\",\\n \\\"forceTeletextSubtitles\\\": false,\\n \\\"allowNonStandardFpsInHeader\\\": false,\\n \\\"publisher\\\": \\\"\\\",\\n \\\"standard\\\": \\\"OpenSubtitles\\\",\\n \\\"programTranslatedTitle\\\": \\\"\\\"\\n },\\n \\\"validation\\\": {},\\n \\\"closedCaptions\\\": {\\n \\\"languageCode\\\": \\\"\\\",\\n \\\"blanksBetweenPopOn\\\": 2,\\n \\\"fixTimecodeOverrun\\\": false,\\n \\\"box\\\": \\\"None\\\",\\n \\\"isTunnel608\\\": false,\\n \\\"scriptVersion\\\": 0,\\n \\\"exportChannel\\\": 1,\\n \\\"isBold\\\": false,\\n \\\"style\\\": \\\"PopOn\\\",\\n \\\"extendedCharset\\\": true,\\n \\\"sccRemoveSpaceAfterControlCodes\\\": false,\\n \\\"chainSubtitles\\\": false,\\n \\\"doubleControlCodes\\\": true,\\n \\\"sccQuickTimeCompatible\\\": 0,\\n \\\"sccUseSemiColon\\\": false,\\n \\\"closedCaptionMode\\\": 7,\\n \\\"exportUpperCase\\\": false\\n },\\n \\\"importWordWrap\\\": true,\\n \\\"readingSpeedWpm\\\": 200,\\n \\\"autoPopulateFpsFromDatFile\\\": null,\\n \\\"language1\\\": \\\"English\\\",\\n \\\"teletextSettings\\\": {\\n \\\"defaultOutline\\\": \\\"Outline\\\",\\n \\\"minSubDuration\\\": 0.8333,\\n \\\"alignAllLines\\\": true,\\n \\\"defaultAlign\\\": \\\"Center\\\",\\n \\\"graphicalLineLengthFormat\\\": null,\\n \\\"preventTimingOverlap\\\": true,\\n \\\"timingFramesGap\\\": 2,\\n \\\"maxTimingGap\\\": null,\\n \\\"defaultBox\\\": \\\"FixedBox\\\",\\n \\\"graphicalLineLength\\\": false,\\n \\\"maxSubDuration\\\": 7,\\n \\\"defaultJustification\\\": \\\"Center\\\",\\n \\\"screenLines\\\": 23,\\n \\\"graphicalLineLengthFont1\\\": null,\\n \\\"maxParagraphLines\\\": 2,\\n \\\"graphicalLineLengthFont2\\\": null,\\n \\\"doubleHeight\\\": true,\\n \\\"EBU\\\": {\\n \\\"standard\\\": \\\"TeletextLevel1\\\"\\n },\\n \\\"lineLength\\\": 37\\n },\\n \\\"safeArea\\\": {\\n \\\"bottom\\\": 10,\\n \\\"left\\\": 10,\\n \\\"right\\\": 10,\\n \\\"top\\\": 10,\\n \\\"videoHeight\\\": 720,\\n \\\"videoWidth\\\": 1080\\n },\\n \\\"japaneseAgeRatingFixHiraganize\\\": false,\\n \\\"targetTrack\\\": 0,\\n \\\"convertFramerate\\\": \\\"none\\\",\\n \\\"language2\\\": \\\"English\\\",\\n \\\"lineLength\\\": 37,\\n \\\"exportOnlySelected\\\": false,\\n \\\"assDontIncludeNewLineAtTheEnd\\\": false,\\n \\\"zeroParagraphTemplateId\\\": \\\"\\\",\\n \\\"exportZero\\\": false,\\n \\\"ageRating\\\": null,\\n \\\"mergeAndSort\\\": false,\\n \\\"tableFont\\\": \\\"\\\",\\n \\\"convertNullCuesToZero\\\": false,\\n \\\"columns\\\": [],\\n \\\"autoTC\\\": true,\\n \\\"autoSnapToShotChange\\\": false,\\n \\\"recutAuto\\\": false,\\n \\\"flavor\\\": \\\"Ooona\\\",\\n \\\"TTML\\\": {\\n \\\"outlineColor\\\": \\\"black\\\",\\n \\\"simplifiedPositioning\\\": false,\\n \\\"rubyReserveOutside\\\": true,\\n \\\"outlineWidth\\\": 2,\\n \\\"languageCode\\\": \\\"\\\",\\n \\\"copyright\\\": \\\"\\\",\\n \\\"exportvPosAsTTAF1\\\": false,\\n \\\"outlineWidthUnit\\\": \\\"px\\\",\\n \\\"useEditable\\\": false,\\n \\\"burnedInTimeCode\\\": -1,\\n \\\"isBold\\\": false,\\n \\\"fontSize\\\": 100,\\n \\\"rtlReorder\\\": false,\\n \\\"customOutline\\\": false,\\n \\\"fontColor\\\": \\\"\\\",\\n \\\"ignoreFontProperties\\\": false,\\n \\\"imsc\\\": {\\n \\\"captionService\\\": \\\"F1C1CC\\\",\\n \\\"channel\\\": \\\"CC1\\\",\\n \\\"exportBoxed\\\": false,\\n \\\"includeSmpteInformation\\\": false,\\n \\\"programName\\\": \\\"\\\"\\n },\\n \\\"fontSizeUnit\\\": \\\"%\\\",\\n \\\"luminanceGain\\\": null,\\n \\\"includeStartTCAtTopDiv\\\": false,\\n \\\"EBUTT\\\": {\\n \\\"startOfProgramme\\\": null,\\n \\\"programOriginalTitle\\\": \\\"\\\",\\n \\\"revisionNumber\\\": 0,\\n \\\"episodeTranslatedTitle\\\": \\\"\\\",\\n \\\"headerCodePage\\\": \\\"\\\",\\n \\\"episodeOriginalTitle\\\": \\\"\\\",\\n \\\"editorsName\\\": \\\"\\\",\\n \\\"documentId\\\": \\\"\\\",\\n \\\"exportBox\\\": \\\"None\\\",\\n \\\"referenceCode\\\": \\\"\\\",\\n \\\"publisher\\\": \\\"\\\",\\n \\\"standard\\\": \\\"OpenSubtitles\\\",\\n \\\"programTranslatedTitle\\\": \\\"\\\"\\n },\\n \\\"ignoreInlineColors\\\": false,\\n \\\"lineHeight\\\": 100,\\n \\\"backColor\\\": \\\"\\\"\\n },\\n \\\"extension\\\": \\\"\\\",\\n \\\"customTxt\\\": {\\n \\\"subtitleDelimiterValue\\\": \\\"Issues a short-lived, signed download URL for a project's JSON, for a consumer that cannot send your API credentials. Role: API. Nothing is changed; the issue is written to the security log.
Route. id (required): project GUID. Body. None.
Success response (200 OK, JSON):
The id and expiry are covered by the signature, so the URL can't be pointed at another project or extended. Open it with a plain GET and no Authorization header (it is anonymous; see Download Signed Export): it returns the same project JSON as POST external/export/{id} with default options.
Errors. 404 Not Found (empty body) when the project doesn't exist.
Anonymous download of a project's JSON via the URL returned by Export Project Signed URL. No authentication is required: the signature in the query string is the credential (the collection's bearer token is simply ignored). You normally don't build this request yourself; use the url value from the signed-url response as is.
Route. id: project GUID (part of the signed data).
Query string.
\nSuccess response (200 OK): the project JSON, as Export Project returns it with default options.
Errors. 403 Forbidden for a bad, tampered or expired signature (one response for all of them, so the reason isn't revealed); 404 Not Found when the project no longer exists.
Unix expiry timestamp from the signed URL.
\n","type":"text/plain"},"key":"expires","value":"1760526000"},{"description":{"content":"Signature from the signed URL.
\n","type":"text/plain"},"key":"signature","value":"REPLACE_WITH_SIGNATURE"}],"variable":[]}},"response":[{"id":"6e974d16-5c96-4d63-9bed-55f7aac5c41e","name":"403 Invalid or expired","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/signed-export/da7b4462-eaa9-4e1c-ae25-413f0df6cb76?expires=1760526000&signature=REPLACE_WITH_SIGNATURE","host":["{{base_url}}"],"path":["external","signed-export","da7b4462-eaa9-4e1c-ae25-413f0df6cb76"],"query":[{"key":"expires","value":"1760526000","description":"Unix expiry timestamp from the signed URL."},{"key":"signature","value":"REPLACE_WITH_SIGNATURE","description":"Signature from the signed URL."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cb7cb5f0-216e-49c5-82f5-9ec7e20370a8"},{"name":"Close Project","id":"0f634d90-edb6-4137-9f20-efb46b080758","request":{"method":"POST","header":[],"url":"{{base_url}}/external/close/f58ed1f5-599e-4cf1-a48b-918e2ea3d9a7","description":"Closes a project: marks it closed and locked, both in the stored project file and on the project record, so it can no longer be edited. Role: API. Idempotent. The action is written to the security log. To re-open a closed project call the open endpoint with unlock: true (see Create Pro Project).
Route. id (required): project GUID. Body. None.
Success response. 200 OK with an empty body.
Errors. 404 Not Found (empty body) when the project doesn't exist.
Permanently deletes a project and records the deletion in the action log. Role: API. Not reversible. Deleting the same GUID twice returns 404 the second time.
Route. id (required): project GUID. Body. None.
Success response. 200 OK with an empty body.
Errors. 404 Not Found (empty body) when the project doesn't exist.
Duplicates one or more projects to new GUIDs, e.g. to hand a project on to the next step of a workflow. Role: API. Not idempotent: re-sending the same body fails because the targets now exist.
The whole project is copied. If the copy has both an originalProject and a masterProject, the master replaces the original and the master entry is removed.
Body. A JSON array (required, non-empty) of items, processed in order. Each item:
\nThe new project gets the target's id and app, fresh creation/modified dates, locked: false, progress 0 and an empty information line. The source project is not changed. The new project has no owner until it is opened for a user through the open endpoint.
Success response. 200 OK with an empty body.
Errors. An error response (the controller throws) when the array is empty (\"Request body is empty.\"), when a source is not found (\"Source project X not found.\") or when a target already exists (\"Target project X already exists.\"). Items processed before the failing one are not rolled back.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","copyProjects"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3258e5ee-26f3-496f-9636-5d721f5f8d3a","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"sourceProjectId\": \"16895ab5-d6a6-4466-afc5-7259540000b1\",\n \"sourceApp\": \"TranslatePro\",\n \"targetProjectId\": \"5a5b2bfb-d37b-4009-a65f-d86669374177\",\n \"targetApp\": \"ReviewPro\",\n \"oldTargetProjectId\": \"\",\n \"oldTargetApp\": \"\",\n \"newSourceProjectId\": \"\",\n \"newSourceApp\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/copyProjects"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"0a5844a1-a6f3-4b50-a3aa-a7082c009679","name":"Target already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"sourceProjectId\": \"db93428a-be68-4cdd-b4a7-3c251bfcf74c\",\n \"sourceApp\": \"TranslatePro\",\n \"targetProjectId\": \"e73a6d9f-534b-49cc-a36d-4acbce5fb04b\",\n \"targetApp\": \"ReviewPro\",\n \"oldTargetProjectId\": \"\",\n \"oldTargetApp\": \"\",\n \"newSourceProjectId\": \"\",\n \"newSourceApp\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/copyProjects"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"Target project 00000000-0000-0000-0000-000000000001 already exists.\"\n}"}],"_postman_id":"7f6227c9-2b06-4c4e-891e-7b97eba1f84e"},{"name":"Reject Project","id":"9e535fa9-5dfe-47c9-a0c5-7791b1b87faf","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"sourceProjectId\": \"edf5cf4f-409b-499d-bca2-a4a59b2c5335\",\n \"sourceApp\": \"TranslatePro\",\n \"targetProjectId\": \"015585d2-7d16-4841-972a-05afb918eee1\",\n \"targetApp\": \"ReviewPro\",\n \"oldTargetProjectId\": \"\",\n \"oldTargetApp\": \"\",\n \"newSourceProjectId\": \"\",\n \"newSourceApp\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/rejectProject","description":"Rejects a project back to an earlier workflow step: copies it to a new GUID like Copy Projects, but takes the content from its originalProject (the version the step started from) rather than its current state. Role: API. Not idempotent (the target must not exist).
Rejection semantics. Only applies when the source has an originalProject; otherwise this behaves like Copy Projects.
masterProject moved into originalProject.originalProject becomes the target project (and the source's masterProject, if any, becomes the target's originalProject).newSourceProjectId is set and the source app contains \"Translat\", the source is also copied unchanged to newSourceProjectId, so the work done in the target column is kept.Body. A JSON array (required, non-empty) of items, processed in order. Each item:
\nThe new project gets the target's id and app, fresh creation/modified dates, locked: false, progress 0 and an empty information line. The source project is not changed. The new project has no owner until it is opened for a user through the open endpoint.
Success response. 200 OK with an empty body.
Errors. An error response (the controller throws) when the array is empty (\"Request body is empty.\"), when a source is not found (\"Source project X not found.\") or when a target already exists (\"Target project X already exists.\"). Items processed before the failing one are not rolled back.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","rejectProject"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3c141f17-6017-4e77-9ece-fa96605bf638","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"sourceProjectId\": \"46e63f16-d055-4584-8a6a-ef11b5889c21\",\n \"sourceApp\": \"TranslatePro\",\n \"targetProjectId\": \"d8db6a0b-aa4d-40eb-8c87-da3c473a2546\",\n \"targetApp\": \"ReviewPro\",\n \"oldTargetProjectId\": \"\",\n \"oldTargetApp\": \"\",\n \"newSourceProjectId\": \"\",\n \"newSourceApp\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/rejectProject"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9e535fa9-5dfe-47c9-a0c5-7791b1b87faf"},{"name":"Merge Projects","id":"776abf89-d600-4496-87da-52d64cd446a5","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectGuids\": [\"959fb20a-6f76-474e-9088-f8a441d60463\", \"ca52739f-b461-4895-adfa-61d4158e5b98\", \"1c93d9b7-af17-48dd-9437-35f099e30afb\"],\n \"configurationGuid\": \"6c7d614a-64a9-4cbe-911c-8605205619de\",\n \"name\": \"Merged project name\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/merge/8b1b6dd0-5686-4a63-bddb-bf65e9c68b1e","description":"Merges several projects into one new project, typically the slices created with splitLimitation (see Create Pro Project). Role: API.
Route. id (required): the GUID you choose for the new merged project. It must not exist yet.
Body (JSON; property names are case-insensitive).
\nBehaviour. The new project starts as a copy of the first project; each project contributes the subtitles inside its splitLimitation range (all of them when none was set). The pieces are ordered by their first timed subtitle, concatenated and renumbered from 1. The new project is stored with progress 100 and the information line \"Merged: \". The source projects are unchanged. Each merged project is expected to have an open-request on record (i.e. to have been opened through the project endpoint); a project without one makes the call fail with an error response.
Success response (200 OK): the id of the new project (JSON string).
Errors. 400 Bad Request with \"Project already exists\" when {id} is taken, and \"No projects found\" when none of projectGuids exists.
Create, open, inspect, export and manage projects. All requests need the API role (bearer token).
Opening a project. POST external/project/{id} (the Create Pro, Translate Pro and Review Pro requests; POST external/MultilingualQC/{id?} for multilingual QC) returns a URL you redirect your user to. The ip field is optional and only stored with the request for auditing; it is not currently enforced when the session link is opened. The user is logged in as the account matching the e-mail address you supply, in a session limited to this project. If the user doesn't exist (identified by e-mail) the account is created on the fly, which keeps user configuration, hotkeys, layout and theme across sessions.\nThe GUID in the URL is the unique id of the project - you generate it and keep it. Calling the endpoint the first time with a GUID creates the project; calling it again with the same GUID opens the existing project for editing.
One user at a time. If the project belongs to a different e-mail and was saved within the last 180 seconds, the link opens it in view-only mode without transferring ownership. Add ?force=true to open it for the new user anyway (they may overwrite each other's work).
Working with a project. Status, activity, statistics, changes and boundaries are read-only. Export returns the project JSON; Export Project Signed URL returns a 15-minute anonymous download link (GET external/signed-export/{id}?expires=...&signature=..., no authentication needed - see Download Signed Export). Close locks a project, Delete removes it, Copy Projects / Reject Project duplicate a project to a new GUID for the next workflow step, and Merge Projects joins split projects back together.
| Key | \nName | \nDescription | \nIcon | \nColor | \n
|---|---|---|---|---|
| {{key}} | \n{{name}} | \n{{description}} | \n{{icon}} | \n{{color}} | \n
Lists the apps (tools) that can be opened with POST external/app. Use the key as the app value in that request.
None. Requires the API role.
200 OK with an array of apps, ordered by their index in the toolbox:
Only enabled apps that are not marked \"coming soon\" are returned, and the list is further filtered by the External.Apps.Filter app setting (comma separated keys, case-insensitive). When the setting is not set the default filter is CreatePro, ClosedCaptions, TranslatePro, Scripting, EditPro, Converter, Compare, Viewer, AudioDescription, MultilingualQC, so the sample response may include more apps than your instance returns.
The test script of this request renders the result as a table in the Postman Visualizer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","apps"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8974d16d-26d8-4ce9-a73d-a0e2d6412992","name":"List all apps","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/apps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1944"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"color\": \"#f9b57d\",\n \"description\": \"Create subtitles from scratch\",\n \"icon\": \"file\",\n \"key\": \"CaptionMaker\",\n \"name\": \"Create\"\n },\n {\n \"color\": \"#81c5d7\",\n \"description\": \"Translate subtitles file to different languages\",\n \"icon\": \"translate\",\n \"key\": \"Translator\",\n \"name\": \"Translate\"\n },\n {\n \"color\": \"#efefef\",\n \"description\": \"Create an audio description for a video\",\n \"icon\": \"audio-description\",\n \"key\": \"AudioDescription\",\n \"name\": \"Audio Description\"\n },\n {\n \"color\": \"#b9cf8a\",\n \"description\": \"Review a subtitle file, correct mistakes and share with clients\",\n \"icon\": \"pencil\",\n \"key\": \"Editor\",\n \"name\": \"Review\"\n },\n {\n \"color\": \"#BA7BA1\",\n \"description\": \"Convert multiple files between different subtitles formats\",\n \"icon\": \"batch-convert\",\n \"key\": \"BatchConvert\",\n \"name\": \"Batch Convert\"\n },\n {\n \"color\": \"#BFB8C9\",\n \"description\": \"Convert files using our API\",\n \"icon\": \"converter\",\n \"key\": \"ConvertApi\",\n \"name\": \"Convert API\"\n },\n {\n \"color\": \"#92a7be\",\n \"description\": \"Burn and encode subtitles on videos\",\n \"icon\": \"burn\",\n \"key\": \"Encoder\",\n \"name\": \"Burn & Encode\"\n },\n {\n \"color\": \"#A5C1D7\",\n \"description\": \"Convert subtitles for Yes.\",\n \"icon\": \"yes\",\n \"key\": \"YesConvert\",\n \"name\": \"Yes Convert\"\n },\n {\n \"color\": \"#9AEBDC\",\n \"description\": \"Create segmented versions of existing subtitles files.\",\n \"icon\": \"segmenter\",\n \"key\": \"SubtitleSlicer\",\n \"name\": \"Subtitle Slicer\"\n },\n {\n \"color\": \"#9795e3\",\n \"description\": \"Render TTML and IMSC files.\",\n \"icon\": \"xml\",\n \"key\": \"TTMLRenderer\",\n \"name\": \"TTML Renderer\"\n },\n {\n \"color\": \"#2283c5\",\n \"description\": \"Manage user accounts\",\n \"icon\": \"cog\",\n \"key\": \"Admin\",\n \"name\": \"Dashboard\"\n }\n]"}],"_postman_id":"8592c22e-5770-4a44-9307-fac4a9db662a"},{"name":"Get icons file URLs","id":"6085bf59-5b6e-4857-b716-9567a4cda2e5","request":{"method":"GET","header":[],"url":"{{base_url}}/external/icons","description":"Returns the absolute URLs of the OOONA icon font files, so you can render the icon names returned by GET external/apps in your own UI.
None. Requires the API role.
200 OK with a JSON object of absolute URLs:
A static JSON file (not an API controller) served by the web app that lists every toolbar/menu item key. Use these keys in the enabledMenuItems (whitelist) and disabledMenuItems (blacklist) fields of POST external/app and the project endpoints.
None. No request body or parameters.
\n200 OK with a JSON array of strings. Top-level menus (e.g. project, edit, view) are followed by their items. Enabling a sub-item without its parent menu key will not show it. The exact list can change between versions, so fetch it from your own instance.
Opens a Create Pro session for a user: you send the user's email, the API returns a single-use URL that logs them in with only this tool available. The user sees every project they created in this tool and can create new ones. Use enabledMenuItems / disabledMenuItems to filter the toolbar (see the examples).
The body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Opens a Translate Pro session for a user: you send the user's email, the API returns a single-use URL that logs them in with only this tool available.
\nThe body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Opens a Review (Edit Pro) session for a user: you send the user's email, the API returns a single-use URL that logs them in with only this tool available.
\nThe body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Opens a Convert session for a user: you send the user's email, the API returns a single-use URL that logs them in with only this tool available.
\nThe body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Opens an Audio Description session for a user: you send the user's email, the API returns a single-use URL that logs them in with only this tool available.
\nThe body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Opens the Dashboard (Admin app, user and account management) for a user. Only the required fields are needed; the permission flags are not relevant for the dashboard. Returns a single-use URL.
The body uses the same model as the project endpoints, so every other property of that model (configuration GUIDs/JSON, video, subtitlesUrl, ...) is accepted and stored with the request, but they are only meaningful for project sessions (see the Project folder). Property names are case-insensitive.
200 OK with a JSON string: the single-use session URL (/V2/external?token=...). Redirect the user to it immediately (or open it in a new tab); do not cache it. The token is valid for 24 hours, and one session per email is supported at any given time.
An unreadable or empty body is not handled specially and results in a 500 server error. The endpoint requires the API role.
Creates a read-only, single-use video player link for a video. Downloads are always disabled for the session.
\nIf no user holds the supplied email one is created automatically (same as POST external/app).
200 OK with { \"url\": \"https://.../V2/player?token=...\" }: redirect the user to this URL. The link is single-use and expires 5 minutes after it was created.
Requires the API role.
This folder contains requests to open a session for a specific tool (aka app), plus helpers for discovering the apps and their icons.
\nPOST external/app returns a single-use URL you should redirect your user to. The user will be logged in as the user matching the email address you supplied (created automatically if it does not exist). This starts a session with only a single tool available, but the user can see every project they worked on in this tool (everything that was opened with their email address) and can create new projects.
POST external/player works the same way for a read-only video player.
The enabledMenuItems / disabledMenuItems request fields accept the keys listed in toolbar-options.json. All requests in this folder require the API role.
Returns the security events recorded for the given projects: exports, project deletions and suspicious-activity events.
\nThe body is a JSON array of project GUIDs (strings). Events are matched against the project id (for exports and deletions) or the project id stored on suspicious-activity events; user ids are not matched.
\n[\"<project-guid>\", \"<project-guid>\"]\n200 OK with an array of events (an empty array if nothing matches):
A malformed body returns an error status. Requires the API role.
This folder contains security-related endpoints, such as the security log of exports and project deletions. All requests require the API role.
Returns the full dashboard statistics of the instance: online users, last/this month and per-day activity, past months and general system health.
\nNone. Requires the API role.
200 OK with an object:
Accounts with an @ooona.net email are excluded from the statistics. The response can be large and slow on busy instances; for a lightweight summary use GET external/stats.
Returns a compact snapshot of the instance's current activity and licence usage.
\nNone. Requires the API role.
200 OK with an object:
Returns the instance's system health and resources (disks, memory, database size, version).
\nNone. Requires the API role. For an unauthenticated liveness probe use GET external/healthy (returns the text OK, or a 500 when a disk is full or the database schema does not match; the optional query ?db=false (default true) skips the database check, so only the disk-space check runs and the model compatibility check against the database is not performed) and GET version (returns the version); both allow anonymous calls.
200 OK with an object:
If collecting the data fails, the call still returns 200 with an empty object (all fields null/false) and the error is logged server side.
Returns a report of the users who logged in during a month, as an Excel workbook.
\nRequires the API role. System users are excluded. A user is included when an activity of theirs starts or ends in the requested month.
200 OK. The workbook is returned as a base64 encoded string inside a JSON response (the raw file bytes are serialized by the JSON formatter): decode it and save it as the Excel file. One row per user with the columns Username, Email and First_Month_Login (the user's first login timestamp in that month).
A non-numeric year or month is rejected with 404/400 by routing.
Year, e.g. 2026
\n","type":"text/plain"},"type":"any","value":"2026","key":"year"},{"id":"9488c9e4-75eb-49c8-beed-2c124b7891c2","description":{"content":"Month number, 1-12
\n","type":"text/plain"},"type":"any","value":"6","key":"month"}]}},"response":[{"id":"8f200085-04d9-4079-a373-d55d72ab3e16","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/monthUsersReport/2026/6","host":["{{base_url}}"],"path":["external","monthUsersReport","2026","6"],"variable":[{"key":"year","value":"2026","description":"Year, e.g. 2026"},{"key":"month","value":"6","description":"Month number, 1-12"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"UEsDBBQABgAIAAAAIQ...(base64 of the Excel file)...\""}],"_postman_id":"0c25b1f0-7fdd-4bcb-a1ff-ea7c94634e42"}],"id":"5edbdcbd-e759-401f-b7f7-2546c86b2930","description":"Instance statistics, health and reports. Requires the API role.
Total Convert / QC / Conform API usage counts recorded under this API key (for the API role the principal id is the secret-key id), over a date range.
Roles: API or UserAPI.
200 OK. JSON property names are camelCase and listed in alphabetical order:
400 with a message when from/to cannot be parsed (Invalid 'from' date: ...) or when from is later than to ('from' must be earlier than or equal to 'to'.).
Start of the range (UTC). Optional, defaults to the first day of the current month.
\n","type":"text/plain"},"key":"from","value":"2026-06-01"},{"description":{"content":"End of the range (UTC), exclusive. Optional, defaults to now.
\n","type":"text/plain"},"key":"to","value":"2026-06-30"}],"variable":[]}},"response":[{"id":"e22c50a7-fedf-408b-a8f3-224d377993a1","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/usage/summary?from=2026-06-01&to=2026-06-30","host":["{{base_url}}"],"path":["external","usage","summary"],"query":[{"key":"from","value":"2026-06-01","description":"Start of the range (UTC). Optional, defaults to the first day of the current month."},{"key":"to","value":"2026-06-30","description":"End of the range (UTC), exclusive. Optional, defaults to now."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"conform\": 45,\n \"convert\": 1200,\n \"from\": \"2026-06-01T00:00:00Z\",\n \"qc\": 300,\n \"to\": \"2026-06-30T00:00:00Z\",\n \"total\": 1545\n}"},{"id":"1dd58781-fb3e-4693-8dfa-d9c21775674c","name":"400 Invalid date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/usage/summary?from=2026-06-01&to=2026-06-30","host":["{{base_url}}"],"path":["external","usage","summary"],"query":[{"key":"from","value":"2026-06-01","description":"Start of the range (UTC). Optional, defaults to the first day of the current month."},{"key":"to","value":"2026-06-30","description":"End of the range (UTC), exclusive. Optional, defaults to now."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Invalid 'from' date: 'yesterday'. Use yyyy-MM-dd or an ISO 8601 date/time.\"\n}"}],"_postman_id":"db92d003-e9ca-472c-9315-1aa0af30a5f1"},{"name":"Usage records","id":"29658743-a2ee-4d2e-a15a-4b3d8414c514","request":{"method":"GET","header":[],"url":"{{base_url}}/external/usage?from=2026-06-01&to=2026-06-30&skip=0&take=1000","description":"Individual API usage records recorded under this API key (for the API role the principal id is the secret-key id), over a date range, with paging.
Roles: API or UserAPI.
200 OK. JSON property names are camelCase and listed in alphabetical order:
400 when from/to cannot be parsed or from is later than to (same messages as GET external/usage/summary).
Start of the range (UTC). Optional, defaults to the first day of the current month.
\n","type":"text/plain"},"key":"from","value":"2026-06-01"},{"description":{"content":"End of the range (UTC), exclusive. Optional, defaults to now.
\n","type":"text/plain"},"key":"to","value":"2026-06-30"},{"description":{"content":"Records to skip (default 0)
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Page size (default 1000, max 10000)
\n","type":"text/plain"},"key":"take","value":"1000"}],"variable":[]}},"response":[{"id":"2d9c0f7e-1991-49cc-bcb0-8467b839730f","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/usage?from=2026-06-01&to=2026-06-30&skip=0&take=1000","host":["{{base_url}}"],"path":["external","usage"],"query":[{"key":"from","value":"2026-06-01","description":"Start of the range (UTC). Optional, defaults to the first day of the current month."},{"key":"to","value":"2026-06-30","description":"End of the range (UTC), exclusive. Optional, defaults to now."},{"key":"skip","value":"0","description":"Records to skip (default 0)"},{"key":"take","value":"1000","description":"Page size (default 1000, max 10000)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"from\": \"2026-06-01T00:00:00Z\",\n \"items\": [\n {\n \"ip\": \"203.0.113.10\",\n \"keyName\": \"Production key\",\n \"operation\": \"Convert\",\n \"sourceType\": \"SRT\",\n \"targetType\": \"VTT\",\n \"time\": \"2026-06-12T09:41:07.457\"\n },\n {\n \"ip\": \"203.0.113.10\",\n \"keyName\": \"Production key\",\n \"operation\": \"QC\",\n \"sourceType\": \"SRT\",\n \"targetType\": null,\n \"time\": \"2026-06-12T09:45:31.123\"\n }\n ],\n \"skip\": 0,\n \"take\": 1000,\n \"to\": \"2026-06-30T00:00:00Z\",\n \"total\": 2,\n \"truncated\": false\n}"}],"_postman_id":"29658743-a2ee-4d2e-a15a-4b3d8414c514"}],"id":"b8fc9ece-89fa-4f97-bba1-b4c5edbbf8d8","description":"Convert / QC / Conform API usage of the caller. Both API and UserAPI keys may call these requests. For the API role the principal id is the secret-key id, so usage is recorded under this API key (not under an account that owns the key); a UserAPI key reads the usage of its user and client.
Date parameters are optional, interpreted as UTC, and accept yyyy-MM-dd or an ISO 8601 date/time. When omitted the range is the current month so far (first of the month to now). Invalid dates or from later than to return 400.
Lists every application setting.
\nNone. Requires the API role.
200 OK with an array of settings:
Returns a single application setting by key.
\nRequires the API role.
200 OK with the setting:
404 Not Found when no setting has that key.
Setting key
\n","type":"text/plain"},"type":"any","value":"External.Apps.Filter","key":"key"}]}},"response":[{"id":"2bfe1a06-cdac-4e64-bfd6-a920f47013a9","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/appSettings/External.Apps.Filter","host":["{{base_url}}"],"path":["external","appSettings","External.Apps.Filter"],"variable":[{"key":"key","value":"External.Apps.Filter","description":"Setting key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Key\": \"External.Apps.Filter\",\n \"Name\": \"External.Apps.Filter\",\n \"Value\": \"CreatePro,TranslatePro,EditPro\",\n \"Type\": \"string\",\n \"Sensitive\": false,\n \"LastModified\": \"2026-06-01T10:15:00Z\"\n}"},{"id":"881beae7-5279-4f02-b3ad-e555421eef35","name":"404 Unknown key","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/appSettings/Unknown.Key","host":["{{base_url}}"],"path":["external","appSettings","Unknown.Key"],"variable":[{"key":"key","value":"External.Apps.Filter","description":"Setting key"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bacfb00c-7004-4b4a-b8ce-798914243f76"},{"name":"Update app setting","id":"1a98a69e-e44a-41ab-9dfb-2a61ee2f089a","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Key\": \"External.Apps.Filter\",\n \"Name\": \"External.Apps.Filter\",\n \"Value\": \"CreatePro,TranslatePro,EditPro\",\n \"Type\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/appSettings","description":"Creates or updates (upsert by Key) an application setting. Clears the instance cache so the change takes effect. Changes are written to the security log.
Sensitive and LastModified in the body are ignored. If the setting is sensitive and Value is the masked value returned by the GET requests, the update is ignored and the stored value is kept (the response is still 200).
200 OK with the resulting setting (same shape as GET external/appSettings/{key}, value masked if sensitive).
400 with Key is required. when the body is missing or Key is empty. Requires the API role.
Read and update the instance's application settings (the same settings table the admin \"Toolkit Settings\" page edits). Requires the API role.
Sensitive values (API keys, secrets, tokens, passwords, credential JSON) are masked in responses and flagged with \"Sensitive\": true. If a masked value is echoed back in an update, the stored secret is kept and the update is ignored. Updating a setting clears the instance cache.
Changes the email address of an existing user. The account is found purely by the source address, so double check from: a wrong value renames whichever account holds it. The user name is changed too when it equals the old email. Every outcome is written to the security log.
200 OK with an empty body when the email was updated.404 Not Found when no user holds the from address.400 Bad Request when another user already holds the to address (the message names the date that account was created).Requires the API role.
User account maintenance. Requires the API role.
Instance information, API usage and application settings for your OOONA Tools instance.
\nUnless noted otherwise, these requests require the API role (the Usage requests also accept UserAPI).
Role: API.
Starts a batch export session: one or many existing projects exported to files in one go, using a saved batch export configuration. The call stores the request and returns a URL; send your user to it. The hosted page loads the listed projects, exports each of them (applying the configuration's export settings and the file naming convention), and, when finished, delivers the result according to the bucket options below. The exports themselves are driven by that page through further endpoints (external/batchExport/project/..., .../export/{id}, .../export/status/{id}, .../finish/{id}), which are used by the page's own session and are not part of the API-role surface.
Prerequisites: a batch export configuration created with POST /external/configuration/{guid} with configurationType: BatchExport (its {guid} goes in items[].configurationGuid), and optionally a file naming convention (POST /external/fileNaming/{guid}) referenced by projects[].fileNamingId. The user (email) is created as an external user when it does not exist yet. The request is written to the action log.
Body (JSON)
\nitems[]
items[].projects[]
Output: 200 OK with a JSON string, the URL to send the user to: \"https://<host>/V2/external?token=<token>\". 404 Not Found when an items[].configurationGuid does not match a known configuration. A malformed body or a missing email results in an error response. 401/403 without the API role.
Batch export exports multiple projects to files in one go, using an existing batch export configuration and optionally a file naming convention.
\nPOST /external/batchExport registers the batch and returns the URL of the hosted export page. From there the page's own session continues the flow (fetching each project, exporting it, polling long-running exports and finishing/zipping/delivering to the bucket); those follow-up routes are not part of the API-role surface and are not documented here.
Role: API.
Starts a file naming convention editing session for the {guid} in the URL and returns a URL to send your user to. The user composes the naming pattern in a hosted editor (choosing which fields make up the file name, their order, separators and so on) and saves it; the result is stored as a template under {guid}. Use that id as fileNamingId on the projects of a batch export (POST /external/batchExport) to name the exported files.
Nothing is stored as a template by this call. It stores a one-off request and returns the URL. Calling it again with the same {guid} updates that same request and issues a fresh token (so it also works to re-open the editor). When the user saves, the stored template is created or updated and, if you gave a callbackUrl, it is POSTed a plain-text body containing the naming pattern's sample file name.
Route
\nBody (JSON)
\nOn a re-POST for an existing {guid} only the properties present in the body are changed.
Output: 200 OK with a JSON string, the URL to send the user to: \"https://<host>/V2/external?token=<token>\". A missing or invalid API token yields 401/403; malformed JSON yields an error response.
File naming conventions define how files are named when exported, so that batch exports match the naming rules required for delivery.
\nPOST /external/fileNaming/{guid} creates or opens a convention for editing and returns the URL of the hosted editor. The saved convention is then referenced by fileNamingId in the projects of a batch export (see the Batch export folder).
Lists the AI engines available to the caller, with the features each one supports. Roles: API, UserAPI. The response is cached for one day on the server and the client; engines disabled on the instance (or by pricing configuration) are left out. The list is sorted by name.
Input: none.
\nOutput (200): array of
\nThe test script stores all keys in the collection variable ai_engines (used by Engine languages).
Lists the languages an engine supports. Roles: API, UserAPI. Cached for one day.
Route: engine (required): the engine key from Get engines (TYPE_Name, case-insensitive). In this request the value comes from the variable random_ai_engine, picked at random from the engines saved by Get engines (run it first; falls back to MT_AWS).
Output (200): array of { source, target[] }.
Errors: 404 Not Found with an empty body (not the generic routing message) when the engine is unknown or disabled on the instance (engines disabled only by their pricing configuration are hidden from Get engines but still answer here).
Estimates what a job would cost before running it. Nothing is created or charged. Role: API.
The body is the same shape as the run requests but only these fields are read. How the price is computed depends on the engine's price factor:
\nBody fields
\nOutput (200)
\nErrors (all 400): Engine is required.; Engine should be in the format TYPE_NAME (e.g. MT_AWS, ASR_OOONA).; Engine '<key>' not found or is disabled.; Engine '<key>' has no pricing configuration.; Engine '<key>' uses Second-based pricing. Please provide duration (seconds).; ... Please provide previousProjectGuid or projectGuid.; Project '<id>' not found.; Project has no text content to estimate pricing.
Starts a speech-to-text (ASR / transcription) job on a video and creates a project that receives the transcript. Role: API.
The {id} in the URL becomes the project id (unless projectGuid is in the body) and the external request id; omit it to have a GUID generated. The call returns as soon as the job is accepted: poll Get job status or provide a callbackUrl, then fetch the transcript with Get job result.
Behaviour
\nTranscribe (inferred from an ASR_ engine, or set \"action\": \"Transcribe\").force=true.force query param or body field), a previous successful job with the same engine, video URL (query string ignored) and language is reused: the result is applied to the project at once, a 0-cost job record is created, and the response already has status: Success.duration so it is known up front. Use Estimate price to preview.Route: id (optional, string): project / request id; a GUID is generated when omitted.
Query parameters
\nBody fields (ASR)
\nSee the folder description for the remaining shared fields. engineOptions is not read for ASR by this action.
Errors: 400 Automated job for project id ... already exists., 400 engine/action missing or unrecognised, 500 engine failure.
Output (200): a job object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","511e51fd-0315-49f0-a545-2df1e98cd259"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"},{"disabled":true,"description":{"content":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.
\n","type":"text/plain"},"key":"realtime","value":"false"}],"variable":[]}},"response":[{"id":"b6fc8016-30ea-482f-aa6f-aa6567b51459","name":"200 OK - job started","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"engine\": \"ASR_AWS\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"duration\": 96,\n \"projectGuid\": \"296980df-48d6-4e05-acb2-b1aef45f3c65\",\n \"projectName\": \"Amyloidosis Awareness - transcript\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"format\\\": \\\"TT\\\" }\",\n \"startTC\": \"00:00:00:00\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/9693f13f-793d-4c7e-8e03-424978d1f521","host":["{{base_url}}"],"path":["external","automate","e40d9684-06a2-4943-abd2-a85e76cad6c4"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Running\",\n \"progress\": 0,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"67b8dbe4-314c-4b7b-b291-88b75fe4e8af","name":"200 OK - cached result","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"engine\": \"ASR_AWS\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"duration\": 96,\n \"projectGuid\": \"aac67772-7f8c-4c4c-8549-79584173b9f4\",\n \"projectName\": \"Amyloidosis Awareness - transcript\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"format\\\": \\\"TT\\\" }\",\n \"startTC\": \"00:00:00:00\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/12d74380-4d68-4d89-a44d-63505d770b9f","host":["{{base_url}}"],"path":["external","automate","778b9b7b-af80-413d-8200-3ec592c67894"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Success\",\n \"progress\": 100,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": \"2026-10-15T09:02:40Z\",\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"Cached result\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Success\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"3d40bfb9-73d0-4bab-9f0b-f23460e63c86","name":"400 Job already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"engine\": \"ASR_AWS\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"duration\": 96,\n \"projectGuid\": \"f45244da-fbaf-49f3-bd95-210e4c6faf2f\",\n \"projectName\": \"Amyloidosis Awareness - transcript\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"format\\\": \\\"TT\\\" }\",\n \"startTC\": \"00:00:00:00\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/2204d618-4328-4a36-a9b5-e93c969b471a","host":["{{base_url}}"],"path":["external","automate","3335e3d0-0483-4fd6-86f7-df0206e7655f"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Automated job for project id 6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10 already exists.\",\n \"ExceptionMessage\": \"Automated job for project id 6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10 already exists.\",\n \"ExceptionType\": \"ArgumentException\",\n \"ActionName\": \"Automate\",\n \"ControllerName\": \"ExternalAutomate\",\n \"StackTrace\": \"ExternalAutomateController.cs:144\"\n}"},{"id":"da1687b1-5e1c-4b7f-89c6-a03f4d43853d","name":"400 Missing engine","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/e0177fc7-0f89-4952-b35e-398d85d0e87c","host":["{{base_url}}"],"path":["external","automate","ae60a340-7160-4fbc-81a9-1a8e622f503c"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"You must specify either engine or action\",\n \"ExceptionMessage\": \"You must specify either engine or action\",\n \"ExceptionType\": \"ArgumentException\",\n \"ActionName\": \"Automate\",\n \"ControllerName\": \"ExternalAutomate\",\n \"StackTrace\": \"ExternalAutomateController.cs:104\"\n}"}],"_postman_id":"5c57f59d-0c32-46a4-aab1-190ca91c8d5b"},{"name":"Run MT","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Set lastJobId\", () => {\n const responseJson = pm.response.json();\n const id = responseJson.id || responseJson.jobId;\n if (id) {\n pm.environment.set('lastJobId', id);\n }\n});"]}}],"id":"6e4d77f0-2773-4df7-bf71-cb3b3155c530","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"9c0e789e-930b-471f-b42d-8b43ba20484c\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/automate/d21eac9f-d34f-4bfe-97be-33db13e1c4f0","description":"Starts a machine translation job and creates a project that receives the translated text. Role: API.
Without realtime the call returns right after the job is accepted: poll Get job status, or wait for callbackUrl, then use Get job result (srt, vtt, ooona, json). To get the translated file in the same call use Run MT realtime.
Route: id (optional, string): project / request id; a GUID is generated when omitted.
Source text: give either previousProjectGuid (an existing project, e.g. a finished ASR project, whose subtitles are copied) or subtitlesUrl (a file that is downloaded and imported; subtitlesFileName is optional; the format comes from importConfigurationJson.format, or from the file extension when that is missing or a generic project format like OoonaProject). Omitted paragraphs are not translated. With no text at all the call returns 400 Original text is not provided. Nothing to translate.
Languages: source = importConfigurationJson.language1, target = exportConfigurationJson.language1 (language names as returned by Engine languages).
Body fields (MT)
\nCache: unless forced, a previous successful job with the same engine, previousProjectGuid, source and target language is reused (0-cost job record, immediate Success).
Query parameters
\nErrors: 400 Original text is not provided. Nothing to translate, 400 job already exists, 400 unknown engine, 500 engine failure (in realtime mode: the job error text).
Output (200): a job object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","a4da13d6-b729-420e-add6-6bd0a3da6bd7"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"},{"disabled":true,"description":{"content":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.
\n","type":"text/plain"},"key":"realtime","value":"false"}],"variable":[]}},"response":[{"id":"5a9f7354-a8b9-4a81-b654-0e3e9f7456d5","name":"200 OK - job started","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"eb109a37-5ae9-4647-b87d-1186a06ce34c\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/530f1c62-b30a-41b3-b66e-6620ffef799d","host":["{{base_url}}"],"path":["external","automate","c5893bdf-c76d-4306-91f3-102721d290fb"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"Translation\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Spanish\",\n \"status\": \"Running\",\n \"progress\": 0,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"AWS Translation job 0.00001500$x11380 characters\",\n \"transactionAmount\": 0.17,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Character\",\n \"transactionPricePerUnit\": 1.5e-05,\n \"transactionUnits\": 11380.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"0849670d-48c5-46f2-8d11-ad4af3f8e389","name":"200 OK - cached result","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"13f8561c-b784-4134-a8a7-a15329b3c821\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/8bcd794d-73a9-42f0-8748-c2e7894d9169","host":["{{base_url}}"],"path":["external","automate","10619754-b189-4f26-9a36-34b78da95b43"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"Translation\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Spanish\",\n \"status\": \"Success\",\n \"progress\": 100,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": \"2026-10-15T09:02:40Z\",\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"Cached result\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Character\",\n \"transactionPricePerUnit\": 1.5e-05,\n \"transactionUnits\": 11380.0,\n \"transactionStatus\": \"Success\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"2d0565ed-2ecf-425e-b793-721951cc8416","name":"400 Nothing to translate","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"ce50e6a4-b2e4-43f5-91a4-c9ced3b739ca\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/363b4e77-b124-4afe-b86a-9a38567dee14","host":["{{base_url}}"],"path":["external","automate","11d76a09-9d85-4e4e-9e23-77d7b9151c63"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Original text is not provided. Nothing to translate\""}],"_postman_id":"6e4d77f0-2773-4df7-bf71-cb3b3155c530"},{"name":"Run MT realtime","id":"ecef6916-4386-402f-87b5-a60d5e110b57","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"0eb440b1-37c6-44b4-a540-3f9881ae2a84\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/automate/b99cc0c1-7d6b-4062-a5d1-7de265f3b5ef?realtime=true","description":"Same as Run MT, but with realtime=true: the call waits up to 10 seconds for the translation and, if it finished, answers with the translated file (attachment, format taken from exportConfigurationJson.format / extension) instead of a job object. Role: API.
200 with the file body and Content-Disposition: attachment; filename=....200 with { jobId, status, projectId, statusUrl, transactionAmount, transactionCurrency, transactionDetails }; continue with Get job status / Get job result.If the export configuration has no format/extension, the cached path returns the job object instead of a file.
\nRoute: id (optional, string): project / request id; a GUID is generated when omitted.
Source text: give either previousProjectGuid (an existing project, e.g. a finished ASR project, whose subtitles are copied) or subtitlesUrl (a file that is downloaded and imported; subtitlesFileName is optional; the format comes from importConfigurationJson.format, or from the file extension when that is missing or a generic project format like OoonaProject). Omitted paragraphs are not translated. With no text at all the call returns 400 Original text is not provided. Nothing to translate.
Languages: source = importConfigurationJson.language1, target = exportConfigurationJson.language1 (language names as returned by Engine languages).
Body fields (MT)
\nCache: unless forced, a previous successful job with the same engine, previousProjectGuid, source and target language is reused (0-cost job record, immediate Success).
Query parameters
\nErrors: 400 Original text is not provided. Nothing to translate, 400 job already exists, 400 unknown engine, 500 engine failure (in realtime mode: the job error text).
Wait up to 10 s and return the translated file.
\n","type":"text/plain"},"key":"realtime","value":"true"},{"disabled":true,"description":{"content":"Optional. Bypass the cache / allow a repeat job.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"6a164a3a-9197-456e-9e01-7374db26767e","name":"200 OK - file","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Translate\",\n \"engine\": \"MT_AWS\",\n \"projectGuid\": \"464b77d6-960f-4284-92b8-49304f1deaad\",\n \"projectName\": \"Meridian - Spanish\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.Transcribe.json\",\n \"subtitlesFileName\": \"Meridian.en.Transcribe.json\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"OoonaProject\\\" }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"force\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/7f19e4a4-cee8-438f-b041-3a9cab39b3d1?realtime=true","host":["{{base_url}}"],"path":["external","automate","a03ff50b-a198-4d30-aecc-ca54de111b50"],"query":[{"key":"realtime","value":"true","description":"Wait up to 10 s and return the translated file."},{"key":"force","value":"false","description":"Optional. Bypass the cache / allow a repeat job.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"\n\n \nAsí que estos tipos simplemente
desaparecieron.
Sí, en ese tramo de carretera justo
encima de El Matador. ¿Lo conoces?
Starts a Unified AI job: one video in, and per requested language a finished project out (transcript, translation, subtitles, synopsis, names, glossary, ... depending on the engine and the features you switch on). Role: API.
The {id} in the URL is the id of the root (source-language) project and of the request; omit it for a generated GUID. The call returns a job object as soon as the job is created/accepted; the job has one sub-job per target language (subJobs), each filling its own project (targetLanguages[].projectGuid). Poll Get job status, or use the callbacks, and fetch each language with Get job result and ?target=<index or language>.
Behaviour
\nUnified (inferred from a Unified_ engine). Unlike ASR/MT, a repeat request for the same project id is not rejected as \"already exists\".video may be a plain URL or a JSON string {\"src\":\"<media url>\",\"dat\":\"<dat url>\"}; the dat URL fills videoDatUrl when that is empty. S3 URLs (video, scriptFileUrl, videoDatUrl) are re-signed when possible.projectGuid, the root gets a fresh GUID so the two do not overwrite each other.EditPro). Each target inherits the request's resolved configuration, and its own configuration fields override it.sourceLanguage is optional: when empty it is asked from the engine (detected from the media).Success.force does not disable this linkage, only the cache reuse (and an already finished older job is not linked for forced runs).Route: id (optional, string).
Query parameters: force (bool, default false): skip cached results; realtime (bool): not used by Unified.
Body fields (Unified) (in addition to the shared fields in the folder description)
\npendingJobId, firstLanguageJobId and isForcedRun are set by the server; do not send them.
targetLanguages[] (one entry per output language)
Errors: 400 unknown engine or action (e.g. Engine action Foo not recognized...); 500 engine failure.
Output (200): a job object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","53b5bdc0-a9cb-4b91-9543-ec6ef1521c76"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"02df9a47-17c9-42ae-9a39-9e9b1ada5897","name":"200 OK - job started","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"engine\": \"Unified_OoonaAI\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"videoDatUrl\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.dat\",\n \"scriptFileUrl\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.script.pdf\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab?id=root\",\n \"duration\": 96,\n \"startTC\": \"00:00:00:00\",\n\n \"projectGuid\": \"5fec160c-4b50-47cf-bb00-46b0d7d411e9\",\n \"projectName\": \"Test project\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\" }\",\n\n \"seriesId\": \"60a087b2a78ea8c6144922c1\",\n \"seriesName\": \"Test series\",\n \"season\": 1,\n \"episode\": 1,\n \"clientId\": \"\",\n \"synopsisLength\": 300,\n\n \"sourceLanguage\": \"English\",\n \"referenceLanguage\": \"English\",\n\n \"features\": {\n \"transcription\": true,\n \"scenes\": true,\n \"translation\": true,\n \"subtitles\": true,\n \"synopsis\": true,\n \"names\": true,\n \"glossary\": true\n },\n \"featureSettings\": {\n \"synopsisMaxCharacters\": 420\n },\n \"skipCache\": false,\n \"force\": false,\n\n \"targetLanguages\": [\n {\n \"language\": \"Spanish\",\n \"projectGuid\": \"5bd44d7e-8629-44f1-ba4b-a2a656f35140\",\n \"app\": \"EditPro\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab?id=spa\",\n \"importConfigurationJson\": \"{ \\\"fps\\\": 25, \\\"lineLength\\\": 42, \\\"maxParagraphLines\\\": 2, \\\"maxSubDuration\\\": 7.0, \\\"minSubDuration\\\": 1.0, \\\"timingGap\\\": 2 }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Spanish\\\", \\\"format\\\": \\\"TT\\\" }\"\n },\n {\n \"language\": \"French\",\n \"projectGuid\": \"1df9bbb7-f185-49d0-8f37-428bc812b363\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab?id=fr\",\n \"importConfigurationJson\": \"{ \\\"fps\\\": 25, \\\"lineLength\\\": 42, \\\"maxParagraphLines\\\": 2, \\\"maxSubDuration\\\": 7.0, \\\"minSubDuration\\\": 1.0, \\\"timingGap\\\": 2 }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"French\\\", \\\"format\\\": \\\"TT\\\" }\",\n \"context\": [\n { \"type\": \"synopsis\", \"content\": \"{}\" },\n { \"type\": \"glossary\", \"url\": \"https://ooona-public.s3.amazonaws.com/video/glossary-fr.json\" }\n ]\n },\n {\n \"language\": \"Hebrew\",\n \"projectGuid\": \"849d31d1-2d9c-4d60-8c3f-1c3a00758baa\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab?id=heb\",\n \"importConfigurationJson\": \"{ \\\"fps\\\": 25, \\\"lineLength\\\": 42, \\\"maxParagraphLines\\\": 2, \\\"maxSubDuration\\\": 7.0, \\\"minSubDuration\\\": 1.0, \\\"timingGap\\\": 2 }\",\n \"exportConfigurationJson\": \"{ \\\"language1\\\": \\\"Hebrew\\\", \\\"isRtl\\\": true, \\\"format\\\": \\\"TT\\\" }\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/3aa8a035-053c-4834-8d1d-a47fec739735","host":["{{base_url}}"],"path":["external","automate","924a088b-d6b8-44cf-82ae-b4be475ab5a2"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"Unified\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Running\",\n \"progress\": 5,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": [\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b31\",\n \"email\": \"api@example.com\",\n \"projectId\": \"11111111-aaaa-4aaa-8aaa-111111111111\",\n \"type\": \"Unified\",\n \"jobId\": \"13b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Spanish\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=0\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=0\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=0\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=0\"\n },\n \"subJobs\": null\n },\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b32\",\n \"email\": \"api@example.com\",\n \"projectId\": \"22222222-bbbb-4bbb-8bbb-222222222222\",\n \"type\": \"Unified\",\n \"jobId\": \"23b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"French\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=1\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=1\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=1\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=1\"\n },\n \"subJobs\": null\n },\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b33\",\n \"email\": \"api@example.com\",\n \"projectId\": \"33333333-cccc-4ccc-8ccc-333333333333\",\n \"type\": \"Unified\",\n \"jobId\": \"33b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Hebrew\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=2\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=2\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=2\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=2\"\n },\n \"subJobs\": null\n }\n ]\n}"},{"id":"aefb7bbf-f68d-4a66-a2d7-bcfbddcce569","name":"400 Unrecognised engine","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"engine\": \"Foo_Bar\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/0acc374c-0202-421f-881b-a9568ae870fe","host":["{{base_url}}"],"path":["external","automate","06f4e61a-6f18-42e7-aad8-5bcb9d0797bf"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Engine action Foo not recognized. Please provide a valid engine value or a valid action value.\",\n \"ExceptionMessage\": \"Engine action Foo not recognized. Please provide a valid engine value or a valid action value.\",\n \"ExceptionType\": \"ArgumentException\",\n \"ActionName\": \"Automate\",\n \"ControllerName\": \"ExternalAutomate\",\n \"StackTrace\": \"ExternalAutomateController.cs:127\"\n}"}],"_postman_id":"c46214a3-306a-4c84-b74a-5330401c9c4b"},{"name":"Run QC","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Set lastJobId\", () => {\n const responseJson = pm.response.json();\n const id = responseJson.id || responseJson.jobId;\n if (id) {\n pm.environment.set('lastJobId', id);\n }\n});"]}}],"id":"b59854d1-0330-4f03-85cf-a0c7de1872f3","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"QC\",\n \"engine\": \"QC_OpenAI\",\n \"projectGuid\": \"76614ade-7d14-4b21-924d-a5242dc832f8\",\n \"previousProjectGuid\": \"00000000-2000-0000-2000-200000000002\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"profanityMode\": \"Flag\",\n \"customProfanityWords\": [\"heck\"],\n \"fixReadingSpeed\": false,\n \"fixTimecodes\": false,\n \"fixLineLength\": false,\n \"synopsis\": \"A detective investigates mysterious disappearances near a seaside cliff.\",\n \"characterNames\": [\"Foster\", \"Sullivan\"],\n \"recurringPhrases\": [\"El Matador\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/automate/32185c7e-b91a-4a33-ab32-389ae0c3eb19","description":"Starts an AI quality-control (QC) job on the subtitles of a project. Role: API.
The project (projectGuid, created from previousProjectGuid or subtitlesUrl when it does not exist) must contain subtitle text, otherwise the call returns 400 No subtitles to check. If the project has an original (source) project, the source paragraphs are sent too for bilingual checks, with the source language taken from the original project's language1; the target language is the project's language1.
Poll Get job status, or use realtime=true to wait up to 60 seconds (on success the result is applied to the project and the job object is returned; if still running, { jobId, status, projectId, statusUrl, ... } is returned; on failure 500 with the error). Fetch the findings with Get job result (json).
Route: id (optional, string): project / request id; a GUID is generated when omitted.
Query parameters: force (bool, default false) allows a repeat job for the same project id; realtime (bool, default false) waits as described.
Body fields (QC)
\nThe QC engine model has further flags (allowTextChanges, fixSpellingGrammar, fixLineBreaks, fixReadingSpeedAI, fixLineBalancing, fixMinDuration, fixMaxDuration, fixMinGap, gapSettings, fixShotChanges, fixStyles, fixSpeakerDashes, fixPositioning, ...), but this endpoint copies only the fields in the table above into the QC job.
Errors: 400 QC engine <engine> not found, 400 No subtitles to check, 400 job already exists, 500 failure.
Output (200): a job object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","2e4bf064-045e-4e30-a56d-4d83803f382b"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"},{"disabled":true,"description":{"content":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.
\n","type":"text/plain"},"key":"realtime","value":"false"}],"variable":[]}},"response":[{"id":"fceeb107-8bf2-4c43-aebf-4ac0559a7253","name":"200 OK - job started","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"QC\",\n \"engine\": \"QC_OpenAI\",\n \"projectGuid\": \"56953150-b4ca-4358-aba1-a663a41d3191\",\n \"previousProjectGuid\": \"00000000-2000-0000-2000-200000000002\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"profanityMode\": \"Flag\",\n \"customProfanityWords\": [\"heck\"],\n \"fixReadingSpeed\": false,\n \"fixTimecodes\": false,\n \"fixLineLength\": false,\n \"synopsis\": \"A detective investigates mysterious disappearances near a seaside cliff.\",\n \"characterNames\": [\"Foster\", \"Sullivan\"],\n \"recurringPhrases\": [\"El Matador\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/de19a930-c5d3-46ea-bce2-869ae910ef11","host":["{{base_url}}"],"path":["external","automate","3a2321d4-3a8b-42dc-9cc8-3528cc854460"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"QualityControl\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"English\",\n \"status\": \"Running\",\n \"progress\": 0,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OpenAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"aee5a737-679b-47f9-ab27-272c37b71596","name":"400 No subtitles","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"QC\",\n \"engine\": \"QC_OpenAI\",\n \"projectGuid\": \"da5fcf91-5631-49c2-bfe0-ec274de62a67\",\n \"previousProjectGuid\": \"00000000-2000-0000-2000-200000000002\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"profanityMode\": \"Flag\",\n \"customProfanityWords\": [\"heck\"],\n \"fixReadingSpeed\": false,\n \"fixTimecodes\": false,\n \"fixLineLength\": false,\n \"synopsis\": \"A detective investigates mysterious disappearances near a seaside cliff.\",\n \"characterNames\": [\"Foster\", \"Sullivan\"],\n \"recurringPhrases\": [\"El Matador\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/69527ec3-c464-4218-bb92-b41909d0c0f5","host":["{{base_url}}"],"path":["external","automate","54994e92-9437-4661-b68f-02a345e03206"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true},{"key":"realtime","value":"false","description":"Optional. true makes MT and QC wait (MT up to 10 s, QC up to 60 s) for the result before answering.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"No subtitles to check\""}],"_postman_id":"b59854d1-0330-4f03-85cf-a0c7de1872f3"},{"name":"Run Syncheck","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Set lastJobId\", () => {\n const responseJson = pm.response.json();\n const id = responseJson.id || responseJson.jobId;\n if (id) {\n pm.environment.set('lastJobId', id);\n }\n});"]}}],"id":"688e1786-77e5-47f1-a969-36b3a77902bd","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Syncheck\",\n \"projectGuid\": \"e9acf96b-92a9-4ad2-81b8-afe73689c4cc\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"syncheck\": {\n \"mediaUrl\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"mediaLanguage\": \"English\",\n \"asrEngine\": \"AWS\",\n \"skipContentComparison\": false,\n \"spotsToCheck\": 3,\n \"timecodeGraceFrames\": 5,\n \"textFuzzyMatch\": 50,\n \"allowedStartSilenceFrames\": 3,\n \"allowedEndSilenceFrames\": 15,\n \"subtitles\": [\n {\n \"subtitleUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"language\": \"English\",\n \"format\": \"SRT\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/automate/c9b3356e-e85d-4037-97ff-ad5a5c3672fc","description":"Starts a Syncheck job: verifies that subtitle files are in sync with a media file by transcribing sampled spots of the audio (ASR) and comparing them with the subtitles. Role: API.
Syncheck has no ASR_/MT_-style engine prefix, so \"action\": \"Syncheck\" must be sent explicitly, together with a syncheck object. The input is validated first; any problem returns 400 with a JSON list of validation errors. The call returns { jobId, status, projectId, statusUrl, transactionAmount, ... } (not the full job object); poll Get job status and read the findings from Get job result, which always answers with the structured JSON for Syncheck jobs.
Route: id (optional, string). Query: force (bool, default false).
syncheck object
syncheck.subtitles[]
(The subtitle item model has a few more optional members that are not documented here.)
\nErrors: 400 with [{ \"Message\": \"MediaUrl is required\" }, ...] for invalid input; 500 when the job fails to start.
Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"beefb6bd-b51c-4ef5-b04a-2716f2342ec9","name":"200 OK - job started","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Syncheck\",\n \"projectGuid\": \"c43c83f4-38ea-4957-bf44-4bff4d21f8dc\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"syncheck\": {\n \"mediaUrl\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"mediaLanguage\": \"English\",\n \"asrEngine\": \"AWS\",\n \"skipContentComparison\": false,\n \"spotsToCheck\": 3,\n \"timecodeGraceFrames\": 5,\n \"textFuzzyMatch\": 50,\n \"allowedStartSilenceFrames\": 3,\n \"allowedEndSilenceFrames\": 15,\n \"subtitles\": [\n {\n \"subtitleUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"language\": \"English\",\n \"format\": \"SRT\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/aa4f584d-2c67-4b5d-acea-52bcb2d86e37","host":["{{base_url}}"],"path":["external","automate","318cf4f3-4aa3-46a3-adce-4873b54337a6"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"status\": \"Running\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"transactionAmount\": 0.35,\n \"transactionCurrency\": \"USD\",\n \"transactionDetails\": \"Syncheck 96 seconds\"\n}"},{"id":"99f19c82-ff91-4d9b-8e56-47e4b4ab6a10","name":"400 Invalid input","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"Syncheck\",\n \"projectGuid\": \"2f0d7c04-68ce-4a32-8236-f7dc7e74690c\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\n \"syncheck\": {\n \"mediaUrl\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"mediaLanguage\": \"English\",\n \"asrEngine\": \"AWS\",\n \"skipContentComparison\": false,\n \"spotsToCheck\": 3,\n \"timecodeGraceFrames\": 5,\n \"textFuzzyMatch\": 50,\n \"allowedStartSilenceFrames\": 3,\n \"allowedEndSilenceFrames\": 15,\n \"subtitles\": [\n {\n \"subtitleUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"language\": \"English\",\n \"format\": \"SRT\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/8ba7bfd1-7b0b-4632-8fc6-e2a772006566","host":["{{base_url}}"],"path":["external","automate","5ca08a59-6af2-451c-b8ca-642665eeac64"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Message\": \"MediaUrl is required\"\n },\n {\n \"Message\": \"Subtitles are required\"\n }\n]"}],"_postman_id":"688e1786-77e5-47f1-a969-36b3a77902bd"},{"name":"Create project","id":"0d41b6a0-e83e-47c6-9484-ab57d807646c","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"CreateProject\",\n \"projectGuid\": \"2b75c9e1-ed68-4c9b-aaf1-158599e65856\",\n \"projectName\": \"My new project\",\n \"app\": \"EditPro\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"SRT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/automate/13d32e28-1f5f-435c-a862-6ea4fe956baf","description":"Creates (if it does not exist) a Toolkit project through the automation endpoint without running any engine. Role: API.
Action CreateProject must be sent explicitly. The call creates the project (from an empty project, from previousProjectGuid, and/or by importing subtitlesUrl), stores the external request, and returns the project (no job, so nothing to poll and no cost). id / projectGuid is the project id. A repeat request for the same project id returns 400 unless force=true.
Route: id (optional). Query: force (bool, default false).
Body fields: action (required, CreateProject), projectGuid, projectName, app (default CreatePro), video, subtitlesUrl / subtitlesFileName (imported with importConfigurationJson.format, or detected from the file extension), previousProjectGuid, importConfigurationJson/Guid, configurationJson/Guid, languageConfigurationJson/Guid, videoConfigurationJson/Guid, callbackUrl, startTC, force. See the folder description for the shared fields.
Output (200): the project document (id, name, app, video, settings, subtitles, originalProject, ...). The full project schema is not detailed here.
Errors: 400 job/project already exists, 400 failed import of subtitlesUrl.
Optional. true allows a second job for a project id that already has one, and skips cached results.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"a83516d7-6f7e-4473-bb26-060b74a8c18c","name":"200 OK - project","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"CreateProject\",\n \"projectGuid\": \"cff8e049-1000-4c63-9994-c20a83222458\",\n \"projectName\": \"My new project\",\n \"app\": \"EditPro\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"SRT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/8fbe7c9c-2710-4c4b-aae2-f7f813f5f83c","host":["{{base_url}}"],"path":["external","automate","d72e36fd-002e-4719-8d03-6871f1e2213d"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"name\": \"My new project\",\n \"app\": \"EditPro\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"isAI\": false,\n \"locked\": false,\n \"settings\": {\n \"language1\": \"English\",\n \"format\": \"SRT\"\n },\n \"subtitles\": {\n \"paragraphs\": []\n }\n}"},{"id":"907848f4-80ff-4087-873c-cf35f4326d47","name":"400 Already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"CreateProject\",\n \"projectGuid\": \"9706df3b-b0c6-4548-a420-6151ba1ed5b0\",\n \"projectName\": \"My new project\",\n \"app\": \"EditPro\",\n \"video\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"subtitlesUrl\": \"https://ooona-public.s3.amazonaws.com/video/MERIDIAN/Meridian.en.srt\",\n \"importConfigurationJson\": \"{ \\\"language1\\\": \\\"English\\\", \\\"format\\\": \\\"SRT\\\" }\",\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/automate/c9339849-f4e1-42f6-aa1c-d27e32cc8758","host":["{{base_url}}"],"path":["external","automate","40751064-8cb6-429c-bb3b-cd3e03f7b3d6"],"query":[{"key":"force","value":"false","description":"Optional. true allows a second job for a project id that already has one, and skips cached results.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Automated job for project id 6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10 already exists.\",\n \"ExceptionMessage\": \"Automated job for project id 6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10 already exists.\",\n \"ExceptionType\": \"ArgumentException\",\n \"ActionName\": \"Automate\",\n \"ControllerName\": \"ExternalAutomate\",\n \"StackTrace\": \"ExternalAutomateController.cs:144\"\n}"}],"_postman_id":"0d41b6a0-e83e-47c6-9484-ab57d807646c"},{"name":"Get job status","id":"6b4c8ced-8967-4a68-bee8-45c88e9be8f4","request":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/status/{{lastJobId}}","description":"Returns the current state of an automation job. Role: API. Poll this (or rely on your callbackUrl) after any Run request.
Route: id (required): the Toolkit job id, the engine jobId, the project id, or the id you used in the Run URL. The first job matching any of them is used. {{lastJobId}} is saved by the Run requests.
Query parameters
\nBehaviour
\nWaiting/Running, 180 s between retries (Retry1-Retry3), 2 h once Success/Failure. Polling more often than that returns the cached copy; use force=true to refresh.Success/Failure, or were created more than 25 hours ago, are answered from the stored state without contacting the engine (unless force).subJobs (one per target language; the root-project job and an unrequested reference language are filtered out). Each sub-job's resultUrls carry ?target=<index>.Output (200): a job object.
\nErrors: 404 when no job matches the id.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","status","{{lastJobId}}"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optional. true bypasses the response cache and re-checks the engine.
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[]}},"response":[{"id":"0c44ae3f-94cc-41ce-93f5-833ac6eafb2e","name":"200 OK - running","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/status/{{lastJobId}}","host":["{{base_url}}"],"path":["external","automate","status","{{lastJobId}}"],"query":[{"key":"force","value":"false","description":"Optional. true bypasses the response cache and re-checks the engine.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Running\",\n \"progress\": 45,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"16b0d9c9-ea20-436d-b0a0-b46b9b277616","name":"200 OK - success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/status/{{lastJobId}}","host":["{{base_url}}"],"path":["external","automate","status","{{lastJobId}}"],"query":[{"key":"force","value":"false","description":"Optional. true bypasses the response cache and re-checks the engine.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Success\",\n \"progress\": 100,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": \"2026-10-15T09:02:40Z\",\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"AWS Transcribe job 0.00040000$x96 seconds\",\n \"transactionAmount\": 0.0384,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0004,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Success\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"e109d403-a499-4458-a7d1-998b14649d4c","name":"200 OK - failure","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/status/{{lastJobId}}","host":["{{base_url}}"],"path":["external","automate","status","{{lastJobId}}"],"query":[{"key":"force","value":"false","description":"Optional. true bypasses the response cache and re-checks the engine.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"Translation\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Spanish\",\n \"status\": \"Failure\",\n \"progress\": 100,\n \"warning\": null,\n \"error\": \"The engine rejected the request: unsupported language pair\",\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"0e07c743-1589-41f9-ac64-ea590a1eb85f","name":"200 OK - unified with sub-jobs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/status/{{lastJobId}}","host":["{{base_url}}"],"path":["external","automate","status","{{lastJobId}}"],"query":[{"key":"force","value":"false","description":"Optional. true bypasses the response cache and re-checks the engine.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"type\": \"Unified\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": null,\n \"status\": \"Running\",\n \"progress\": 40,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": [\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b31\",\n \"email\": \"api@example.com\",\n \"projectId\": \"11111111-aaaa-4aaa-8aaa-111111111111\",\n \"type\": \"Unified\",\n \"jobId\": \"13b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Spanish\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=0\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=0\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=0\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=0\"\n },\n \"subJobs\": null\n },\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b32\",\n \"email\": \"api@example.com\",\n \"projectId\": \"22222222-bbbb-4bbb-8bbb-222222222222\",\n \"type\": \"Unified\",\n \"jobId\": \"23b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"French\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=1\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=1\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=1\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=1\"\n },\n \"subJobs\": null\n },\n {\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b33\",\n \"email\": \"api@example.com\",\n \"projectId\": \"33333333-cccc-4ccc-8ccc-333333333333\",\n \"type\": \"Unified\",\n \"jobId\": \"33b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English\",\n \"targetLanguage\": \"Hebrew\",\n \"status\": \"Running\",\n \"progress\": 10,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"OoonaAI\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35?target=2\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt?target=2\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt?target=2\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona?target=2\"\n },\n \"subJobs\": null\n }\n ]\n}"},{"id":"44c6ecdf-b6b8-4f94-9d11-2cdacc0f122d","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/status/{{lastJobId}}","host":["{{base_url}}"],"path":["external","automate","status","{{lastJobId}}"],"query":[{"key":"force","value":"false","description":"Optional. true bypasses the response cache and re-checks the engine.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"No HTTP resource was found that matches the request URI.\"\n}"}],"_postman_id":"6b4c8ced-8967-4a68-bee8-45c88e9be8f4"},{"name":"Get job result","id":"3583542b-e9e6-4b22-a27f-50c0f16497e9","request":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/result/{{lastJobId}}/srt","description":"Downloads the result of an automation job in the requested format. Role: API. Call it once Get job status reports Success.
Route
\nQuery parameters
\nOutput
\nSuccess and format ooona / srt / vtt: the subtitles as a file download in that format (the timecodes of ASR and Unified results are shifted by startTC when one was given; MT results keep the source timing). ooona is the Toolkit's own JSON subtitle format.json, or a job that is not Success yet: { \"jobId\", \"status\", \"result\", \"errors\" }, where result is the engine's structured result (a string/JSON) and errors the failure text, if any.format is ignored).{ jobId, status, result: \"\" }.Errors: 404 unknown job, or target language not found; 400 Target-specific results are only available for unified jobs; 400 Job has no sub-jobs; 400 Target index N out of range (0-M); 400 (empty body) for an unsupported format.
Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.
\n","type":"text/plain"},"key":"target","value":""}],"variable":[]}},"response":[{"id":"5dd85f11-9e21-4359-bbe3-7c417c977842","name":"200 OK - srt","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/srt","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","srt"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"1\n00:00:26,022 --> 00:00:29,625\nSo these guys just disappeared?\n\n2\n00:00:31,000 --> 00:00:36,000\nYeah, on that stretch of road just\nabove El Matador. You know it?"},{"id":"c9ee18b7-0a4e-4d6e-b5e9-73cebaa58e59","name":"200 OK - vtt","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/vtt","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","vtt"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"WEBVTT\n\n00:00:26.022 --> 00:00:29.625\nSo these guys just disappeared?\n\n00:00:31.000 --> 00:00:36.000\nYeah, on that stretch of road just\nabove El Matador. You know it?"},{"id":"24299b1f-16cd-4a97-bd22-3f0a510d74c3","name":"200 OK - json","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/json","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","json"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"status\": \"Success\",\n \"result\": \"{\\\"results\\\":{\\\"transcripts\\\":[{\\\"transcript\\\":\\\"So these guys just disappeared?\\\"}]}}\",\n \"errors\": null\n}"},{"id":"9033d415-5c1e-4509-8da9-311c322b5897","name":"200 OK - not finished","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/srt","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","srt"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"status\": \"Running\",\n \"result\": null,\n \"errors\": null\n}"},{"id":"29cf7bdc-f586-4e2d-9989-980367b66c56","name":"400 Unsupported format","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/docx","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","docx"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"6b5cce3a-0e09-45c4-b05a-8d80d6c6633f","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/srt","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","srt"],"query":[{"key":"target","value":"","description":"Optional, Unified jobs only: sub-job index (0, 1, ...) or target language name.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"No HTTP resource was found that matches the request URI.\"\n}"}],"_postman_id":"3583542b-e9e6-4b22-a27f-50c0f16497e9"},{"name":"Get unified job result by language","id":"ff4dac54-b45c-4428-8674-7dee0ae2f3c0","request":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/result/{{lastJobId}}/srt?target=Spanish","description":"Downloads one target language of a Unified job as an SRT file. Same endpoint and rules as Get job result; the target query parameter selects the sub-job by language name (Spanish) or by index into subJobs (0). Role: API.
Errors: 404 when no sub-job has that language; 400 when the index is out of range, the job has no sub-jobs, or the job is not a Unified job.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","result","{{lastJobId}}","srt"],"host":["{{base_url}}"],"query":[{"description":{"content":"Sub-job index (0, 1, ...) or target language name.
\n","type":"text/plain"},"key":"target","value":"Spanish"}],"variable":[]}},"response":[{"id":"98019012-5b83-445b-8601-0107e0f89bed","name":"200 OK - srt","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/srt?target=Spanish","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","srt"],"query":[{"key":"target","value":"Spanish","description":"Sub-job index (0, 1, ...) or target language name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"1\n00:00:26,022 --> 00:00:29,625\nAsí que estos tipos simplemente desaparecieron?\n\n2\n00:00:31,000 --> 00:00:36,000\nYeah, on that stretch of road just\nabove El Matador. You know it?"},{"id":"ad202f3d-6d20-4dac-90af-f9e92a9e4832","name":"400 Target index out of range","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/automate/result/{{lastJobId}}/srt?target=Spanish","host":["{{base_url}}"],"path":["external","automate","result","{{lastJobId}}","srt"],"query":[{"key":"target","value":"Spanish","description":"Sub-job index (0, 1, ...) or target language name."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Target index 7 out of range (0-2)\""}],"_postman_id":"ff4dac54-b45c-4428-8674-7dee0ae2f3c0"},{"name":"Get job cost","id":"e0860077-23c3-4496-8282-2b0e0ab1aa70","request":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/cost/{{lastJobId}}","description":"Returns what a job (or every job of a project) cost: a summary and the full list of wallet transactions. Role: API.
Route: id (required): matched against the job id, the engine jobId, the project id or the engine input key. All matching jobs are included, so a project id returns the total for every job run on that project (for example the root and all language jobs of a Unified run).
Output (200)
\nTransaction fields: transactionId, jobId, engine, type (job type), status (Pending, Success, Failure, InDoubt; only Success and Pending count towards the total), priceFactor (Second, Minute, Hour, Character, Word), pricePerUnit, units, amount, currency (default USD), details, dateCreated. Cached-result jobs show 0-amount transactions.
Errors: 404 when no job matches the id.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","cost","{{lastJobId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3e7c735e-eab5-44a6-a92d-2eb454ee1feb","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/cost/{{lastJobId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6f1c2f8e-2c0e-4a62-9c1f-3b7d5a9e4d10\",\n \"isProjectId\": true,\n \"totalAmount\": 0.2091,\n \"currency\": \"USD\",\n \"jobCount\": 2,\n \"transactions\": [\n {\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"jobId\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"engine\": \"AWS\",\n \"type\": \"SpeechToText\",\n \"status\": \"Success\",\n \"priceFactor\": \"Second\",\n \"pricePerUnit\": 0.0004,\n \"units\": 96,\n \"amount\": 0.0384,\n \"currency\": \"USD\",\n \"details\": \"AWS Transcribe job 0.00040000$x96 seconds\",\n \"dateCreated\": \"2026-10-15T09:00:01Z\"\n },\n {\n \"transactionId\": \"c4d1e8f2-7a3b-4c95-8e60-2f1a0b9c8d7e\",\n \"jobId\": \"5e6f7a8b9c0d4e1fa2b3c4d5e6f7a8b9\",\n \"engine\": \"AWS\",\n \"type\": \"Translation\",\n \"status\": \"Success\",\n \"priceFactor\": \"Character\",\n \"pricePerUnit\": 1.5e-05,\n \"units\": 11380,\n \"amount\": 0.1707,\n \"currency\": \"USD\",\n \"details\": \"AWS Translation job 0.00001500$x11380 characters\",\n \"dateCreated\": \"2026-10-15T09:05:30Z\"\n }\n ]\n}"},{"id":"5518869d-e0a8-43cc-b303-6d41bf469ee1","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/cost/{{lastJobId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"No HTTP resource was found that matches the request URI.\"\n}"}],"_postman_id":"e0860077-23c3-4496-8282-2b0e0ab1aa70"}],"id":"a352ea82-66d1-4bf7-8d67-6f1735524a67","description":"Automation endpoints run AI engines (speech-to-text, machine translation, unified AI processing, QC, ...) against a video or a subtitles file, track the resulting job, and return the result as a project or as a file.
\nAll endpoints need an API token (role API); only Get engines and Engine languages also accept UserAPI.
GET external/engines and GET external/languages/{engine} to see what is available.POST external/automate/price to estimate the cost.POST external/automate/{id} to start a job. The id you choose becomes the project id (and external request id); omit it to get a generated GUID.GET external/automate/status/{id} (or wait for your callbackUrl).GET external/automate/result/{id}/{format} to download the result, and GET external/automate/cost/{id} for the charge.POST external/automate/{id?})The body is JSON. The action is taken from action, or inferred from the engine prefix: ASR_ = Transcribe, MT_ = Translate, Unified_ = Unified, QC_ = QC, TTS_ = VoiceOver (not implemented). Any other prefix (or no engine and no action) returns 400.
Supported action values: CreateProject, Transcribe, Translate, Syncheck, Unified, QC. Transcode, VoiceOver, Validate and Sync return 501 (not implemented). FileTranslation is accepted by the model but not handled by this endpoint: nothing is run and the stored request record is returned.
JSON values such as importConfigurationJson are strings containing JSON (escape the quotes).
The model also accepts many project-opening / UI fields (requestId, ip, roles, editConfiguration, allowDownload, allowUpload, allowMediaOpen, allowUnlock, allowShare, userUrl, taskCompleteUrl, fileNamingJson, fileNamingId, mediaId, ...). The Automate action does not read them to run an engine.
Error bodies look like { \"Message\": \"...\", \"ExceptionMessage\": \"...\", \"ExceptionType\": \"ArgumentException\" }.
Subtitle file to convert (required). Only the first file is used.
\n","value":""},{"key":"importOverrides","value":"{\"fps\":25}","type":"text","description":"Optional JSON object overriding import configuration properties, e.g. {\"format\":\"SRT\",\"fps\":25}.
\n"},{"key":"exportOverrides","value":"{\"fps\":23.976}","type":"text","description":"Optional JSON object overriding export configuration properties, e.g. {\"format\":\"WebVTT\",\"fps\":23.976}.
\n"}]},"url":"{{base_url}}/external/convert/SRT/WebVTT?offset=0&offsetBefore=&offsetAfter=&startTC=&removeSegments=&addSegments=&keepSegments=&validate=false&fixDuration=&ignoreWarnings=false","description":"Converts the uploaded subtitle file from one format to another, optionally retiming it on the way. Role: API or UserAPI.
Behaviour
\noffsetBefore, then keepSegments (or removeSegments then addSegments), then offset, startTC and frame-rate conversion, then fixDuration, then offsetAfter.200 OK and the converted file as the response body (attachment, content type derived from the output extension). Each successful call counts once against the Convert API usage.DVDImages): 201 Created with a JSON body that contains jobId. Poll Get conversion job status, then call Download conversion result.ooona-warnings header (JSON array of strings) unless ignoreWarnings=true. With validate=true, validation problems (missing start time, negative or zero duration, overlapping subtitles) fail the request instead of being added to the warnings.Nothing to export. Imported file seems to be empty.Both route segments are optional (external/convert, external/convert/{import} and external/convert/{import}/{export} are all valid). Use null or an empty value as a placeholder when you need to skip the first segment but set the second.
Instead of, or on top of, a template you can send overrides as multipart form fields. Each is a JSON object (string) whose keys are properties of the configuration (the same JSON a template holds, see GET external/template/{id}); keys are case-insensitive, dots reach into nested objects (e.g. \"TTML.LanguageCode\"), and a null value removes the key.
Format keys and language names to use in these values come from the Metadata folder (GET external/formats, GET external/languages).
. separator, e.g. 12.5) or an SMPTE timecode HH:MM:SS:FF (contains a colon, e.g. 00:00:05:12; read with the frame rate of the configuration).removeSegments, addSegments, keepSegments): comma-separated ranges, each from-to using time values, e.g. 10-20,100-130 or 00:00:10:00-00:00:20:00,00:01:40:00-00:02:10:00. from must not be greater than to.offset, offsetBefore, offsetAfter): one time value; positive moves subtitles later, negative earlier (e.g. 2.5, -1, 00:00:01:00). 0 and 00:00:00:00 are ignored.200 OK: the converted file (stream, Content-Disposition: attachment; filename=...), optional ooona-warnings header.201 Created: { \"jobId\": \"...\", \"warnings\": [], ... } for image-based formats; poll the status request with the jobId.400 Bad Request: a JSON string (quoted text): No file found in the request., Import configuration not found., Export configuration not found. (leading space; with an import template and a bad or missing export) or Import configuration not found. Export configuration not found. (import side is a format key or override, or the format could not be detected), File failed validation: ..., User is not authorized to export {format} files, or any import/conversion error text.429 Too Many Requests: server_busy (retry after Retry-After seconds) or quota_exceeded.500 Internal Server Error: transient database failure that persisted after the retry.Time value (seconds or SMPTE) shifting all subtitles. Optional.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Time value applied before the segment edits. Optional.
\n","type":"text/plain"},"key":"offsetBefore","value":""},{"description":{"content":"Time value applied last. Optional.
\n","type":"text/plain"},"key":"offsetAfter","value":""},{"description":{"content":"Programme start timecode, e.g. 01:00:00:00. Optional.
\n","type":"text/plain"},"key":"startTC","value":""},{"description":{"content":"Comma-separated from-to ranges to cut out, e.g. 10-20,100-130. Optional.
\n","type":"text/plain"},"key":"removeSegments","value":""},{"description":{"content":"Comma-separated from-to ranges to insert as gaps. Optional.
\n","type":"text/plain"},"key":"addSegments","value":""},{"description":{"content":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional.
\n","type":"text/plain"},"key":"keepSegments","value":""},{"description":{"content":"true: fail on validation errors instead of warning. Optional.
\n","type":"text/plain"},"key":"validate","value":"false"},{"description":{"content":"Minimum subtitle duration in frames (integer). Optional.
\n","type":"text/plain"},"key":"fixDuration","value":""},{"description":{"content":"true: omit the ooona-warnings header. Optional.
\n","type":"text/plain"},"key":"ignoreWarnings","value":"false"}],"variable":[]}},"response":[{"id":"43d22421-e355-4811-a6cd-a8b7686b86de","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to convert (required). Only the first file is used.","value":""},{"key":"importOverrides","value":"{\"fps\":25}","type":"text","description":"Optional JSON object overriding import configuration properties, e.g. {\"format\":\"SRT\",\"fps\":25}."},{"key":"exportOverrides","value":"{\"fps\":23.976}","type":"text","description":"Optional JSON object overriding export configuration properties, e.g. {\"format\":\"WebVTT\",\"fps\":23.976}."}]},"url":{"raw":"{{base_url}}/external/convert/SRT/WebVTT?offset=0&offsetBefore=&offsetAfter=&startTC=&removeSegments=&addSegments=&keepSegments=&validate=false&fixDuration=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","convert","SRT","WebVTT"],"query":[{"key":"offset","value":"0","description":"Time value (seconds or SMPTE) shifting all subtitles. Optional."},{"key":"offsetBefore","value":"","description":"Time value applied before the segment edits. Optional."},{"key":"offsetAfter","value":"","description":"Time value applied last. Optional."},{"key":"startTC","value":"","description":"Programme start timecode, e.g. 01:00:00:00. Optional."},{"key":"removeSegments","value":"","description":"Comma-separated from-to ranges to cut out, e.g. 10-20,100-130. Optional."},{"key":"addSegments","value":"","description":"Comma-separated from-to ranges to insert as gaps. Optional."},{"key":"keepSegments","value":"","description":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional."},{"key":"validate","value":"false","description":"true: fail on validation errors instead of warning. Optional."},{"key":"fixDuration","value":"","description":"Minimum subtitle duration in frames (integer). Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/vtt"}],"cookie":[],"responseTime":null,"body":"WEBVTT\n\n1\n00:00:01.000 --> 00:00:03.500\nHello world"},{"id":"173ebac4-ef1d-4f88-9150-1e6532334e6e","name":"201 Created image format job","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to convert (required). Only the first file is used.","value":""},{"key":"importOverrides","value":"{\"fps\":25}","type":"text","description":"Optional JSON object overriding import configuration properties, e.g. {\"format\":\"SRT\",\"fps\":25}."},{"key":"exportOverrides","value":"{\"fps\":23.976}","type":"text","description":"Optional JSON object overriding export configuration properties, e.g. {\"format\":\"WebVTT\",\"fps\":23.976}."}]},"url":{"raw":"{{base_url}}/external/convert/SRT/BluraySup?offset=0&offsetBefore=&offsetAfter=&startTC=&removeSegments=&addSegments=&keepSegments=&validate=false&fixDuration=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","convert","SRT","BluraySup"],"query":[{"key":"offset","value":"0","description":"Time value (seconds or SMPTE) shifting all subtitles. Optional."},{"key":"offsetBefore","value":"","description":"Time value applied before the segment edits. Optional."},{"key":"offsetAfter","value":"","description":"Time value applied last. Optional."},{"key":"startTC","value":"","description":"Programme start timecode, e.g. 01:00:00:00. Optional."},{"key":"removeSegments","value":"","description":"Comma-separated from-to ranges to cut out, e.g. 10-20,100-130. Optional."},{"key":"addSegments","value":"","description":"Comma-separated from-to ranges to insert as gaps. Optional."},{"key":"keepSegments","value":"","description":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional."},{"key":"validate","value":"false","description":"true: fail on validation errors instead of warning. Optional."},{"key":"fixDuration","value":"","description":"Minimum subtitle duration in frames (integer). Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"7b0f5a9c3e1d4d2e9d3b0a6f4c1e2a10\",\n \"warnings\": []\n}"},{"id":"6395a59f-7fb9-48de-9d17-0ddb7974e3da","name":"400 Import configuration not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to convert (required). Only the first file is used.","value":""},{"key":"importOverrides","value":"{\"fps\":25}","type":"text","description":"Optional JSON object overriding import configuration properties, e.g. {\"format\":\"SRT\",\"fps\":25}."},{"key":"exportOverrides","value":"{\"fps\":23.976}","type":"text","description":"Optional JSON object overriding export configuration properties, e.g. {\"format\":\"WebVTT\",\"fps\":23.976}."}]},"url":{"raw":"{{base_url}}/external/convert/NoSuchFormat/WebVTT?offset=0&offsetBefore=&offsetAfter=&startTC=&removeSegments=&addSegments=&keepSegments=&validate=false&fixDuration=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","convert","NoSuchFormat","WebVTT"],"query":[{"key":"offset","value":"0","description":"Time value (seconds or SMPTE) shifting all subtitles. Optional."},{"key":"offsetBefore","value":"","description":"Time value applied before the segment edits. Optional."},{"key":"offsetAfter","value":"","description":"Time value applied last. Optional."},{"key":"startTC","value":"","description":"Programme start timecode, e.g. 01:00:00:00. Optional."},{"key":"removeSegments","value":"","description":"Comma-separated from-to ranges to cut out, e.g. 10-20,100-130. Optional."},{"key":"addSegments","value":"","description":"Comma-separated from-to ranges to insert as gaps. Optional."},{"key":"keepSegments","value":"","description":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional."},{"key":"validate","value":"false","description":"true: fail on validation errors instead of warning. Optional."},{"key":"fixDuration","value":"","description":"Minimum subtitle duration in frames (integer). Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Import configuration not found.\""},{"id":"da008a41-0d6c-4e9f-8734-97655a5ec1e5","name":"429 Server busy","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to convert (required). Only the first file is used.","value":""},{"key":"importOverrides","value":"{\"fps\":25}","type":"text","description":"Optional JSON object overriding import configuration properties, e.g. {\"format\":\"SRT\",\"fps\":25}."},{"key":"exportOverrides","value":"{\"fps\":23.976}","type":"text","description":"Optional JSON object overriding export configuration properties, e.g. {\"format\":\"WebVTT\",\"fps\":23.976}."}]},"url":{"raw":"{{base_url}}/external/convert/SRT/WebVTT?offset=0&offsetBefore=&offsetAfter=&startTC=&removeSegments=&addSegments=&keepSegments=&validate=false&fixDuration=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","convert","SRT","WebVTT"],"query":[{"key":"offset","value":"0","description":"Time value (seconds or SMPTE) shifting all subtitles. Optional."},{"key":"offsetBefore","value":"","description":"Time value applied before the segment edits. Optional."},{"key":"offsetAfter","value":"","description":"Time value applied last. Optional."},{"key":"startTC","value":"","description":"Programme start timecode, e.g. 01:00:00:00. Optional."},{"key":"removeSegments","value":"","description":"Comma-separated from-to ranges to cut out, e.g. 10-20,100-130. Optional."},{"key":"addSegments","value":"","description":"Comma-separated from-to ranges to insert as gaps. Optional."},{"key":"keepSegments","value":"","description":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional."},{"key":"validate","value":"false","description":"true: fail on validation errors instead of warning. Optional."},{"key":"fixDuration","value":"","description":"Minimum subtitle duration in frames (integer). Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"server_busy\",\n \"message\": \"Server is busy processing conversions. Please retry shortly.\",\n \"retryAfterSeconds\": 5\n}"}],"_postman_id":"e211c9ac-dc1e-4e28-9fdf-9ef491e5d3a8"},{"name":"Convert a file with custom JSON config","id":"39cc8d13-1fce-46cb-8426-7ceb0e71fce0","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to convert (required).
\n","value":""},{"key":"importOverrides","value":"{\"format\":\"SRT\",\"fps\":25,\"encoding\":\"utf-8\"}","type":"text","description":"JSON object overriding import configuration properties.
\n"},{"key":"exportOverrides","value":"{\"format\":\"WebVTT\",\"fps\":25}","type":"text","description":"JSON object overriding export configuration properties; \"format\" selects the output format.
\n"}]},"url":"{{base_url}}/external/convert","description":"Same endpoint as Convert a file, but without any template or format key in the route: both configurations come from the importOverrides and exportOverrides form fields (both must contain format: with no route segments the import side is detected, so exportOverrides.format is only honoured when importOverrides.format is also given; without importOverrides.format the call answers 400 Import configuration not found. Export configuration not found.).
Use GET external/formats for valid format keys. See Convert a file for the query parameters (offset, offsetBefore, offsetAfter, startTC, removeSegments, addSegments, keepSegments, validate, fixDuration, ignoreWarnings), the responses and the sync/async behaviour. Role: API or UserAPI.
Status of an asynchronous conversion started by Convert a file (the 201 Created answer for image-based export formats). Role: API or UserAPI. Only the user that started the job can read it.
Input: route id = the jobId from the convert response.
Output (200 OK, JSON). status is one of Waiting, Running, Success, Failure:
404 Not Found when the job does not exist or belongs to another user. An unexpected server error is returned as 200 with an error property.
Downloads the result of an asynchronous conversion once its status is Success. Role: API or UserAPI.
Behaviour: answers with a redirect to a short-lived signed storage URL (the HTTP client follows it automatically and receives the file). The result can be downloaded once: the job is marked as downloaded and further calls answer 404.
Input: route id = the jobId. Only the user that started the job may download it.
Output: redirect to the file; 404 Not Found when the job is unknown, owned by someone else, or already downloaded. An unexpected server error is returned as 200 with an error property.
Diagnostics for the conversion admission gate that protects Convert and QC from overload. Role: API or UserAPI. No input.
Output (200 OK, JSON): the throttling key used for the caller (key: the client id on Ooona-hosted instances, otherwise a global key) and the live gate state.
Useful to explain 429 server_busy answers.
Convert a subtitle file to another format. Synchronous for most formats; image-based formats run as a background job (status and download requests below).
\n","_postman_id":"26a1a1fd-af1f-473c-aa02-777554326efc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"Conform","item":[{"name":"List available conforms","id":"8f191895-e4a3-4a31-8ff7-380fa1fe491a","request":{"method":"GET","header":[],"url":"{{base_url}}/external/conform","description":"Lists every conform (automatic fix) that can be passed in the checks field of Run conforms on a file. Role: API or UserAPI. No input.
Output (200 OK, JSON array of the 10 available conforms: duration, maxduration, gap, shotchanges, linelength, trimspaces, multiplespaces, speakerdashes, positioning, styleremoval). Property names are camelCase in alphabetical order. Each item:
Subtitle file to fix (required).
\n","value":""},{"key":"checks","value":"{\"duration\":0.83,\"gap\":\"2/8\",\"trimspaces\":true}","type":"text","description":"JSON object: conform key -> value (see \"List available conforms\").
\n"},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties.
\n"},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties.
\n"}]},"url":"{{base_url}}/external/conform/SRT/SRT?ignoreWarnings=false","description":"Applies the requested automatic fixes to the uploaded file and returns the fixed file in the same format. Role: API or UserAPI. Synchronous.
Route parameters (both optional): importConfigurationId and exportConfigurationId, same meaning as in Convert a file (template id or name, or a format key; an empty import = detect from the extension). The export format must also resolve (a format key or an export template; exportOverrides.format can replace it only when the import side is a template or importOverrides.format is given, otherwise it is ignored): an empty export segment answers 400 Export configuration not found. and does not default to the import format. The resolved import and export formats must be equal, otherwise the call answers 400 Input format (X) doesn't match output format (Y). The export configuration controls how the fixed file is written (e.g. frame rate).
Query: ignoreWarnings (boolean, default false): omit the ooona-errors / ooona-warnings headers.
Body (multipart/form-data):
\nOutput
\n200 OK: the fixed file as an attachment (application/octet-stream, original file name). Problems found while fixing are returned in the ooona-errors and ooona-warnings headers (JSON arrays of QC error objects {code, name, error, subtitleIndex, startTime, endTime, ...}, truncated and ASCII-only).422 Unprocessable Entity: the file cannot be imported. JSON { \"success\": false, \"errors\": [...], \"warnings\": [...] }; errors holds an ImportError entry (code 10, name ImportError, error File import error: ...). Nothing is conformed and the untouched upload is not echoed back.400 Bad Request, a JSON string (quoted text): the calling user lacks a format permission (User is not authorized to import {format} files / ... export {format} files), or an unknown or invalid import/export configuration (Import configuration not found., Export configuration not found. with a leading space when the import is a template, or Import configuration not found. Export configuration not found. when the import is a format key or override or no format can be detected from the file extension), no file in the request (No file found in the request.), the format mismatch above (checked right after the configuration is resolved), or a failure inside the fix run.401 Unauthorized (Invalid authorization (conversion not allowed in integrated API)): thrown only when the user lookup returns no user, i.e. for the API role's fake integrated user (and only while conversion in integrated mode is not enabled); never for UserAPI.429: the quota answer, passed through as in Convert a file.500 Internal Server Error: a transient database fault (safe to retry) or a server failure saving the uploaded file.Each successful call counts against the Conform API usage.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","conform","SRT","SRT"],"host":["{{base_url}}"],"query":[{"description":{"content":"true: omit the ooona-errors / ooona-warnings headers. Optional.
\n","type":"text/plain"},"key":"ignoreWarnings","value":"false"}],"variable":[]}},"response":[{"id":"e249358d-e1ac-440d-bd81-e081b858b4e7","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to fix (required).","value":""},{"key":"checks","value":"{\"duration\":0.83,\"gap\":\"2/8\",\"trimspaces\":true}","type":"text","description":"JSON object: conform key -> value (see \"List available conforms\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties."}]},"url":{"raw":"{{base_url}}/external/conform/SRT/SRT?ignoreWarnings=false","host":["{{base_url}}"],"path":["external","conform","SRT","SRT"],"query":[{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-errors / ooona-warnings headers. Optional."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"1\n00:00:01,000 --> 00:00:03,500\nHello world"},{"id":"dd407958-65c9-4f66-acf9-7e63caa56173","name":"400 Format mismatch","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to fix (required).","value":""},{"key":"checks","value":"{\"duration\":0.83,\"gap\":\"2/8\",\"trimspaces\":true}","type":"text","description":"JSON object: conform key -> value (see \"List available conforms\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties."}]},"url":{"raw":"{{base_url}}/external/conform/SRT/WebVTT?ignoreWarnings=false","host":["{{base_url}}"],"path":["external","conform","SRT","WebVTT"],"query":[{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-errors / ooona-warnings headers. Optional."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Input format (SRT) doesn't match output format (WebVTT).\""},{"id":"65b75943-ec33-48b7-b078-f6ce7e214c6a","name":"422 File cannot be imported","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to fix (required).","value":""},{"key":"checks","value":"{\"duration\":0.83,\"gap\":\"2/8\",\"trimspaces\":true}","type":"text","description":"JSON object: conform key -> value (see \"List available conforms\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties."}]},"url":{"raw":"{{base_url}}/external/conform/SRT/SRT?ignoreWarnings=false","host":["{{base_url}}"],"path":["external","conform","SRT","SRT"],"query":[{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-errors / ooona-warnings headers. Optional."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 10,\n \"name\": \"ImportError\",\n \"error\": \"File import error: the file could not be read\"\n }\n ],\n \"warnings\": []\n}"}],"_postman_id":"acc1e4a8-082e-4a85-9fdd-e1acb844c1f1"}],"id":"a05e8c9c-62ba-4015-9de7-34cdc1f531e4","description":"Conforms automatically fix a subtitle file (minimum duration, gaps, line length, ...). List the available conforms, then run the ones you want.
\n","_postman_id":"a05e8c9c-62ba-4015-9de7-34cdc1f531e4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"QC","item":[{"name":"List available QC checks","id":"67126493-bc0d-46f0-80a8-b30e1382513c","request":{"method":"GET","header":[],"url":"{{base_url}}/external/qc","description":"Lists every check that can be passed in the checks field of Run QC on a file. Role: API or UserAPI. No input.
Output (200 OK, JSON array). Each item: key (name to use in checks), name, description, valueType (what value the check expects), sampleValue, isRaw (the check runs on the raw file and still runs when the file cannot be parsed).
Subtitle file to check (required).
\n","value":""},{"key":"checks","value":"{\"maxduration\":7,\"linelength\":37,\"emptylines\":true}","type":"text","description":"JSON object: check key -> value (see \"List available QC checks\").
\n"},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties.
\n"}]},"url":"{{base_url}}/external/qc/SRT","description":"Runs the requested checks on the uploaded file and returns a JSON report. Role: API or UserAPI. Synchronous; shares the conversion admission gate (may answer 429 server_busy).
Route: importConfigurationId (optional): template id or name, or a format key; empty = detect the format. Same meaning as in Convert a file (there is no export segment).
Body (multipart/form-data):
\nOutput
\n200 OK, JSON { \"success\": bool, \"errors\": [...], \"warnings\": [...] }. success is true when there are no errors. Each error/warning: code, name (e.g. MaximumDuration, LineTooLong, ImportError), error (message), and when relevant subtitleIndex, subtitleLineIndex, actual, operator, expected, text, startTime, endTime. A file that cannot be imported is reported as an ImportError in errors (still 200); only raw checks run in that case.400 Bad Request, a JSON string (quoted text): an unknown or invalid import configuration (Import configuration not found., or no format can be detected from the file extension), no file in the request (No file found in the request.), or a failure inside the check run itself (after the file was accepted).401 Unauthorized (Invalid authorization (conversion not allowed in integrated API)): thrown only when the user lookup returns no user, i.e. for the API role's fake integrated user (and only while conversion in integrated mode is not enabled); never for UserAPI.429: server_busy or the quota answer, passed through.500 Internal Server Error: a transient database fault (safe to retry) or a server failure saving the uploaded file.Each successful call counts against the QC API usage.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","qc","SRT"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"601c87ab-99b3-4ffa-8916-07759f98f64c","name":"200 OK with errors","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to check (required).","value":""},{"key":"checks","value":"{\"maxduration\":7,\"linelength\":37,\"emptylines\":true}","type":"text","description":"JSON object: check key -> value (see \"List available QC checks\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."}]},"url":"{{base_url}}/external/qc/SRT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 6,\n \"name\": \"MaximumDuration\",\n \"error\": \"Subtitle duration is above the maximum allowed.\",\n \"subtitleIndex\": 3,\n \"actual\": 8.4,\n \"operator\": \">\",\n \"expected\": 7,\n \"text\": \"Hello world\",\n \"startTime\": \"00:00:10:00\",\n \"endTime\": \"00:00:18:10\"\n }\n ],\n \"warnings\": []\n}"},{"id":"4eed944f-acd3-4bc3-a537-f2053143af85","name":"200 OK passed","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to check (required).","value":""},{"key":"checks","value":"{\"maxduration\":7,\"linelength\":37,\"emptylines\":true}","type":"text","description":"JSON object: check key -> value (see \"List available QC checks\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."}]},"url":"{{base_url}}/external/qc/SRT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"errors\": [],\n \"warnings\": []\n}"},{"id":"f4520bf6-169a-4fc0-bcb7-8ae19a21a997","name":"400 Import configuration not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"Subtitle file to check (required).","value":""},{"key":"checks","value":"{\"maxduration\":7,\"linelength\":37,\"emptylines\":true}","type":"text","description":"JSON object: check key -> value (see \"List available QC checks\")."},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."}]},"url":"{{base_url}}/external/qc/NoSuchFormat"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Import configuration not found.\""}],"_postman_id":"cda11cb3-9800-4a3e-b7ba-acb374193ba5"}],"id":"ff923408-2f5c-4f66-9cf6-408ac799ab94","description":"Quality control of a subtitle file against a set of checks. List the available checks, then run the ones you want.
\n","_postman_id":"ff923408-2f5c-4f66-9cf6-408ac799ab94","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"Retime","item":[{"name":"Retime a TTML file","id":"ce412e71-9480-4f3a-af38-833aa62067ed","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"TTML file to retime (required).
\n","value":""}]},"url":"{{base_url}}/external/retime?offset=2.5&removeSegments=10-20,100-130&addSegments=&keepSegments=&cleanAfterOffset=true","description":"Shifts, cuts or extends the timing of a TTML file and returns the modified TTML. Unlike Convert a file, the file is edited as XML directly (no import/export), so all other TTML content and styling is preserved. Role: API or UserAPI. Synchronous; counts against the Convert API usage and its monthly quota.
Input: multipart/form-data with one TTML (XML) file (first file only, any field name). The frame rate (ttp:frameRate, ttp:frameRateMultiplier, ttp:dropMode, ttp:timeBase, ttp:tickRate) and the time expression style of the file (frames, HH:MM:SS.mmm, seconds, milliseconds, ticks, SMPTE) are detected from the file and kept in the output. There are no other form fields.
Query parameters (all optional):
\nOrder: keepSegments, or removeSegments then addSegments, then offset.
removeSegments, addSegments, keepSegments): comma-separated ranges from-to, where each side is a plain number of seconds (decimal, . separator, e.g. 10-20,100-130.5). SMPTE timecodes are not accepted in segment lists (each side is parsed as a number, so a value such as 00:00:10:00 fails with a parse error). from must not be greater than to. In keepSegments only, an entry with a single number and no dash is a duration in seconds to keep as blank. Because ranges are split on -, negative numbers cannot be used.offset): the only parameter that also accepts SMPTE. One time value: either seconds (decimal, e.g. 2.5, -1) or an SMPTE timecode HH:MM:SS:FF (contains a colon, e.g. 00:00:01:00, read with the frame rate of the TTML file); positive moves cues later, negative earlier. 0 and 00:00:00:00 are ignored.Output
\n200 OK: the retimed TTML document as text/xml.400 Bad Request: a JSON string (quoted text): No file found in the request., invalid XML, an invalid segment (Invalid segments value (second number must be greater than first)), number parse errors (including an SMPTE timecode in a segment list), etc.400 Bad Request also when the monthly Convert API quota is exhausted. Unlike Convert a file there is no 429 here: the quota check runs inside the same handler that turns every exception into 400, so the body is the generic text Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details. and there is no Retry-After header. The quota resets on the 1st of the next month (UTC).401 Unauthorized: Invalid authorization when the user cannot be resolved, which only happens for the API role's fake integrated user, never for UserAPI.Seconds or SMPTE timecode to shift all cues by. Optional.
\n","type":"text/plain"},"key":"offset","value":"2.5"},{"description":{"content":"Comma-separated from-to ranges to cut out. Optional.
\n","type":"text/plain"},"key":"removeSegments","value":"10-20,100-130"},{"description":{"content":"Comma-separated from-to ranges to insert as gaps. Optional.
\n","type":"text/plain"},"key":"addSegments","value":""},{"description":{"content":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional.
\n","type":"text/plain"},"key":"keepSegments","value":""},{"description":{"content":"true: drop zero-length cues created by the offset. Optional.
\n","type":"text/plain"},"key":"cleanAfterOffset","value":"true"}],"variable":[]}},"response":[{"id":"91998f7c-85e0-4cd1-ba01-8c67fe637a75","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"TTML file to retime (required).","value":""}]},"url":{"raw":"{{base_url}}/external/retime?offset=2.5&removeSegments=10-20,100-130&addSegments=&keepSegments=&cleanAfterOffset=true","host":["{{base_url}}"],"path":["external","retime"],"query":[{"key":"offset","value":"2.5","description":"Seconds or SMPTE timecode to shift all cues by. Optional."},{"key":"removeSegments","value":"10-20,100-130","description":"Comma-separated from-to ranges to cut out. Optional."},{"key":"addSegments","value":"","description":"Comma-separated from-to ranges to insert as gaps. Optional."},{"key":"keepSegments","value":"","description":"Comma-separated from-to ranges to keep (takes precedence over remove/add). Optional."},{"key":"cleanAfterOffset","value":"true","description":"true: drop zero-length cues created by the offset. Optional."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/xml"}],"cookie":[],"responseTime":null,"body":"\n\n \nHello world
\nRetime TTML files directly (offset, cut, insert) without converting them to another format.
\n","_postman_id":"d9d6f141-c7ff-462e-9d2b-8a9d6c736932","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"Stitch","item":[{"name":"Stitch files","id":"4569271c-5fac-4630-b6e2-f138922dfba7","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"First subtitle file (required).
\n","value":""},{"key":"","type":"file","description":"Second subtitle file. Add as many files as needed.
\n","value":""},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties.
\n"},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties.
\n"}]},"url":"{{base_url}}/external/stitch/SRT/SRT?offsets=0|3600&keepSegments=&offset=&ignoreWarnings=false","description":"Imports one or more subtitle files, joins them into a single subtitle track and exports the result. Role: API or UserAPI. Synchronous. Usage: a successful Stitch records 2 usage entries (Convert API), which is 2 units of quota, because quota and usage count entries, not files; a Stitch whose export fails (the 500 below) still records 1 entry.
Route parameters (both optional): importConfigurationId / exportConfigurationId (they can also be passed as query parameters), same meaning as in Convert a file, including that the export side is required (an export format key or an export template; exportOverrides.format can replace it only when the import side is a template or importOverrides.format is given, otherwise it is ignored; omitting it does not produce same-format output and answers 400). The same import configuration is applied to every uploaded file; the output uses the export configuration. Custom JSON configuration via the importOverrides / exportOverrides form fields works as in Convert a file.
Modes
\noffsets nor keepSegments): all cues from all files are combined, sorted by start time and renumbered.offsets): each file is shifted by its own offset, then all are combined in file order.keepSegments): from each file only the given ranges are kept, and the ranges are placed one after another (each file starts where the previous kept range ended).offsets and keepSegments can be used together. Each file is first shifted by its own offset, then trimmed to its kept segments, and the kept segments are then placed one after another. Files are combined in upload order without re-sorting.Query parameters (all optional; these are all the query parameters of the action, besides the route parameters above)
\n. separator, e.g. 12.5) or an SMPTE timecode HH:MM:SS:FF (contains a colon, e.g. 00:00:05:12; read with the frame rate of the configuration).removeSegments, addSegments, keepSegments): comma-separated ranges, each from-to using time values, e.g. 10-20,100-130 or 00:00:10:00-00:00:20:00,00:01:40:00-00:02:10:00. from must not be greater than to.offset, offsetBefore, offsetAfter): one time value; positive moves subtitles later, negative earlier (e.g. 2.5, -1, 00:00:01:00). 0 and 00:00:00:00 are ignored.Body (multipart/form-data): one or more subtitle files (at least one is required; any field names, in the order they should be used), plus optional importOverrides / exportOverrides JSON strings.
Output
\n200 OK: the stitched file as an attachment (application/octet-stream), optional ooona-warnings header (JSON array of strings).400 Bad Request: a JSON string (quoted text): No files found in the request., The number of files (N) does not match the number of keepSegments (M) / ... of offsets (M), an import error of any file, User is not authorized to import {format} files / User is not authorized to export {format} files (the calling user lacks the format role), or a conversion error.500 Internal Server Error: the export failed (message from the exporter).400 Bad Request (a JSON string) for Import configuration not found. (unknown non-auto import segment or an undetectable file format), Export configuration not found. (leading space; import is a template) or Import configuration not found. Export configuration not found. (import is a format key or override, or undetected), 401 Unauthorized (Invalid authorization (conversion not allowed in integrated API), only for the API role's fake integrated user, never for UserAPI), the 429 quota answer passed through, and 500 Internal Server Error only for a transient database fault (safe to retry).Pipe-separated offset per file (seconds or SMPTE). Optional.
\n","type":"text/plain"},"key":"offsets","value":"0|3600"},{"description":{"content":"Pipe-separated segment list per file. Optional.
\n","type":"text/plain"},"key":"keepSegments","value":""},{"description":{"content":"Time value applied to the merged result. Optional.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"true: omit the ooona-warnings header. Optional.
\n","type":"text/plain"},"key":"ignoreWarnings","value":"false"}],"variable":[]}},"response":[{"id":"6c7d6ce9-c4b1-40da-bf7a-fc17e8e2803d","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"First subtitle file (required).","value":""},{"key":"","type":"file","description":"Second subtitle file. Add as many files as needed.","value":""},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties."}]},"url":{"raw":"{{base_url}}/external/stitch/SRT/SRT?offsets=0|3600&keepSegments=&offset=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","stitch","SRT","SRT"],"query":[{"key":"offsets","value":"0|3600","description":"Pipe-separated offset per file (seconds or SMPTE). Optional."},{"key":"keepSegments","value":"","description":"Pipe-separated segment list per file. Optional."},{"key":"offset","value":"","description":"Time value applied to the merged result. Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"1\n00:00:01,000 --> 00:00:03,500\nPart one\n\n2\n01:00:01,000 --> 01:00:03,500\nPart two"},{"id":"b00d3ae9-1691-47e9-b824-bee74d8c085b","name":"400 Count mismatch","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","description":"First subtitle file (required).","value":""},{"key":"","type":"file","description":"Second subtitle file. Add as many files as needed.","value":""},{"key":"importOverrides","value":"{}","type":"text","description":"Optional JSON object overriding import configuration properties."},{"key":"exportOverrides","value":"{}","type":"text","description":"Optional JSON object overriding export configuration properties."}]},"url":{"raw":"{{base_url}}/external/stitch/SRT/SRT?offsets=0|3600&keepSegments=&offset=&ignoreWarnings=false","host":["{{base_url}}"],"path":["external","stitch","SRT","SRT"],"query":[{"key":"offsets","value":"0|3600","description":"Pipe-separated offset per file (seconds or SMPTE). Optional."},{"key":"keepSegments","value":"","description":"Pipe-separated segment list per file. Optional."},{"key":"offset","value":"","description":"Time value applied to the merged result. Optional."},{"key":"ignoreWarnings","value":"false","description":"true: omit the ooona-warnings header. Optional."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"The number of files (2) does not match the number of offsets (3)\""}],"_postman_id":"4569271c-5fac-4630-b6e2-f138922dfba7"}],"id":"9f310c88-ad17-45ad-8e87-da63e9a10e6a","description":"Merge several subtitle files into one output file.
\n","_postman_id":"9f310c88-ad17-45ad-8e87-da63e9a10e6a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"Media","item":[{"name":"Get media id","id":"9150d1c9-c54e-47f9-8cac-ebd60b933c8c","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"https://media.example.com/videos/film/manifest.mpd","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/external/getMediaId","description":"Resolves the Toolkit media id of a DRM-protected video from its MPD manifest URL. Role: API or UserAPI.
Input: the request body is the raw MPD URL as plain text (Content-Type: text/plain, not JSON, not multipart). It must be an absolute URL; the Toolkit server downloads the manifest itself. If the server is refused with 403 and the URL points to a storage bucket, the server retries with a signed URL.
Behaviour: reads the content id from the cenc:pssh element of the MPD and returns it as an encrypted media id.
cenc:pssh) has no content id to register, so it is rejected like unknown content with 403.Output
\n200 OK with a JSON string: the encrypted media id (EncryptedMediaId) of the video.403 Forbidden: User not allowed to view this media (the content id is unknown on this instance, is not global, or is outside its validity window; also returned for an MPD that is not DRM protected).500 Internal Server Error: the error message as a JSON string, e.g. Invalid URL (the body is not an absolute URL), Could not read content id from mpd, or a failure to download or parse the manifest.Helpers for DRM-protected media.
\n","_postman_id":"74171dd7-b995-4381-883c-5c037420de0b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}}],"id":"7b7bf126-e131-4583-9fe3-9b606e5c4d9f","description":"Convert, conform, QC, retime and stitch subtitle files through the API. All file requests here are POST calls with a multipart/form-data body (the subtitle file plus optional form fields) and need the API or UserAPI role. Authentication is added by the collection script.
429 (with a Retry-After header and { code: \"server_busy\", retryAfterSeconds }) when the server is overloaded; retry after the given number of seconds. GET external/convert/gate-stats shows the gate state.DVDImages category, see GET external/formats) is asynchronous: the request answers 201 Created with a jobId; poll GET external/convert/status/{jobId} until status is Success or Failure, then fetch the file from GET external/convert/download/{jobId} (a one-time redirect to a signed URL).429 { code: \"quota_exceeded\", resetsAt, retryAfterSeconds }.Endpoints that import a subtitle file read the first file of the multipart body (the field name does not matter) and the optional importOverrides / exportOverrides form fields, see Convert a file for details.
Non-fatal problems are returned in the ooona-warnings response header (a JSON array of strings, non-ASCII replaced by [UNICODE_TEXT], truncated to a size limit). Pass ignoreWarnings=true to omit the header.
Step 1: start the chain with a scripting session.
\nCreates the root project of the chain (00000100-1001-0000-1000-000000000001) with no source subtitles, opened in the Scripting app with editConfiguration on so the user can set up the project configuration. Every later step links back to this guid.
Link to previous step: none, this is the root. Step 2 sends 00000100-1001-0000-1000-000000000001 as its previousProjectGuid.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Query force (optional): true lets this call take the project over from another user who edited it in the last 180 seconds. Without it such a project opens view-only and ownership does not change.
Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Optional. true = take over a project another user edited in the last 180 seconds instead of opening view-only.
\n","type":"text/plain"},"key":"force","value":"true"}],"variable":[]}},"response":[{"id":"3d12733f-aacf-4e1e-a29f-c15000838cf4","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ac0e914f-c244-4f86-b66f-e01c3517d5e0\",\n \"email\": \"Renee32@example.org\",\n \"app\": \"Scripting\",\n \"projectName\": \"Step 1 - Transcribe (script)\",\n \"editConfiguration\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/00000100-1001-0000-1000-000000000001?force=true","host":["{{base_url}}"],"path":["external","project","00000100-1001-0000-1000-000000000001"],"query":[{"key":"force","value":"true","description":"Optional. true = take over a project another user edited in the last 180 seconds instead of opening view-only."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"https://tools.ooona.net/V2/external?token=8f1c2d9a5b7e4c3f9a6d0b1e2c4f7a85\""}],"_postman_id":"a1249034-0bbe-4e8b-8789-fada6dce1d02"},{"name":"Step 2 - Create Pro - Eng","id":"cabb129b-c4aa-4e8d-8a81-48a22447998c","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"7e91ed8e-5af6-4ebf-aa22-9af67feebad5\",\n \"email\": \"Brent.Sipes83@example.net\",\n \"app\": \"CreatePro\",\n \"projectName\": \"Step 2 - Create Pro - Eng\",\n \"previousProjectGuid\": \"00000100-1001-0000-1000-000000000001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/project/00000100-1001-0000-1000-000000000002","description":"Step 2: open the English subtitles in Create Pro.
\nCreates a new project (00000100-1001-0000-1000-000000000002) in CreatePro, seeded from the Step 1 project.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-000000000001 (the Step 1 project).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 3: review the English subtitles.
\nCreates a new project (00000100-1001-0000-1000-000000000003) in EditPro (review) from the Step 2 result. It is the common parent of both translation branches (4a Spanish, 4b Japanese), so one reviewed source fans out into several translations.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-000000000002 (the Step 2 project).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 4a1 (branch A): translate English to Spanish.
\nCreates a project (00000100-1001-0000-1000-0000000004a1) in TranslatePro from the reviewed English project.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-000000000003 (the Step 3 project). This sample does not preset the target language; add configurationJson (for example { \"language1\": \"Spanish\" }, as in the split-task sample) to preset it.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Query force (optional): true lets this call take the project over from another user who edited it in the last 180 seconds. Without it such a project opens view-only and ownership does not change.
Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Optional. true = take over a project another user edited in the last 180 seconds instead of opening view-only.
\n","type":"text/plain"},"key":"force","value":"true"}],"variable":[]}},"response":[{"id":"1cd727a5-6b43-417c-8c70-229f9029e1b0","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"48211ae4-8528-4301-9758-a5fb900a18dd\",\n \"email\": \"Edyth30@example.net\",\n \"app\": \"TranslatePro\",\n \"projectName\": \"Step 4a1 - Translate Pro - Eng>Spa\",\n \"previousProjectGuid\": \"00000100-1001-0000-1000-000000000003\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/external/project/00000100-1001-0000-1000-0000000004a1?force=true","host":["{{base_url}}"],"path":["external","project","00000100-1001-0000-1000-0000000004a1"],"query":[{"key":"force","value":"true","description":"Optional. true = take over a project another user edited in the last 180 seconds instead of opening view-only."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"https://tools.ooona.net/V2/external?token=8f1c2d9a5b7e4c3f9a6d0b1e2c4f7a85\""}],"_postman_id":"f83843b2-545b-4585-bd20-416afa21ea65"},{"name":"Step 4a2 - Review Pro - Spa","id":"2c96d270-9465-41b7-9fbc-ee4ee78662f4","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestId\": \"51ce5a64-dd13-4447-aa3e-b56e47df31f7\",\n \"email\": \"Carmella_Bode35@example.net\",\n \"app\": \"EditPro\",\n \"projectName\": \"Step 4a2 - Review Pro - Spa\",\n \"previousProjectGuid\": \"00000100-1001-0000-1000-0000000004a1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/project/00000100-1001-0000-1000-0000000004a2","description":"Step 4a2 (branch A): review the Spanish translation.
\nCreates a project (00000100-1001-0000-1000-0000000004a2) in EditPro from the Spanish translation. End of branch A.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-0000000004a1 (Step 4a1).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 4b1 (branch B): translate English to Japanese.
\nCreates a project (00000100-1001-0000-1000-0000000004b1) in TranslatePro from the same reviewed English project as branch A.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-000000000003 (the Step 3 project, the same parent as Step 4a1). As in 4a1, add configurationJson to preset the target language.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 4b1, repeated call (sample of re-opening the same project, for example after a rejection).
\nSends the same body to the same project id (00000100-1001-0000-1000-0000000004b1) as Step 4b1 - Translate Pro - Eng>Jap. Because the id already exists, nothing new is created: the stored request is updated, the existing project is re-opened and a new session URL is returned (the previous one stops being usable).
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-000000000003. The collection does not define a dedicated rejection field for this endpoint; this request only demonstrates re-opening an existing step.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Alternative Step 2: a standalone project that is not part of the chain.
\nCreates a separate Create Pro project (00000100-1001-0000-8888-0000000004b1, a different guid from the Step 2 project) with no previousProjectGuid, so it starts blank and is not linked to the Step 1 project. Useful as a sample of a replacement project after a step was rejected.
Link to previous step: none (no previousProjectGuid).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 4b2 (branch B): review the Japanese translation.
\nCreates a project (00000100-1001-0000-1000-0000000004b2) in EditPro from the Japanese translation. End of branch B.
Link to previous step: previousProjectGuid = 00000100-1001-0000-1000-0000000004b1 (Step 4b1).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Sample flow between apps: a chain of projects where each step opens the result of the previous one in a different Ooona app.
\nEvery step is POST external/project/{id} with your own project guid. The link between steps is the previousProjectGuid body field: when the session opens, the previous project's data is loaded as the starting content of the new project (the previous project is not modified).
Step 1 Scripting\n -> Step 2 Create Pro (Eng)\n -> Step 3 Review Pro (Eng)\n |-> Step 4a1 Translate Pro (Eng>Spa) -> Step 4a2 Review Pro (Spa)\n |-> Step 4b1 Translate Pro (Eng>Jap) -> Step 4b2 Review Pro (Jap)\nHow to run it: send the requests in order. Each returns a single-use session URL (a JSON string); open it in a browser, work on the project and save (Ctrl+S) before moving on, as the next step reads the saved data of the previous project. The guids are hard-coded in this sample.
\nTwo extra requests show variations: re-posting the same id re-opens the existing project with a new session URL, and Step 2 - Create Pro - Rejected project is a standalone project with no previousProjectGuid.
Step 1: transcribe the video with ASR.
\nStarts a speech-to-text job. The id in the URL (00000000-2000-0000-2000-200000000001) becomes the project that receives the transcript; the transcript is later opened for QC in QC ASR Result (previousProjectGuid = this id).
Input: route id = project id (optional; generated when omitted). Body: engine (ASR_AWS), video (media URL), duration (seconds), callbackUrl (called when the job finishes), importConfigurationJson (language1 = spoken language, here English (UK)), exportConfigurationJson (format of the files delivered to the callback). Optional query: force (repeat a job for the same id).
Output (200): a job object (id, status, progress, projectId, transaction*, statusUrl, resultUrls, ...). The test script saves id as lastJobId. Poll Check ASR Status.
Errors: 400 when a job already exists for this project id (unless force=true) or the engine is unrecognised. Full field reference: see the Run ASR request in the Automate folder.
Step 1b: poll the ASR job.
\nReturns the state of the job started by Run ASR. The id is the project id used in Step 1 (a job id also works). Poll until status is Success (or Failure); responses are cached for ~30 s while running, so polling more often is pointless. Add ?force=true to bypass the cache.
Input: route id (required): project id, Toolkit job id or engine job id. Query force (bool, default false).
Output (200): a job object: id, projectId, type, engine, status (Waiting, Running, Success, Failure, Retry1-3), progress (0-100), error, transactionAmount/transactionCurrency, statusUrl, resultUrls (raw, srt, vtt, ooona).
Errors: 404 when no job matches. Details: see Get job status in the Automate folder.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["external","automate","status","00000000-2000-0000-2000-200000000001"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c22960e9-378a-4b41-9275-82233bf09574","name":"200 OK - running","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/status/00000000-2000-0000-2000-200000000001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"00000000-2000-0000-2000-200000000001\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English (UK)\",\n \"targetLanguage\": null,\n \"status\": \"Running\",\n \"progress\": 60,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": null,\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"\",\n \"transactionAmount\": 0.0,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Pending\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"109aba49-9f4c-41bc-95c5-23afa734e67d","name":"200 OK - success","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/status/00000000-2000-0000-2000-200000000001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"email\": \"api@example.com\",\n \"projectId\": \"00000000-2000-0000-2000-200000000001\",\n \"type\": \"SpeechToText\",\n \"jobId\": \"53b70a1f8e2d4c6b82a4f1e5a0c7b3d9\",\n \"mediaId\": null,\n \"sourceLanguage\": \"English (UK)\",\n \"targetLanguage\": null,\n \"status\": \"Success\",\n \"progress\": 100,\n \"warning\": null,\n \"error\": null,\n \"dateCreated\": \"2026-10-15T09:00:00Z\",\n \"lastUpdated\": \"2026-10-15T09:00:12Z\",\n \"startedAt\": \"2026-10-15T09:00:02Z\",\n \"completedAt\": \"2026-10-15T09:02:40Z\",\n \"engine\": \"AWS\",\n \"transactionId\": \"b2f7d3a1-5c4e-4f60-9a8b-1e2d3c4b5a69\",\n \"transactionDetails\": \"AWS Transcribe job 0.00040000$x96 seconds\",\n \"transactionAmount\": 0.0384,\n \"transactionCurrency\": \"USD\",\n \"transactionPriceFactor\": \"Second\",\n \"transactionPricePerUnit\": 0.0004,\n \"transactionUnits\": 96.0,\n \"transactionStatus\": \"Success\",\n \"statusUrl\": \"https://toolkit.example.com/external/automate/status/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"resultUrls\": {\n \"raw\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35\",\n \"srt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/srt\",\n \"vtt\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/vtt\",\n \"ooona\": \"https://toolkit.example.com/external/automate/result/9d3b7c0a5e1f4a28b6c4d2e8f1a07b35/ooona\"\n },\n \"subJobs\": null\n}"},{"id":"bfeefe96-f53c-47f7-adfc-070b575c6f33","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/external/automate/status/00000000-2000-0000-2000-200000000001"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"No HTTP resource was found that matches the request URI.\"\n}"}],"_postman_id":"4017f443-00ba-4060-be8f-7c873390b2d1"},{"name":"QC ASR Result","id":"01eb3c8a-0414-46da-9ef0-1d6eaad6f760","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requestId\": \"786bc4be-bdfd-4022-bac8-572988236eec\",\r\n \"email\": \"Grover.Kassulke18@example.org\",\r\n \"ip\": \"::1\",\r\n \"app\": \"ReviewPro\",\r\n \"editConfiguration\": false,\r\n \"allowDownload\": false,\r\n \"allowUpload\": false,\r\n \"allowMediaOpen\": false,\r\n \"callbackUrl\": \"https://webhook.site/ab0ad467-5159-4736-866b-dee71fdd3aab\",\r\n \"previousProjectGuid\": \"00000000-2000-0000-2000-200000000001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/external/project/00000000-2000-0000-2000-200000000002","description":"Step 2: a human reviews the ASR transcript in Review Pro.
\nCreates a new project (00000000-2000-0000-2000-200000000002) in ReviewPro, seeded from the ASR project (previousProjectGuid = 00000000-2000-0000-2000-200000000001), and returns a single-use session URL for the reviewer. Call it once the ASR job succeeded. When the reviewer finishes, callbackUrl is called and the reviewed project can be the source of the next step.
Input
\nid (required): the new project's GUID. If a project/request with this id already exists, the stored request is updated and the existing project is opened.requestId (your correlation id), email (user the session is opened for; created if unknown), ip (optional; stored for auditing, not enforced), app (ReviewPro), editConfiguration / allowDownload / allowUpload / allowMediaOpen (booleans enabling those UI features), callbackUrl (called when the task finishes), previousProjectGuid (project to start from).Output (200): a JSON string with the single-use session URL, \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser or iframe. A new token is generated on every call.
This is the generic POST external/project/{id} endpoint; see the Project folder for the full reference.
Step 3: machine-translate the reviewed (QC'd) transcript.
\nStarts an MT job that translates the project reviewed in QC ASR Result (previousProjectGuid = 00000000-2000-0000-2000-200000000002) into Spanish. The id in the URL (00000000-2000-0000-2000-200000000003) becomes the new translation project (opened later in QC MT Result).
Input: route id = new project id. Body: action (Translate), engine (MT_AWS), exportConfigurationJson (language1 = target language; the source language comes from the previous project), previousProjectGuid (source project; its text is translated and it also keys the translation cache). Optional query: force (repeat the job / bypass the cache), realtime (wait up to 10 s and return the translated file).
Output (200): a job object (id, status, progress, projectId, transaction*, statusUrl, resultUrls...). Poll with Get job status using lastJobId (or the project id) until Success.
Errors: 400 Original text is not provided. Nothing to translate when the source project has no text; 400 when a job already exists for the id. Full field reference: see Run MT in the Automate folder.
Step 4: a human reviews the machine translation in Review Pro.
\nCreates a new project (00000000-2000-0000-2000-200000000004) in ReviewPro seeded from the MT project (previousProjectGuid = 00000000-2000-0000-2000-200000000003, the project created by Run MT on QCd Project) and returns a single-use session URL for the reviewer. Call it once the MT job succeeded.
Input
\nid (required): the new project's GUID. If it already exists the stored request is updated and the existing project opened.requestId, email, ip, app (ReviewPro), editConfiguration / allowDownload / allowUpload / allowMediaOpen (booleans), previousProjectGuid. This sample sets no callbackUrl.Output (200): a JSON string with the single-use session URL, \"https://<your-instance>/V2/external?token=<token>\".
This is the generic POST external/project/{id} endpoint; see the Project folder for the full reference.
Sample workflow based on automation with human post-processing: an AI job produces a project, a person reviews it in Review Pro, and the reviewed project feeds the next AI job.
\nPOST external/automate/{id}, engine ASR_AWS).GET external/automate/status/{id} until Success.POST external/project/{id}, previousProjectGuid = ASR project).action: Translate, engine: MT_AWS, previousProjectGuid = reviewed project).Every step chains to the previous one through previousProjectGuid. The sample ids (00000000-2000-0000-2000-20000000000N) are placeholders: use your own GUIDs.
Step 1: create the base (parent) project.
\nCreates the project (00000000-1000-0000-1000-000000000001) that holds the full subtitle file. The next requests (the two translate tasks) are based on it, and the split indexes refer to its paragraphs.
Open the returned session URL, wait until the subtitles are loaded, press Ctrl+S to save and close it. The later steps read the saved project.
\nLink to previous step: none, this is the root.
\nInput
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 2: split translate task 1 of 2 (first part).
\nCreates a project (00000000-1000-0000-1000-000000000002) in TranslatePro that is a slice of the base project. Only the paragraphs inside the splitLimitation range are meant to be handled in this task (index 1 to 15); the range is stored with the request and is used later by the merge step. The merge request refers to the guid you give as splitLimitation.mergedProjectGuid, so the same value must be used in both tasks.
Link to previous step: previousProjectGuid = 00000000-1000-0000-1000-000000000001 (the base project). Indexes 16 to 30 are not part of either task in this sample, so they are left out of the merge.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:splitLimitation fields:
Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 3: split translate task 2 of 2 (second part).
\nCreates a project (00000000-1000-0000-1000-000000000003) in TranslatePro that is a slice of the base project. Only the paragraphs inside the splitLimitation range are meant to be handled in this task (index 31 to 50); the range is stored with the request and is used later by the merge step. The merge request refers to the guid you give as splitLimitation.mergedProjectGuid, so the same value must be used in both tasks.
Link to previous step: previousProjectGuid = 00000000-1000-0000-1000-000000000001 (the base project). Indexes 31 to 50 follow the gap left after task 1; both ranges are independent of each other.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:splitLimitation fields:
Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 4: merge the two translate tasks into one project.
\nCreates the merged project (00000000-1000-0000-1000-000000000004) from the existing task projects. Open and save both translate tasks first: the merge reads their saved data and the split ranges stored by their POST external/project/{id} requests (splitLimitation), and takes from each project only the paragraphs inside its range. The first project in ProjectGuids is used as the base for the project settings. The paragraphs of all tasks are then ordered by their start time and renumbered from 1. The merged project is created directly with progress 100 and the app of the first task.
Link to previous steps: ProjectGuids lists the two task guids (00000000-1000-0000-1000-000000000002, 00000000-1000-0000-1000-000000000003). The id in the URL is a new guid (the one both tasks announced as splitLimitation.mergedProjectGuid, though any unused guid works).
The guids are hard-coded in this sample: running it a second time with the same guids returns 400 because the target id must be unique.
\nInput
\nid (required): guid of the merged project to create. Must not exist yet.ExternalMergeProjectViewModel):Output
\n200 OK: a JSON string with the id of the merged project (equal to the route id). No session URL is returned: open it with POST external/project/{id} (next step).400 Bad Request \"Project already exists\": a project with the route id already exists.400 Bad Request \"No projects found\": none of the ProjectGuids exists.external/project) is not handled gracefully by the code and results in a server error.Role: API.
Step 5: open the merged project for editing.
\nOpens the project created by the merge (00000000-1000-0000-1000-000000000004). Because the project already exists it is opened as is, not copied.
It is recommended to build a flow instead (send a new guid with previousProjectGuid = 00000000-1000-0000-1000-000000000004) so that a copy is opened and the merge result stays untouched. The next request does exactly that for review.
Link to previous step: the id in the URL is the id of the merge result from Step 4. No previousProjectGuid is sent.
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:If email belongs to a different user than the project's owner and the project was modified in the last 180 seconds, it opens view-only unless the request has ?force=true.
Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 6: create a review project based on the merged project.
\nCreates a new project (00000000-1000-0000-1000-000000000005) in ReviewPro, creating the flow between the translate and the review apps. The merged project stays unchanged.
Link to previous step: previousProjectGuid = 00000000-1000-0000-1000-000000000004 (the merged project).
Input
\nid (required): the project GUID, generated by your system. If a project/request with this id already exists, the stored request is updated and the existing project is opened; otherwise it is created.ExternalProjectViewModel). Fields used in this step:Output
\n200 OK: a JSON string holding a single-use session URL, e.g. \"https://<your-instance>/V2/external?token=<token>\". Open it in a browser (or iframe) to start the session. A new token is generated on every call to this endpoint.Role: API.
Step 7 (optional): clean up the sample projects.
\nDeletes one project by id. Run it once per project created by this sample; the examples show the ids used in the flow: base project (00000000-1000-0000-1000-000000000001), task 1 (00000000-1000-0000-1000-000000000002), task 2 (00000000-1000-0000-1000-000000000003), merged project (00000000-1000-0000-1000-000000000004) and the review project (00000000-1000-0000-1000-000000000005). This is what lets you re-run the sample with the same hard-coded guids.
Input
\nid (required): the guid of the project to delete. Only the project is deleted; the stored external request is not touched by this endpoint.Output
\n200 OK with an empty body: the project was deleted (the deletion is written to the action log).404 Not Found: no project with this id exists.Role: API.
Sample workflow for splitting a task between several translators and putting the pieces back together.
\nA base project is split by paragraph indexes into two translate tasks, each task is worked on separately, the tasks are merged into one project, and the merged result is opened and reviewed.
\n1. POST external/project/{base} Create Pro, the full subtitle file\n2. POST external/project/{task1} Translate Pro, splitLimitation index 1-15\n3. POST external/project/{task2} Translate Pro, splitLimitation index 31-50\n4. POST external/merge/{merged} merge task1 + task2 into a new project\n5. POST external/project/{merged} open the merged project\n6. POST external/project/{review} Review Pro, previousProjectGuid = merged\n7. DELETE external/delete/{id} clean up\nHow the steps are linked: the tasks point to the base project with previousProjectGuid and announce the future merged project in splitLimitation.mergedProjectGuid; the merge request lists the task guids in ProjectGuids; the review project points to the merge result with previousProjectGuid.
Run the steps in order. Open each returned session URL, work on the project and save (Ctrl+S) before the next step, because later steps read the saved data. The guids are hard-coded: delete the projects (step 7) before running the sample again.
\n","_postman_id":"b96d2966-3882-4c53-9eca-8d5813fa5b40","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}}],"id":"7bc12e6b-0ca9-4bcb-a641-4b4e01405d83","description":"Step-by-step sample workflows built from the project endpoints (POST external/project/{id}, POST external/merge/{id} and DELETE external/delete/{id}).
All of them rely on the same idea: your system chooses the project guids, each request returns a single-use session URL that opens the project in the browser, and projects are linked together so that each step starts from the result of the previous one (previousProjectGuid in the request body).
Run the requests of a folder in order; the guids are hard-coded so a sample can only run once until its projects are deleted.
\n","_postman_id":"7bc12e6b-0ca9-4bcb-a641-4b4e01405d83","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}}},{"name":"🎛️ Engine options","item":[{"name":"Discovery","item":[{"name":"Get transcoder options","id":"e047e195-5469-4310-8bcf-09eebcfbb590","request":{"method":"GET","header":[],"url":"{{base_url}}/external/engines/options?type=Transcoding&engine=ooona","description":"The exposed option tree of the Ooona transcoder. With an untouched instance that is encode (on/off), encode.skip.* and extractDat (on/off).
type (required): an AutomatedJobType name, case-insensitive. Any AutomatedJobType name except None is accepted: Transcoding, SpeechToText, Translation, TextToSpeech, Timing, Storage, Syncheck, Unified, FileTranslation, QualityControl, SmartConform (a type with no option schemas answers an empty result). Numbers, blanks and unknown names answer 400.engine (optional): the engine key (ooona; the TYPE_NAME form from GET external/engines also works).Re-render your form when schemaVersion changes. An engine with nothing exposed answers \"options\": [].
AutomatedJobType name (required)
\n","type":"text/plain"},"key":"type","value":"Transcoding"},{"description":{"content":"Engine key (optional)
\n","type":"text/plain"},"key":"engine","value":"ooona"}],"variable":[]}},"response":[{"id":"50886127-32de-4aa4-acc4-b6db8f3b56bd","name":"200 Default exposure","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/engines/options?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["external","engines","options"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name (required)"},{"key":"engine","value":"ooona","description":"Engine key (optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engine\": \"ooona\",\n \"type\": \"Transcoding\",\n \"schemaVersion\": 1,\n \"options\": [\n {\n \"key\": \"encode\",\n \"label\": \"Encode (downconvert)\",\n \"description\": \"Downconvert the source to a streaming-friendly MP4 proxy. Required for DASH packaging and for the burn-ins and watermark below.\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"children\": [\n {\n \"key\": \"skip\",\n \"label\": \"Skip encoding\",\n \"description\": \"Use the source as the proxy, without encoding, when it already matches every rule below. With no extensions selected the encode is never skipped (the default).\",\n \"dataType\": \"group\",\n \"children\": [\n {\n \"key\": \"extensions\",\n \"label\": \"File extensions\",\n \"description\": \"Source file extensions that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [],\n \"options\": [\n {\n \"value\": \"mp4\",\n \"label\": \"MP4\"\n },\n {\n \"value\": \"mov\",\n \"label\": \"MOV\"\n },\n {\n \"value\": \"m4v\",\n \"label\": \"M4V\"\n },\n {\n \"value\": \"mkv\",\n \"label\": \"MKV\"\n },\n {\n \"value\": \"webm\",\n \"label\": \"WebM\"\n },\n {\n \"value\": \"mxf\",\n \"label\": \"MXF\"\n },\n {\n \"value\": \"avi\",\n \"label\": \"AVI\"\n }\n ]\n },\n {\n \"key\": \"videoCodecs\",\n \"label\": \"Video codecs\",\n \"description\": \"Source video codecs that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [\n \"h264\"\n ],\n \"options\": [\n {\n \"value\": \"h264\",\n \"label\": \"H.264 / AVC\"\n },\n {\n \"value\": \"hevc\",\n \"label\": \"H.265 / HEVC\"\n },\n {\n \"value\": \"vp9\",\n \"label\": \"VP9\"\n },\n {\n \"value\": \"av1\",\n \"label\": \"AV1\"\n },\n {\n \"value\": \"mpeg4\",\n \"label\": \"MPEG-4 Part 2\"\n },\n {\n \"value\": \"prores\",\n \"label\": \"ProRes\"\n }\n ]\n },\n {\n \"key\": \"audioCodecs\",\n \"label\": \"Audio codecs\",\n \"description\": \"Source audio codecs that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [\n \"aac\"\n ],\n \"options\": [\n {\n \"value\": \"aac\",\n \"label\": \"AAC\"\n },\n {\n \"value\": \"opus\",\n \"label\": \"Opus\"\n },\n {\n \"value\": \"mp3\",\n \"label\": \"MP3\"\n },\n {\n \"value\": \"ac3\",\n \"label\": \"AC-3\"\n },\n {\n \"value\": \"eac3\",\n \"label\": \"E-AC-3\"\n },\n {\n \"value\": \"pcm_s16le\",\n \"label\": \"PCM 16-bit\"\n }\n ]\n },\n {\n \"key\": \"maxBitrateKbps\",\n \"label\": \"Maximum video bitrate (Kbps)\",\n \"description\": \"A source with a higher video bitrate is encoded.\",\n \"dataType\": \"integer\",\n \"default\": 1000,\n \"min\": 100,\n \"max\": 100000\n },\n {\n \"key\": \"maxHeightPx\",\n \"label\": \"Maximum video height (pixels)\",\n \"description\": \"A taller source is encoded.\",\n \"dataType\": \"integer\",\n \"default\": 720,\n \"min\": 144,\n \"max\": 4320\n }\n ]\n }\n ]\n },\n {\n \"key\": \"extractDat\",\n \"label\": \"Extract .dat\",\n \"description\": \"Metadata, waveform and shot changes written to a .dat file.\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"children\": []\n }\n ]\n}"},{"id":"ffbef9a5-5a04-4b71-9dd4-ccf37e17bf9c","name":"404 Engine without options","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/engines/options?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["external","engines","options"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name (required)"},{"key":"engine","value":"ooona","description":"Engine key (optional)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Engine 'nope' has no options for Transcoding.\"\n}"}],"_postman_id":"e047e195-5469-4310-8bcf-09eebcfbb590"},{"name":"Get options of a type","id":"1fa0e34b-41b3-44d7-860c-7817c194dd06","request":{"method":"GET","header":[],"url":"{{base_url}}/external/engines/options?type=Transcoding","description":"Without engine: every engine of the type that has an option schema, as { \"engines\": [ … ] }. A type none of whose engines has a schema answers 200 { \"engines\": [] } (try type=SpeechToText).
AutomatedJobType name (required)
\n","type":"text/plain"},"key":"type","value":"Transcoding"}],"variable":[]}},"response":[{"id":"8edce3e6-620b-48e3-9cab-e0f9d1a624bf","name":"200 Transcoding engines","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/engines/options?type=Transcoding","host":["{{base_url}}"],"path":["external","engines","options"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name (required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engines\": [\n {\n \"engine\": \"ooona\",\n \"type\": \"Transcoding\",\n \"schemaVersion\": 1,\n \"options\": [\n {\n \"key\": \"encode\",\n \"label\": \"Encode (downconvert)\",\n \"description\": \"Downconvert the source to a streaming-friendly MP4 proxy. Required for DASH packaging and for the burn-ins and watermark below.\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"children\": [\n {\n \"key\": \"skip\",\n \"label\": \"Skip encoding\",\n \"description\": \"Use the source as the proxy, without encoding, when it already matches every rule below. With no extensions selected the encode is never skipped (the default).\",\n \"dataType\": \"group\",\n \"children\": [\n {\n \"key\": \"extensions\",\n \"label\": \"File extensions\",\n \"description\": \"Source file extensions that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [],\n \"options\": [\n {\n \"value\": \"mp4\",\n \"label\": \"MP4\"\n },\n {\n \"value\": \"mov\",\n \"label\": \"MOV\"\n },\n {\n \"value\": \"m4v\",\n \"label\": \"M4V\"\n },\n {\n \"value\": \"mkv\",\n \"label\": \"MKV\"\n },\n {\n \"value\": \"webm\",\n \"label\": \"WebM\"\n },\n {\n \"value\": \"mxf\",\n \"label\": \"MXF\"\n },\n {\n \"value\": \"avi\",\n \"label\": \"AVI\"\n }\n ]\n },\n {\n \"key\": \"videoCodecs\",\n \"label\": \"Video codecs\",\n \"description\": \"Source video codecs that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [\n \"h264\"\n ],\n \"options\": [\n {\n \"value\": \"h264\",\n \"label\": \"H.264 / AVC\"\n },\n {\n \"value\": \"hevc\",\n \"label\": \"H.265 / HEVC\"\n },\n {\n \"value\": \"vp9\",\n \"label\": \"VP9\"\n },\n {\n \"value\": \"av1\",\n \"label\": \"AV1\"\n },\n {\n \"value\": \"mpeg4\",\n \"label\": \"MPEG-4 Part 2\"\n },\n {\n \"value\": \"prores\",\n \"label\": \"ProRes\"\n }\n ]\n },\n {\n \"key\": \"audioCodecs\",\n \"label\": \"Audio codecs\",\n \"description\": \"Source audio codecs that may skip the encode.\",\n \"dataType\": \"multiselect\",\n \"default\": [\n \"aac\"\n ],\n \"options\": [\n {\n \"value\": \"aac\",\n \"label\": \"AAC\"\n },\n {\n \"value\": \"opus\",\n \"label\": \"Opus\"\n },\n {\n \"value\": \"mp3\",\n \"label\": \"MP3\"\n },\n {\n \"value\": \"ac3\",\n \"label\": \"AC-3\"\n },\n {\n \"value\": \"eac3\",\n \"label\": \"E-AC-3\"\n },\n {\n \"value\": \"pcm_s16le\",\n \"label\": \"PCM 16-bit\"\n }\n ]\n },\n {\n \"key\": \"maxBitrateKbps\",\n \"label\": \"Maximum video bitrate (Kbps)\",\n \"description\": \"A source with a higher video bitrate is encoded.\",\n \"dataType\": \"integer\",\n \"default\": 1000,\n \"min\": 100,\n \"max\": 100000\n },\n {\n \"key\": \"maxHeightPx\",\n \"label\": \"Maximum video height (pixels)\",\n \"description\": \"A taller source is encoded.\",\n \"dataType\": \"integer\",\n \"default\": 720,\n \"min\": 144,\n \"max\": 4320\n }\n ]\n }\n ]\n },\n {\n \"key\": \"extractDat\",\n \"label\": \"Extract .dat\",\n \"description\": \"Metadata, waveform and shot changes written to a .dat file.\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"children\": []\n }\n ]\n }\n ]\n}"},{"id":"43f32de2-bd70-4be5-9725-1d7f7da38fb2","name":"200 Type without schemas","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/engines/options?type=Transcoding","host":["{{base_url}}"],"path":["external","engines","options"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name (required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engines\": []\n}"},{"id":"bca222a3-08af-426e-b5eb-ce32425bc1e5","name":"400 Unknown type","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/external/engines/options?type=Transcoding","host":["{{base_url}}"],"path":["external","engines","options"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name (required)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid engine options: type: 'Transcode' is not a job type; use a name such as Transcoding\",\n \"errors\": [\n {\n \"path\": \"type\",\n \"reason\": \"'Transcode' is not a job type; use a name such as Transcoding\"\n }\n ]\n}"}],"_postman_id":"1fa0e34b-41b3-44d7-860c-7817c194dd06"}],"id":"e7c28596-98c2-419e-93f5-8c195703be09","description":"Which options an integrator may send, as a ready-to-render form. Only exposed options are listed; default is the instance default when an admin set one, else the engine default. Locked, sensitive and hidden options are left out. Authentication: the API / UserAPI bearer token (same as GET external/engines).
A presigned PUT URL in your own upload area, temp/{your user id}/{guid}.mp4 (valid 24 h; the bucket expires temp/ objects). id is the file extension: mp4, jpg, doc, docx, xls, xlsx or rtf.
The script stores the key as transcodeS3Key. Note: this also creates a media library record (the id in the response); don't send that id as mediaId unless you want the library's protected version.
File extension
\n","type":"text/plain"},"key":"id","value":"mp4"},{"description":{"content":"Original file name (stored on the library record)
\n","type":"text/plain"},"key":"filename","value":"ep101.mp4"}],"variable":[]}},"response":[{"id":"873437de-f6a0-4893-ac5c-a566843d617a","name":"200 Upload URL","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/upload/GetUploadUrl?id=mp4&filename=ep101.mp4","host":["{{base_url}}"],"path":["upload","GetUploadUrl"],"query":[{"key":"id","value":"mp4","description":"File extension"},{"key":"filename","value":"ep101.mp4","description":"Original file name (stored on the library record)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"put\": \"https://ooona-instance.s3.amazonaws.com/temp/a91c4e07-52d8-4b3f-8e16-7d0a9b2c3f41/3f9a1c2e-6b1d-4c55-9a7e-0d4b8f1e2a33.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=86400&X-Amz-Signature=…\",\n \"get\": \"https://ooona-instance.s3.amazonaws.com/temp/a91c4e07-52d8-4b3f-8e16-7d0a9b2c3f41/3f9a1c2e-6b1d-4c55-9a7e-0d4b8f1e2a33.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=172800&X-Amz-Signature=…\",\n \"id\": \"7c1e9d2a-0b3f-4e8a-9d61-5a2f0c7b4e18\"\n}"}],"_postman_id":"bea7746f-98be-40f6-88e1-59a53ab2a131"},{"name":"Upload the media","id":"5afdebe1-d82a-48cf-aeb3-c5e4a477dfb7","request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"file","file":{"src":""}},"url":"{{transcodeUploadUrl}}","description":"Uploads the file to the presigned URL from Get an upload URL. Pick the file under Body → binary. No Toolkit auth: the URL is signed. Afterwards transcodeS3Key names your file.
The smallest request: a public https URL, no options. The transcoder gets exactly the payload it got before engine options existed (DASH + Widevine DRM when the instance has a DRM key, .dat with shot changes).
Outputs go to /output/{path of the URL} in the transcoder bucket; the status response lists them only when that path has at least two segments (as here). Use outputPath to choose your own location.
Uses the key from Upload the media ({{transcodeS3Key}}) and writes the outputs to output/_clients/{your client id}/acme/ep101/.
s3Key must be in tasks/{your client id}/ or temp/{your user id}/ and must exist; Toolkit presigns it for the transcoder.url or s3Key, never both.outputPath when you keep results side by side (the ASR video is named after the media file).Only uses options that are exposed by default, so it works on an untouched instance:
\nencode.skip.*: use the source as the proxy without re-encoding when it is an MP4/MOV with H.264 or HEVC video, AAC audio, at most 4 Mbps and 1080p.extractDat: false: no .dat file.Any value for an option that isn't exposed is ignored (and logged), not rejected.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["api","integrations","transcode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f1c81780-99a8-4b74-ab2d-554491875f0d","name":"200 Job created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"provider\": \"ooona\",\n \"url\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"outputPath\": \"acme/ep101-skip\",\n \"engineOptions\": {\n \"encode\": {\n \"enabled\": true,\n \"skip\": {\n \"extensions\": [\n \"mp4\",\n \"mov\"\n ],\n \"videoCodecs\": [\n \"h264\",\n \"hevc\"\n ],\n \"audioCodecs\": [\n \"aac\"\n ],\n \"maxBitrateKbps\": 4000,\n \"maxHeightPx\": 1080\n }\n },\n \"extractDat\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/transcode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0f1e2d3c4b5a69788796a5b4c3d2e1f0\",\n \"type\": \"Transcoding\",\n \"engine\": \"Ooona\",\n \"status\": \"Waiting\",\n \"progress\": 0,\n \"jobId\": \"0f1e2d3c4b5a69788796a5b4c3d2e1f0\",\n \"mediaId\": null,\n \"projectId\": \"\",\n \"startedAt\": \"2026-10-15T09:00:00Z\",\n \"completedAt\": null,\n \"error\": null,\n \"result\": null\n}"}],"_postman_id":"18a2306d-3667-404e-8504-bb042b407b03"},{"name":"Transcode with burn-ins","event":[{"listen":"test","script":{"type":"text/javascript","exec":["const res = pm.response.json();\npm.test('Job created', () => pm.expect(res.id).to.be.a('string'));\npm.environment.set('transcodeJobId', res.id);"]}}],"id":"11774b6c-713a-4755-bedc-b2f01989351e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"provider\": \"ooona\",\n \"url\": \"https://ooona-public.s3.amazonaws.com/video/Amyloidosis%20Awareness.MP4\",\n \"outputPath\": \"acme/ep101-review\",\n \"engineOptions\": {\n \"encode\": {\n \"enabled\": true,\n \"burnSmpteTc\": true,\n \"burnFrameCounter\": false,\n \"burnMediaTime\": true,\n \"watermark\": { \"s3Key\": \"temp/{{user_id}}/logo.png\" }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/transcode","description":"Needs an admin to expose encode.burnSmpteTc, encode.burnFrameCounter, encode.burnMediaTime and encode.watermark first (see Admin → Expose options); until then these values are ignored.
watermark is a .png file, sent as { \"s3Key\": \"…\" } (your own area) or { \"url\": \"https://…\" }. Toolkit hands the transcoder a presigned URL valid 24 hours.
Needs extractAudio, extractAsrVideo and their children exposed by an admin.
extractAudio: a separate audio file for ASR. extension: aac, m4a, mp3, wav, flac. ffmpegArgs allows only -c:a, -b:a, -ar, -ac.extractAsrVideo: a low-quality _asrvideo MP4 with full audio. extension: mp4, mov, mkv. ffmpegArgs takes the video allowlist.encode.ffmpegArgs: extra encoding parameters for the proxy.encode.keepMp4: keep the MP4 proxy next to the DASH output (listed as mp4 in the outputs).Needs dash and dash.drm exposed by an admin.
dash: false (or { \"enabled\": false }) produces an MP4 instead of DASH.dash.host / dash.apiKey are sensitive: never exposed, never accepted; the instance's DRM service is always used.mediaId always gets DASH + DRM, whatever you send.Shows the validation errors. Every invalid exposed option is listed; nothing is created or charged. (encode.ffmpegArgs must be exposed for its error to show; otherwise it is ignored.)
Rejected here: an integer below min, a value not in the multiselect list, a filter in the ffmpeg args.
Poll until status is Success or Failure (there is no callback to you for this endpoint).
Once the job succeeded, the job's owner also gets outputs: every file the transcoder produced, each with a fresh presigned GET URL valid urlValidHours (24 h). URLs are made on each request: ask again for fresh ones.
kind: mpd (DASH manifest), dat, asrVideo, mp4 (proxy), audio, other (init segments, …)..m4s) are only counted in segmentCount; the manifest addresses them relatively.outputs, not the result URLs (those expire after ten minutes).POST api/integrations/transcode starts a cloud transcode; GET api/integrations/transcode/ooona/{jobId} reports it, with presigned output URLs once it succeeded.
Body fields
\nRun the requests in order: Get an upload URL → Upload the media → a Transcode … request → Get transcode status. The scripts store transcodeS3Key and transcodeJobId in the environment.
Errors answer 400 { \"message\", \"errors\": [ { \"path\", \"reason\" } ] } with path = url, s3Key, outputPath or an option path, before any job or charge exists.
engineOptions is accepted and recorded on the job (effectiveEngineOptions with every path under ignored), and the ASR engine runs exactly as without it. A body whose engineOptions is not a JSON object still answers 400.
Every engine job endpoint accepts engineOptions: POST api/integrations/{transcode|transcribe|translate|tts|syncheck|qc|smart-conform|unified} and their /price actions. Only the transcoder has an option schema so far (TK-4579–TK-4581 add the others), so elsewhere every key is ignored and logged, and the job runs as before.
The named fields (LineLength, Fps, TimingGap, …) keep working. When an engine's schema maps one, engineOptions wins over the named field.
Not covered: POST external/automate, multipart api/integrations/file-translate, and the file-based external/qc / external/conform.
Every engine with an option schema, with the admin state of every option (including unexposed, locked and sensitive ones). staleOverridePaths lists saved overrides whose path no longer exists in the schema.
One engine's admin tree. Each node has the schema descriptor plus path, exposedByDefault, isExposed, isLocked, isSensitive, hasOverride, instanceDefault (when set), effectiveDefault, and problem when a stored instance default no longer validates (it is then ignored).
AutomatedJobType name
\n","type":"text/plain"},"key":"type","value":"Transcoding"},{"description":{"content":"Engine key
\n","type":"text/plain"},"key":"engine","value":"ooona"}],"variable":[]}},"response":[{"id":"292b904d-2294-48e8-b7d6-dc677d5fb882","name":"200 Transcoder","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["api","admin","EngineOptions"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name"},{"key":"engine","value":"ooona","description":"Engine key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engine\": \"ooona\",\n \"type\": \"Transcoding\",\n \"schemaVersion\": 1,\n \"options\": [\n {\n \"path\": \"encode\",\n \"key\": \"encode\",\n \"label\": \"Encode (downconvert)\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"exposedByDefault\": true,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": false,\n \"effectiveDefault\": true,\n \"children\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"key\": \"burnSmpteTc\",\n \"label\": \"Burn SMPTE timecode\",\n \"dataType\": \"bool\",\n \"default\": false,\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true,\n \"instanceDefault\": true,\n \"effectiveDefault\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"key\": \"watermark\",\n \"label\": \"Watermark\",\n \"dataType\": \"file\",\n \"accept\": [\n \".png\"\n ],\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true\n }\n ]\n },\n {\n \"path\": \"dash\",\n \"key\": \"dash\",\n \"label\": \"DASH packaging\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"exposedByDefault\": false,\n \"isExposed\": false,\n \"isLocked\": true,\n \"isSensitive\": false,\n \"hasOverride\": true,\n \"effectiveDefault\": true,\n \"children\": [\n {\n \"path\": \"dash.apiKey\",\n \"key\": \"apiKey\",\n \"label\": \"DRM API key\",\n \"dataType\": \"string\",\n \"exposedByDefault\": false,\n \"isExposed\": false,\n \"isLocked\": false,\n \"isSensitive\": true,\n \"hasOverride\": false\n }\n ]\n }\n ],\n \"staleOverridePaths\": []\n}"},{"id":"7eff5524-59a0-4d96-9ed9-86889e76bf53","name":"404 No schema","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["api","admin","EngineOptions"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name"},{"key":"engine","value":"ooona","description":"Engine key"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Engine 'Amazon' has no options for SpeechToText.\"\n}"}],"_postman_id":"9bb2e22d-fdc6-4c6e-84c5-01361c0e631d"},{"name":"Expose options","id":"4326cdde-aef9-49e7-8151-ff009b393bdf","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"changes\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"isExposed\": true,\n \"defaultValue\": null,\n \"isLocked\": false\n },\n {\n \"path\": \"encode.burnFrameCounter\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.burnMediaTime\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"isExposed\": true,\n \"defaultValue\": {\n \"s3Key\": \"branding/ooona-logo.png\"\n }\n },\n {\n \"path\": \"encode.ffmpegArgs\",\n \"isExposed\": true,\n \"defaultValue\": \"-crf 23 -preset medium\"\n },\n {\n \"path\": \"extractAudio\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAudio.extension\",\n \"isExposed\": true,\n \"defaultValue\": \"wav\"\n },\n {\n \"path\": \"extractAudio.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.extension\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.keepMp4\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.drm\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.skipSslValidation\",\n \"isExposed\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","description":"Each change replaces that path's override:
\nAnswers the engine's new admin tree. Discovery shows the change within 30 s. An invalid default or a sensitive path answers 400 listing every problem; nothing is saved.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","id":"2e95edd0-3d9e-4d60-a7d2-80c99eae8e0f","name":"OOONA Tools API 🛠️","type":"collection"}},"urlObject":{"path":["api","admin","EngineOptions"],"host":["{{base_url}}"],"query":[{"key":"type","value":"Transcoding"},{"key":"engine","value":"ooona"}],"variable":[]}},"response":[{"id":"2b8dc696-5bbb-409b-997f-853f4eae2c0f","name":"200 Saved","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"changes\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"isExposed\": true,\n \"defaultValue\": null,\n \"isLocked\": false\n },\n {\n \"path\": \"encode.burnFrameCounter\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.burnMediaTime\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"isExposed\": true,\n \"defaultValue\": {\n \"s3Key\": \"branding/ooona-logo.png\"\n }\n },\n {\n \"path\": \"encode.ffmpegArgs\",\n \"isExposed\": true,\n \"defaultValue\": \"-crf 23 -preset medium\"\n },\n {\n \"path\": \"extractAudio\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAudio.extension\",\n \"isExposed\": true,\n \"defaultValue\": \"wav\"\n },\n {\n \"path\": \"extractAudio.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.extension\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.keepMp4\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.drm\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.skipSslValidation\",\n \"isExposed\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["api","admin","EngineOptions"],"query":[{"key":"type","value":"Transcoding"},{"key":"engine","value":"ooona"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engine\": \"ooona\",\n \"type\": \"Transcoding\",\n \"schemaVersion\": 1,\n \"options\": [\n {\n \"path\": \"encode\",\n \"key\": \"encode\",\n \"label\": \"Encode (downconvert)\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"exposedByDefault\": true,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": false,\n \"effectiveDefault\": true,\n \"children\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"key\": \"burnSmpteTc\",\n \"label\": \"Burn SMPTE timecode\",\n \"dataType\": \"bool\",\n \"default\": false,\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true,\n \"instanceDefault\": true,\n \"effectiveDefault\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"key\": \"watermark\",\n \"label\": \"Watermark\",\n \"dataType\": \"file\",\n \"accept\": [\n \".png\"\n ],\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true\n }\n ]\n },\n {\n \"path\": \"dash\",\n \"key\": \"dash\",\n \"label\": \"DASH packaging\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"exposedByDefault\": false,\n \"isExposed\": false,\n \"isLocked\": true,\n \"isSensitive\": false,\n \"hasOverride\": true,\n \"effectiveDefault\": true,\n \"children\": [\n {\n \"path\": \"dash.apiKey\",\n \"key\": \"apiKey\",\n \"label\": \"DRM API key\",\n \"dataType\": \"string\",\n \"exposedByDefault\": false,\n \"isExposed\": false,\n \"isLocked\": false,\n \"isSensitive\": true,\n \"hasOverride\": false\n }\n ]\n }\n ],\n \"staleOverridePaths\": []\n}"},{"id":"bd3ed3f4-c811-49c6-a4dd-8cd161317931","name":"400 Invalid changes","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"changes\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"isExposed\": true,\n \"defaultValue\": null,\n \"isLocked\": false\n },\n {\n \"path\": \"encode.burnFrameCounter\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.burnMediaTime\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"isExposed\": true,\n \"defaultValue\": {\n \"s3Key\": \"branding/ooona-logo.png\"\n }\n },\n {\n \"path\": \"encode.ffmpegArgs\",\n \"isExposed\": true,\n \"defaultValue\": \"-crf 23 -preset medium\"\n },\n {\n \"path\": \"extractAudio\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAudio.extension\",\n \"isExposed\": true,\n \"defaultValue\": \"wav\"\n },\n {\n \"path\": \"extractAudio.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.extension\",\n \"isExposed\": true\n },\n {\n \"path\": \"extractAsrVideo.ffmpegArgs\",\n \"isExposed\": true\n },\n {\n \"path\": \"encode.keepMp4\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.drm\",\n \"isExposed\": true\n },\n {\n \"path\": \"dash.skipSslValidation\",\n \"isExposed\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["api","admin","EngineOptions"],"query":[{"key":"type","value":"Transcoding"},{"key":"engine","value":"ooona"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid engine options: dash.apiKey: a sensitive option is never exposed; encode.ffmpegArgs: '-i' is not allowed: it adds an input file or URL\",\n \"errors\": [\n {\n \"path\": \"dash.apiKey\",\n \"reason\": \"a sensitive option is never exposed\"\n },\n {\n \"path\": \"encode.ffmpegArgs\",\n \"reason\": \"'-i' is not allowed: it adds an input file or URL\"\n }\n ]\n}"}],"_postman_id":"4326cdde-aef9-49e7-8151-ff009b393bdf"},{"name":"Lock an option","id":"243f6a82-bbaa-443d-b9ed-78f61bfce1c1","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"changes\": [\n {\n \"path\": \"extractDat.excludeShotChanges\",\n \"isExposed\": false,\n \"defaultValue\": true,\n \"isLocked\": true\n },\n {\n \"path\": \"dash\",\n \"isLocked\": true,\n \"defaultValue\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/admin/EngineOptions?type=Transcoding&engine=ooona","description":"isLocked: true with a defaultValue: every job gets that value and integrators can't change it (a locked option disappears from discovery; a request value for it is ignored). A toggle group locked on shows in discovery as a plain group whose children can still be set; locked off, it is left out with its children.
reset: true removes the override for that path: exposure, default and lock go back to the schema.
Removes every override of the engine and answers the schema-default tree (only encode, encode.skip.* and extractDat exposed).
AutomatedJobType name
\n","type":"text/plain"},"key":"type","value":"Transcoding"},{"description":{"content":"Engine key
\n","type":"text/plain"},"key":"engine","value":"ooona"}],"variable":[]}},"response":[{"id":"505c4851-2e1f-43bf-b9a6-432471b8e505","name":"200 Reset","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/admin/EngineOptions/reset?type=Transcoding&engine=ooona","host":["{{base_url}}"],"path":["api","admin","EngineOptions","reset"],"query":[{"key":"type","value":"Transcoding","description":"AutomatedJobType name"},{"key":"engine","value":"ooona","description":"Engine key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"engine\": \"ooona\",\n \"type\": \"Transcoding\",\n \"schemaVersion\": 1,\n \"options\": [\n {\n \"path\": \"encode\",\n \"key\": \"encode\",\n \"label\": \"Encode (downconvert)\",\n \"dataType\": \"group\",\n \"toggle\": true,\n \"default\": true,\n \"exposedByDefault\": true,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": false,\n \"effectiveDefault\": true,\n \"children\": [\n {\n \"path\": \"encode.burnSmpteTc\",\n \"key\": \"burnSmpteTc\",\n \"label\": \"Burn SMPTE timecode\",\n \"dataType\": \"bool\",\n \"default\": false,\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true,\n \"instanceDefault\": true,\n \"effectiveDefault\": true\n },\n {\n \"path\": \"encode.watermark\",\n \"key\": \"watermark\",\n \"label\": \"Watermark\",\n \"dataType\": \"file\",\n \"accept\": [\n \".png\"\n ],\n \"exposedByDefault\": false,\n \"isExposed\": true,\n \"isLocked\": false,\n \"isSensitive\": false,\n \"hasOverride\": true\n }\n ]\n }\n ],\n \"staleOverridePaths\": []\n}"}],"_postman_id":"e7c792cc-600e-43f0-9347-471ea746c9c4"},{"name":"Rerun a job","id":"62cc3f35-c8ba-4d30-8b57-c7ba2c8c2c93","request":{"method":"POST","header":[],"url":"{{base_url}}/api/admin/AutomatedJobs/rerun/{{transcodeJobId}}?skipCache=false","description":"Reruns a stored job as a new job (dashboard action). For a transcode:
\nengineOptions are merged again against the current exposure and checked against the original owner's storage area;skipCache=true ignores cached results for engines that use them.
Ignore cached results
\n","type":"text/plain"},"key":"skipCache","value":"false"}],"variable":[]}},"response":[{"id":"2ea80582-b753-4b78-bd88-f8a7e91d61ca","name":"200 Rerun created","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/admin/AutomatedJobs/rerun/{{transcodeJobId}}?skipCache=false","host":["{{base_url}}"],"path":["api","admin","AutomatedJobs","rerun","{{transcodeJobId}}"],"query":[{"key":"skipCache","value":"false","description":"Ignore cached results"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9a8b7c6d5e4f30211203f4e5d6c7b8a9\",\n \"message\": \"Job re-run successfully created\"\n}"}],"_postman_id":"62cc3f35-c8ba-4d30-8b57-c7ba2c8c2c93"}],"id":"392bde62-adfc-4f6d-aab2-ae989f0dc379","description":"Per-instance exposure, for super users and API admins (SuperOrAPI). There are no per-key or per-client rules. Each server caches the resolved exposure for 30 seconds and clears it on save, so discovery reflects a change within 30 s.
Option state (per path): isExposed (null = follow the schema's exposedByDefault), defaultValue (the instance default; null = none), isLocked (integrators can't change it; the instance/engine default applies). Sensitive options can't be exposed or given an instance default. Instance defaults are validated like request values (incl. the ffmpeg allowlist), but an instance default's s3Key may name any key of the bucket (e.g. a branding watermark).
Engine options let an integrated system (e.g. Ooona Manager) see which settings of an engine this Toolkit instance lets it set, and send values for them with each job. The transcoder (Transcoding, engine ooona) is the first engine with an option schema; every other engine accepts engineOptions too and ignores it until it gets a schema.
Tickets: epic TK-4573 (TK-4574 schema, TK-4575 exposure, TK-4577 discovery + engineOptions, TK-4578 transcoder options, TK-4121 transcode outputs). Full reference: docs/engine-options-api.md in the Toolkit repo.
PUT api/admin/EngineOptions (folder Admin).GET external/engines/options?type=Transcoding&engine=ooona. Cache the form per schemaVersion.GET upload/GetUploadUrl gives a PUT URL in your own temp/{user id}/ area.engineOptions: POST api/integrations/transcode.GET api/integrations/transcode/ooona/{jobId}. A successful job carries outputs with presigned URLs for the MPD, DAT, ASR video, … (there is no callback to the integrator for this endpoint).Merge order: engine default → instance default → request value.
\n400 { \"message\", \"errors\": [ { \"path\", \"reason\" } ] }, listing every problem, before any job or wallet transaction exists.s3Key you send must be in your own storage area: tasks/{your client id}/ or temp/{your user id}/.Transcoding / ooona, schemaVersion 1)\"Exposed\" is the state before an admin changes anything. Unexposed options can be exposed by an admin.
\nffmpeg args (encode.ffmpegArgs, extractAsrVideo.ffmpegArgs, extractAudio.ffmpegArgs): space-separated -option value pairs from an allowlist: -c:v (libx264, libx265, libvpx-vp9), -crf (0-51), -preset, -tune, -profile:v, -level, -b:v / -maxrate / -bufsize (800k, 2M), -g, -r (25, 23.976, 24000/1001), -pix_fmt, -c:a (aac, libopus, libmp3lame, libvorbis, ac3, eac3, flac, pcm_s16le), -b:a, -ar, -ac. Audio extraction allows only -c:a, -b:a, -ar, -ac. Filters (-vf, -af, -filter*), -i, -f, -map, -y, -metadata, URLs, quotes, shell metacharacters and repeated options answer 400.
Server-side rules you can't override: a protected Task Manager upload or a media library entry (mediaId) always gets encode + DASH + DRM, and deleteSource is always off for a source in Toolkit's own storage. With every option at its default, the transcoder receives exactly the payload it got before engine options existed.
\n\nUntil the transcoder service maps the new keys (TK-4585) it applies the DASH/DRM
\npackagingonly: the other options are validated, stored and sent, but have no effect yet.
Uses the collection's base_url, api_name and api_key (the collection script fetches the token). Set user_id and client_id to the API user's ids: they name your own storage areas (temp/{user_id}/, tasks/{client_id}/). The requests' scripts set transcodeUploadUrl, transcodeS3Key, transcodeJobId and transcodeMpdUrl in the environment.