{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-cognitiveservices-translator-text/translator-break-sentence":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_break_sentence","summary":"Identifies the position of sentence boundaries in a piece of text.","description":"POST /BreakSentence","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"Language":{"type":"string","description":"Language tag of the language of the input text. If not specified, Translator will apply automatic language detection."},"Script":{"type":"string","description":"Script identifier of the script used by the input text. If a script is not specified, the default script of the language will be assumed."},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-detect":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_detect","summary":"Identifies the language of a string of text.","description":"POST /Detect","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-dictionary-lookup":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_dictionary_lookup","summary":"Provides alternative translations for a word and a small number of idiomatic phrases. Each translation has a…","description":"POST /Dictionary/Lookup","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","from","to","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"from":{"type":"string","description":"Specifies the language of the input text. The source language must be one of the supported languages included in the `dictionary` scope."},"to":{"type":"string","description":"Specifies the language of the output text. The target language must be one of the supported languages included in the `dictionary` scope…"},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-dictionary-examples":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_dictionary_examples","summary":"Provides examples that show how terms in the dictionary are used in context. This operation is used in…","description":"POST /Dictionary/Examples","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","from","to","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"from":{"type":"string","description":"Specifies the language of the input text. The source language must be one of the supported languages included in the `dictionary` scope."},"to":{"type":"string","description":"Specifies the language of the output text. The target language must be one of the supported languages included in the `dictionary` scope."},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-languages":{"get":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_languages","summary":"Gets the set of languages currently supported by other operations of the Translator Text API.…","description":"GET /Languages","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints","schema":{"type":"string","description":"Supported Cognitive Services endpoints"}},{"name":"api-version","in":"query","required":false,"description":"Version of the API requested by the client. Value must be **3.0**.","schema":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."}},{"name":"scope","in":"query","required":false,"description":"A comma-separated list of names defining the group of languages to return. Allowed group names are- `translation`, `transliteration` and…","schema":{"type":"array","description":"A comma-separated list of names defining the group of languages to return. Allowed group names are- `translation`, `transliteration` and…"}},{"name":"Accept-Language","in":"query","required":false,"description":"The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this…","schema":{"type":"string","description":"The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this…"}},{"name":"X-ClientTraceId","in":"query","required":false,"description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…","schema":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-translate":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_translate","summary":"Translates text into one or more languages.","description":"POST /translate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","to","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"from":{"type":"string","description":"Specifies the language of the input text. Find which languages are available to translate from by using the languages method. If the…"},"to":{"type":"array","description":"Specifies the language of the output text. Find which languages are available to translate to by using the languages method. For example,…"},"textType":{"type":"string","enum":["plain","html"],"description":"Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete HTML element. Possible…"},"category":{"type":"string","description":"A string specifying the category (domain) of the translation. This parameter retrieves translations from a customized system built with…"},"profanityAction":{"type":"string","enum":["NoAction","Marked","Deleted"],"description":"Specifies how profanities should be treated in translations. Possible values are: `NoAction` (default), `Marked` or `Deleted`. ###…"},"profanityMarker":{"type":"string","description":"Specifies how profanities should be marked in translations. Possible values are- `Asterisk` (default) or `Tag`."},"includeAlignment":{"type":"boolean","description":"Specifies whether to include alignment projection from source text to translated text. Possible values are- `true` or `false` (default)."},"includeSentenceLength":{"type":"boolean","description":"Specifies whether to include sentence boundaries for the input text and the translated text. Possible values are- `true` or `false`…"},"suggestedFrom":{"type":"string","description":"Specifies a fallback language if the language of the input text can't be identified. Language auto-detection is applied when the `from`…"},"fromScript":{"type":"string","description":"Specifies the script of the input text. Supported scripts are available from the languages method"},"toScript":{"type":"array","description":"Specifies the script of the translated text. Supported scripts are available from the languages method"},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-translator-text/translator-transliterate":{"post":{"operationId":"cloud_azure_cognitiveservices_translator_text_translator_transliterate","summary":"Converts the text of a language in one script into another type of script. Example- Japanese script \"こんにちは\"…","description":"POST /transliterate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","language","fromScript","toScript","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints"},"api-version":{"type":"string","default":"3.0","description":"Version of the API requested by the client. Value must be **3.0**."},"language":{"type":"string","description":"Specifies the language of the text to convert from one script to another. Possible languages are listed in the `transliteration` scope…"},"fromScript":{"type":"string","description":"Specifies the script used by the input text. Lookup supported languages using the `transliteration` scope, to find input scripts available…"},"toScript":{"type":"string","description":"Specifies the output script. Lookup supported languages using the `transliteration` scope, to find output scripts available for the…"},"X-ClientTraceId":{"type":"string","description":"A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}