Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM Language Translator Documents API

Operations for translating documents

IBM Language Translator Documents API is one of 4 APIs that IBM Language Translator publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and pricing.

This API exposes 5 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against 7 base URLs: https://api.us-south.language-translator.watson.cloud.ibm.com, https://api.us-east.language-translator.watson.cloud.ibm.com, https://api.eu-de.language-translator.watson.cloud.ibm.com, https://api.eu-gb.language-translator.watson.cloud.ibm.com, https://api.au-syd.language-translator.watson.cloud.ibm.com, https://api.jp-tok.language-translator.watson.cloud.ibm.com, https://api.kr-seo.language-translator.watson.cloud.ibm.com.

5 operations 3 paths 3 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://api.us-south.language-translator.watson.cloud.ibm.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

IBM Language Translator Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — IBM Cloud IAM token authentication

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 5

Operations for translating documents

GET
/v3/documents
List documents
listDocuments 1 param → 200401500
POST
/v3/documents
Translate document
translateDocument 1 param body → 202400401403413415500
GET
/v3/documents/{document_id}
Get document status
getDocumentStatus 2 params → 200401404500
DELETE
/v3/documents/{document_id}
Delete document
deleteDocument 2 params → 204401404500
GET
/v3/documents/{document_id}/translated_document
Get translated document
getTranslatedDocument 3 params → 200401404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DocumentStatus (12 properties), ErrorResponse (3 properties), DocumentList (1 property). Each schema is shown below with its type and property counts.

DocumentList
object
DocumentList contains the list of documents with status.
1 property
ErrorResponse
object
Error response object.
3 properties
DocumentStatus
object
Information about the submitted document and the translation process.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-translate-documents-api-openapi.yml Raw ↑

Other APIs IBM Language Translator publishes across the network.

IBM Language Translator Languages API
IBM Language Translator Models API
IBM Language Translator Translation API