{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ai:oxforddictionaries/get-domains-source-domains-language-target-domains-language":{"get":{"operationId":"ai_oxforddictionaries_get_domains_source_domains_language_target_domains_language","summary":"Lists available domains in a bilingual dataset","description":"GET /domains/{source_domains_language}/{target_domains_language}","tags":["ai"],"parameters":[{"name":"source_domains_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","nso","zu","ur","de","pt"],"description":"IANA language code"}},{"name":"target_domains_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-domains-source-language":{"get":{"operationId":"ai_oxforddictionaries_get_domains_source_language","summary":"Lists available domains in a monolingual dataset","description":"GET /domains/{source_language}","tags":["ai"],"parameters":[{"name":"source_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","nso","zu","hi","sw","ur","de","pt","ta","gu"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-language-word-id-sentences":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_language_word_id_sentences","summary":"Retrieve corpus sentences for a given word","description":"GET /entries/{source_language}/{word_id}/sentences","tags":["ai"],"parameters":[{"name":"source_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id","summary":"Retrieve dictionary information for a given word","description":"GET /entries/{source_lang}/{word_id}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","lv","hi","sw","ta","gu","fr"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id-antonyms":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id_antonyms","summary":"Retrieve words that mean the opposite","description":"GET /entries/{source_lang}/{word_id}/antonyms","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id-regions-region":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id_regions_region","summary":"Specify GB or US dictionary for English entry search","description":"GET /entries/{source_lang}/{word_id}/regions={region}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"region","in":"query","required":true,"description":"Region filter parameter. gb = Oxford Dictionary of English. us = New Oxford American Dictionary.","schema":{"type":"string","enum":["gb","us"],"description":"Region filter parameter. gb = Oxford Dictionary of English. us = New Oxford American Dictionary."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id-synonyms":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id_synonyms","summary":"Retrieve words that are similar","description":"GET /entries/{source_lang}/{word_id}/synonyms","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id-synonyms-antonyms":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id_synonyms_antonyms","summary":"Retrieve synonyms and antonyms for a given word","description":"GET /entries/{source_lang}/{word_id}/synonyms;antonyms","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-lang-word-id-filters":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_lang_word_id_filters","summary":"Apply filters to response","description":"GET /entries/{source_lang}/{word_id}/{filters}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","lv","hi","sw","ta","gu","fr"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"An Entry identifier. Case-sensitive.","schema":{"type":"string","default":"ace","description":"An Entry identifier. Case-sensitive."}},{"name":"filters","in":"query","required":true,"description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive.…","schema":{"type":"string","default":"grammaticalFeatures=singular,past;lexicalCategory=noun","description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive.…"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-entries-source-translation-language-word-id-translations":{"get":{"operationId":"ai_oxforddictionaries_get_entries_source_translation_language_word_id_translations","summary":"Retrieve translation for a given word","description":"GET /entries/{source_translation_language}/{word_id}/translations={target_translation_language}","tags":["ai"],"parameters":[{"name":"source_translation_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","nso","zu","ms","id","tn","ur","de","pt"],"description":"IANA language code"}},{"name":"word_id","in":"query","required":true,"description":"The source word","schema":{"type":"string","default":"change","description":"The source word"}},{"name":"target_translation_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-filters":{"get":{"operationId":"ai_oxforddictionaries_get_filters","summary":"Lists available filters","description":"GET /filters","tags":["ai"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-filters-endpoint":{"get":{"operationId":"ai_oxforddictionaries_get_filters_endpoint","summary":"Lists available filters for specific endpoint","description":"GET /filters/{endpoint}","tags":["ai"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Name of the endpoint.","schema":{"type":"string","enum":["entries","inflections","translations"],"description":"Name of the endpoint."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-grammatical-features-source-language":{"get":{"operationId":"ai_oxforddictionaries_get_grammatical_features_source_language","summary":"Lists available grammatical features in a dataset","description":"GET /grammaticalFeatures/{source_language}","tags":["ai"],"parameters":[{"name":"source_language","in":"query","required":true,"description":"IANA language code. If provided output will be filtered by sourceLanguage.","schema":{"type":"string","enum":["en","es","lv","nso","zu","ms","tn","ur","hi","sw","de","pt","ta","gu"],"description":"IANA language code. If provided output will be filtered by sourceLanguage."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-inflections-source-lang-word-id-filters":{"get":{"operationId":"ai_oxforddictionaries_get_inflections_source_lang_word_id_filters","summary":"Check a word exists in the dictionary and retrieve its root form","description":"GET /inflections/{source_lang}/{word_id}/{filters}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","hi","nso","tn","zu","de","pt"],"description":"IANA language code"}},{"name":"filters","in":"query","required":true,"description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive.…","schema":{"type":"string","default":"grammaticalFeatures=singular,past;lexicalCategory=noun","description":"Separate filtering conditions using a semicolon. Conditions take values grammaticalFeatures and/or lexicalCategory and are case-sensitive.…"}},{"name":"word_id","in":"query","required":true,"description":"The input word","schema":{"type":"string","default":"swimming","description":"The input word"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-languages":{"get":{"operationId":"ai_oxforddictionaries_get_languages","summary":"Lists available dictionaries","description":"GET /languages","tags":["ai"],"parameters":[{"name":"sourceLanguage","in":"query","required":false,"description":"IANA language code. If provided output will be filtered by sourceLanguage.","schema":{"type":"string","enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro","de","pt","ta","gu"],"description":"IANA language code. If provided output will be filtered by sourceLanguage."}},{"name":"targetLanguage","in":"query","required":false,"description":"IANA language code. If provided output will be filtered by sourceLanguage.","schema":{"type":"string","enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro"],"description":"IANA language code. If provided output will be filtered by sourceLanguage."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-lexicalcategories-language":{"get":{"operationId":"ai_oxforddictionaries_get_lexicalcategories_language","summary":"Lists available lexical categories in a dataset","description":"GET /lexicalcategories/{language}","tags":["ai"],"parameters":[{"name":"language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["es","en","lv","nso","zu","ms","id","tn","ur","hi","sw","ro","de","pt","ta","gu"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-regions-source-language":{"get":{"operationId":"ai_oxforddictionaries_get_regions_source_language","summary":"Lists available regions in a monolingual dataset","description":"GET /regions/{source_language}","tags":["ai"],"parameters":[{"name":"source_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-registers-source-language":{"get":{"operationId":"ai_oxforddictionaries_get_registers_source_language","summary":"Lists available registers in a monolingual dataset","description":"GET /registers/{source_language}","tags":["ai"],"parameters":[{"name":"source_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","hi","id","lv","ms","sw","ur","de","pt","ta","gu"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-registers-source-register-language-target-register-langu":{"get":{"operationId":"ai_oxforddictionaries_get_registers_source_register_language_target_register_langu","summary":"Lists available registers in a bilingual dataset","description":"GET /registers/{source_register_language}/{target_register_language}","tags":["ai"],"parameters":[{"name":"source_register_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","ms","id","ur","de","pt"],"description":"IANA language code"}},{"name":"target_register_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["es","en","nso","zu","ms","id","tn","ro","de","pt"],"description":"IANA language code"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-search-source-lang":{"get":{"operationId":"ai_oxforddictionaries_get_search_source_lang","summary":"Retrieve possible matches to input","description":"GET /search/{source_lang}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","hi","lv","sw","ta","gu"],"description":"IANA language code"}},{"name":"q","in":"query","required":false,"description":"Search string","schema":{"type":"string","default":"eye","description":"Search string"}},{"name":"prefix","in":"query","required":false,"description":"Set prefix to true if you'd like to get results only starting with search string.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set prefix to true if you'd like to get results only starting with search string."}},{"name":"regions","in":"query","required":false,"description":"If searching in English, filter words with specific region(s) either 'us' or 'gb'.","schema":{"type":"string","description":"If searching in English, filter words with specific region(s) either 'us' or 'gb'."}},{"name":"limit","in":"query","required":false,"description":"Limit the number of results per response. Default and maximum limit is 5000.","schema":{"type":"string","description":"Limit the number of results per response. Default and maximum limit is 5000."}},{"name":"offset","in":"query","required":false,"description":"Offset the start number of the result.","schema":{"type":"string","description":"Offset the start number of the result."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-search-source-search-language-translations-target-search":{"get":{"operationId":"ai_oxforddictionaries_get_search_source_search_language_translations_target_search","summary":"Retrieve possible translation matches to input","description":"GET /search/{source_search_language}/translations={target_search_language}","tags":["ai"],"parameters":[{"name":"source_search_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","nso","zu","ms","id","tn","ur","de","pt"],"description":"IANA language code"}},{"name":"target_search_language","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["es","nso","zu","ms","id","tn","ro","de","pt"],"description":"IANA language code"}},{"name":"q","in":"query","required":false,"description":"Search string.","schema":{"type":"string","default":"eye","description":"Search string."}},{"name":"prefix","in":"query","required":false,"description":"Set prefix to true if you'd like to get results only starting with search string.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set prefix to true if you'd like to get results only starting with search string."}},{"name":"regions","in":"query","required":false,"description":"Filter words with specific region(s) E.g., regions=us. For now gb, us are available for en language.","schema":{"type":"string","description":"Filter words with specific region(s) E.g., regions=us. For now gb, us are available for en language."}},{"name":"limit","in":"query","required":false,"description":"Limit the number of results per response. Default and maximum limit is 5000.","schema":{"type":"string","description":"Limit the number of results per response. Default and maximum limit is 5000."}},{"name":"offset","in":"query","required":false,"description":"Offset the start number of the result.","schema":{"type":"string","description":"Offset the start number of the result."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-stats-frequency-ngrams-source-lang-corpus-ngram-size":{"get":{"operationId":"ai_oxforddictionaries_get_stats_frequency_ngrams_source_lang_corpus_ngram_size","summary":"Retrieve the frequency of ngrams (1-4) derived from a corpus","description":"GET /stats/frequency/ngrams/{source_lang}/{corpus}/{ngram-size}/","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","default":"en","description":"IANA language code"}},{"name":"corpus","in":"query","required":true,"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","schema":{"type":"string","default":"nmc","description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com"}},{"name":"ngram-size","in":"query","required":true,"description":"the size of ngrams requested (1-4)","schema":{"type":"string","default":2,"description":"the size of ngrams requested (1-4)"}},{"name":"tokens","in":"query","required":false,"description":"List of tokens to filter. The tokens are separated by spaces, the list items are separated by comma (e.g., for bigrams (n=2) tokens=this…","schema":{"type":"string","default":"a word","description":"List of tokens to filter. The tokens are separated by spaces, the list items are separated by comma (e.g., for bigrams (n=2) tokens=this…"}},{"name":"contains","in":"query","required":false,"description":"Find ngrams containing the given token(s). Use comma or space as token separators; the order of tokens is irrelevant.","schema":{"type":"string","description":"Find ngrams containing the given token(s). Use comma or space as token separators; the order of tokens is irrelevant."}},{"name":"punctuation","in":"query","required":false,"description":"Flag specifying whether to lookup ngrams that include punctuation or not (possible values are \"true\" and \"false\"; default is \"false\")","schema":{"type":"string","description":"Flag specifying whether to lookup ngrams that include punctuation or not (possible values are \"true\" and \"false\"; default is \"false\")"}},{"name":"format","in":"query","required":false,"description":"Option specifying whether tokens should be returned as a single string (option \"google\") or as a list of strings (option \"oup\")","schema":{"type":"string","default":"oup","description":"Option specifying whether tokens should be returned as a single string (option \"google\") or as a list of strings (option \"oup\")"}},{"name":"minFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at least `minFrequency`","schema":{"type":"integer","description":"Restrict the query to entries with frequency of at least `minFrequency`"}},{"name":"maxFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at most `maxFrequency`","schema":{"type":"integer","description":"Restrict the query to entries with frequency of at most `maxFrequency`"}},{"name":"minDocumentFrequency","in":"query","required":false,"description":"Restrict the query to entries that appear in at least `minDocumentFrequency` documents","schema":{"type":"integer","description":"Restrict the query to entries that appear in at least `minDocumentFrequency` documents"}},{"name":"maxDocumentFrequency","in":"query","required":false,"description":"Restrict the query to entries that appera in at most `maxDocumentFrequency` documents","schema":{"type":"integer","description":"Restrict the query to entries that appera in at most `maxDocumentFrequency` documents"}},{"name":"collate","in":"query","required":false,"description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g.,…","schema":{"type":"string","description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g.,…"}},{"name":"sort","in":"query","required":false,"description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by…","schema":{"type":"string","description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by…"}},{"name":"offset","in":"query","required":false,"description":"pagination - results offset","schema":{"type":"integer","default":0,"description":"pagination - results offset"}},{"name":"limit","in":"query","required":false,"description":"pagination - results limit","schema":{"type":"integer","default":100,"description":"pagination - results limit"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-stats-frequency-word-source-lang":{"get":{"operationId":"ai_oxforddictionaries_get_stats_frequency_word_source_lang","summary":"Retrieve the frequency of a word derived from a corpus.","description":"GET /stats/frequency/word/{source_lang}/","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","default":"en","description":"IANA language code"}},{"name":"corpus","in":"query","required":false,"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","schema":{"type":"string","default":"nmc","description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com"}},{"name":"wordform","in":"query","required":false,"description":"The written form of the word to look up (preserving case e.g., Books vs books)","schema":{"type":"string","description":"The written form of the word to look up (preserving case e.g., Books vs books)"}},{"name":"trueCase","in":"query","required":false,"description":"The written form of the word to look up with normalised case (Books --> books)","schema":{"type":"string","description":"The written form of the word to look up with normalised case (Books --> books)"}},{"name":"lemma","in":"query","required":false,"description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")","schema":{"type":"string","default":"test","description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")"}},{"name":"lexicalCategory","in":"query","required":false,"description":"The lexical category of the word(s) to look up (e.g., noun or verb)","schema":{"type":"string","description":"The lexical category of the word(s) to look up (e.g., noun or verb)"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-stats-frequency-words-source-lang":{"get":{"operationId":"ai_oxforddictionaries_get_stats_frequency_words_source_lang","summary":"Retrieve a list of frequencies of a word/words derived from a corpus.","description":"GET /stats/frequency/words/{source_lang}/","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","default":"en","description":"IANA language code"}},{"name":"corpus","in":"query","required":false,"description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com","schema":{"type":"string","default":"nmc","description":"For corpora other than 'nmc' (New Monitor Corpus) please contact api@oxforddictionaries.com"}},{"name":"wordform","in":"query","required":false,"description":"The written form of the word to look up (preserving case e.g., Book vs book)","schema":{"type":"string","description":"The written form of the word to look up (preserving case e.g., Book vs book)"}},{"name":"trueCase","in":"query","required":false,"description":"The written form of the word to look up with normalised case (Books --> books)","schema":{"type":"string","description":"The written form of the word to look up with normalised case (Books --> books)"}},{"name":"lemma","in":"query","required":false,"description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")","schema":{"type":"string","default":"test","description":"The lemma of the word to look up (e.g., Book, booked, books all have the lemma \"book\")"}},{"name":"lexicalCategory","in":"query","required":false,"description":"The lexical category of the word(s) to look up (e.g., adjective or noun)","schema":{"type":"string","description":"The lexical category of the word(s) to look up (e.g., adjective or noun)"}},{"name":"grammaticalFeatures","in":"query","required":false,"description":"The grammatical features of the word(s) to look up entered as a list of k:v (e.g., degree_type:comparative)","schema":{"type":"string","description":"The grammatical features of the word(s) to look up entered as a list of k:v (e.g., degree_type:comparative)"}},{"name":"sort","in":"query","required":false,"description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by…","schema":{"type":"string","description":"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency. Descending order is achieved by…"}},{"name":"collate","in":"query","required":false,"description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g.,…","schema":{"type":"string","description":"collate the results by wordform, trueCase, lemma, lexicalCategory. Multiple values can be separated by commas (e.g.,…"}},{"name":"minFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at least `minFrequency`","schema":{"type":"integer","description":"Restrict the query to entries with frequency of at least `minFrequency`"}},{"name":"maxFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at most `maxFrequency`","schema":{"type":"integer","description":"Restrict the query to entries with frequency of at most `maxFrequency`"}},{"name":"minNormalizedFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at least `minNormalizedFrequency`","schema":{"type":"number","description":"Restrict the query to entries with frequency of at least `minNormalizedFrequency`"}},{"name":"maxNormalizedFrequency","in":"query","required":false,"description":"Restrict the query to entries with frequency of at most `maxNormalizedFrequency`","schema":{"type":"number","description":"Restrict the query to entries with frequency of at most `maxNormalizedFrequency`"}},{"name":"offset","in":"query","required":false,"description":"pagination - results offset","schema":{"type":"integer","default":0,"description":"pagination - results offset"}},{"name":"limit","in":"query","required":false,"description":"pagination - results limit","schema":{"type":"integer","default":100,"description":"pagination - results limit"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-wordlist-source-lang-filters-advanced":{"get":{"operationId":"ai_oxforddictionaries_get_wordlist_source_lang_filters_advanced","summary":"Retrieve list of words for category with advanced options","description":"GET /wordlist/{source_lang}/{filters_advanced}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","hi","lv","sw","ta","gu"],"description":"IANA language code"}},{"name":"filters_advanced","in":"query","required":true,"description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can…","schema":{"type":"string","default":"lexicalCategory=Noun;domains=sport","description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can…"}},{"name":"exclude","in":"query","required":false,"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes headwords that have any senses in specified exclusion…","schema":{"type":"string","description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes headwords that have any senses in specified exclusion…"}},{"name":"exclude_senses","in":"query","required":false,"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes only those senses of a particular headword that match…","schema":{"type":"string","description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes only those senses of a particular headword that match…"}},{"name":"exclude_prime_senses","in":"query","required":false,"description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes a headword only if the primary sense matches the specified…","schema":{"type":"string","description":"Semicolon separated list of parameters-value pairs (same as filters). Excludes a headword only if the primary sense matches the specified…"}},{"name":"word_length","in":"query","required":false,"description":"Parameter to speficy the minimum (>), exact or maximum ( 5 - more than 5 chars; 5<10 - from 5 to 10 chars; 3 - exactly 3 chars.","schema":{"type":"string","default":">5,<10","description":"Parameter to speficy the minimum (>), exact or maximum ( 5 - more than 5 chars; 5<10 - from 5 to 10 chars; 3 - exactly 3 chars."}},{"name":"prefix","in":"query","required":false,"description":"Filter words that start with prefix parameter","schema":{"type":"string","default":"goal","description":"Filter words that start with prefix parameter"}},{"name":"exact","in":"query","required":false,"description":"If exact=true wordlist returns a list of entries that exactly matches the search string. Otherwise wordlist lists entries that start with…","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"If exact=true wordlist returns a list of entries that exactly matches the search string. Otherwise wordlist lists entries that start with…"}},{"name":"limit","in":"query","required":false,"description":"Limit the number of results per response. Default and maximum limit is 5000.","schema":{"type":"string","description":"Limit the number of results per response. Default and maximum limit is 5000."}},{"name":"offset","in":"query","required":false,"description":"Offset the start number of the result.","schema":{"type":"string","description":"Offset the start number of the result."}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}},"/v1/ai:oxforddictionaries/get-wordlist-source-lang-filters-basic":{"get":{"operationId":"ai_oxforddictionaries_get_wordlist_source_lang_filters_basic","summary":"Retrieve a list of words in a category","description":"GET /wordlist/{source_lang}/{filters_basic}","tags":["ai"],"parameters":[{"name":"source_lang","in":"query","required":true,"description":"IANA language code","schema":{"type":"string","enum":["en","es","hi","lv","sw","ta","gu"],"description":"IANA language code"}},{"name":"filters_basic","in":"query","required":true,"description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can…","schema":{"type":"string","default":"registers=Rare;domains=Art","description":"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers. Parameters can…"}},{"name":"limit","in":"query","required":false,"description":"Limit the number of results per response. Default and maximum limit is 5000.","schema":{"type":"string","description":"Limit the number of results per response. Default and maximum limit is 5000."}},{"name":"offset","in":"query","required":false,"description":"Offset the start number of the result","schema":{"type":"string","description":"Offset the start number of the result"}},{"name":"app_id","in":"query","required":true,"description":"App ID Authentication Parameter","schema":{"type":"string","default":"5037d509","description":"App ID Authentication Parameter"}},{"name":"app_key","in":"query","required":true,"description":"App Key Authentication Parameter","schema":{"type":"string","default":"4dc1aebaa63721f0f8e79a55e2514bc7","description":"App Key Authentication Parameter"}}],"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":"live"}}},"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"}}}}}}}