openapi-directory/api/text2data.org.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"text2data.com","url":"https://text2data.com/Integration","x-twitter":"Text2Data"},"description":"<p>The current api version is <b>v3.4</b></p><br><br><p>The api methods listed below can be called directly from this page to test the output. You might set the api_key to pre-authenticate all requests on this page (this will work if your secret is blank).</p><br><br> API endpoint URL: http://{apiName}.text2data.com/v3/ {method}<br><br>The api can be consumed directly or using our SDK. Our Excel Add-In and Google Sheets Add-on are also using this api to process the data.","license":{"name":"See license","url":"https://text2data.com/License"},"title":"Text Analytics & Sentiment Analysis API | api.text2data.com","version":"v3.4","x-apisguru-categories":["text"],"x-logo":{"url":"https://twitter.com/Text2Data/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"http://api.text2data.org/swagger/docs/v3.4","version":"2.0"}],"x-providerName":"text2data.org"},"paths":{"/v3/Analyze":{"get":{"operationId":"Analyze_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Test api response without api key","tags":["Analyze"]},"post":{"description":"Sample request:\r\n            \r\n    POST /Analyze\r\n    {\r\n       \"DocumentText\": \"Excellent location, opposite a very large mall with wide variety of shops, restaurants and more.\",\r\n       \"PrivateKey\": \"your_api_key\",\r\n       \"Secret\": \"\"\r\n    }","operationId":"Analyze_Post","requestBody":{"$ref":"#/components/requestBodies/Document"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Sentiment analysis service","tags":["Analyze"]}},"/v3/Categorize":{"get":{"operationId":"Categorize_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Test api response without api key","tags":["Categorize"]},"post":{"description":"Sample request:\r\n            \r\n    POST /Categorize\r\n    {\r\n       \"DocumentText\": \"Excellent location, opposite a very large mall with wide variety of shops, restaurants and more.\",\r\n       \"PrivateKey\": \"your_api_key\",\r\n       \"UserCategoryModelName\": \"your_model_name\",\r\n       \"Secret\": \"\"\r\n    }","operationId":"Categorize_Post","requestBody":{"$ref":"#/components/requestBodies/Document"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Document categorization service","tags":["Categorize"]}},"/v3/Extract":{"get":{"operationId":"Extract_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Test api response without api key","tags":["Extract"]},"post":{"description":"Sample request:\r\n            \r\n    POST /Extract\r\n    {\r\n       \"DocumentText\": \"Excellent location, opposite a very large mall with wide variety of shops, restaurants and more.\",\r\n       \"PrivateKey\": \"your_api_key\",\r\n       \"UserCategoryModelName\": \"your_model_name\",\r\n       \"Secret\": \"\"\r\n    }","operationId":"Extract_Post","requestBody":{"$ref":"#/components/requestBodies/Document"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DocumentResult"}}}}},"summary":"Document extraction service","tags":["Extract"]}}},"servers":[{"url":"http://api.text2data.org"}],"components":{"requestBodies":{"Document":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}},"text/json":{"schema":{"$ref":"#/components/schemas/Document"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Document"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Document"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Document"}}},"required":true}},"securitySchemes":{"PrivateKey":{"description":"API Key Authentication","in":"query","name":"PrivateKey","type":"apiKey"}},"schemas":{"ApiConfig":{"properties":{"APIPrivateKey":{"type":"string"},"APISecret":{"type":"string"},"BlacklistedWords":{"items":{"type":"string"},"type":"array"},"ErrorMessage":{"type":"string"},"IsRequestStatusOK":{"type":"boolean"}},"type":"object"},"Category":{"properties":{"CategoryName":{"type":"string"},"Score":{"format":"double","type":"number"}},"type":"object"},"Document":{"properties":{"DocumentLanguage":{"type":"string"},"DocumentText":{"type":"string"},"IsTwitterContent":{"type":"boolean"},"PrivateKey":{"type":"string"},"RequestIdentifier":{"type":"string"},"Secret":{"type":"string"},"SerializeFormat":{"format":"int32","type":"integer"},"UserCategoryModelName":{"type":"string"}},"required":["DocumentText","PrivateKey"],"type":"object"},"DocumentResult":{"properties":{"AutoCategories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"Citations":{"items":{"$ref":"#/components/schemas/SentencePart"},"type":"array"},"CloudTagHTML":{"type":"string"},"CoreSentences":{"items":{"$ref":"#/components/schemas/Sentence"},"type":"array"},"DetectedLanguage":{"type":"string"},"DocSentimentPolarity":{"type":"string"},"DocSentimentResultString":{"type":"string"},"DocSentimentValue":{"format":"double","type":"number"},"Entities":{"items":{"$ref":"#/components/schemas/SentencePart"},"type":"array"},"ErrorMessage":{"type":"string"},"Keywords":{"items":{"$ref":"#/components/schemas/SentencePart"},"type":"array"},"Magnitude":{"format":"double","type":"number"},"PartsOfSpeech":{"items":{"$ref":"#/components/schemas/PartOfSpeech"},"type":"array"},"ResultTextHtml":{"type":"string"},"SlangWords":{"items":{"$ref":"#/components/schemas/SlangWord"},"type":"array"},"Status":{"format":"int32","type":"integer"},"StorageInfo":{"$ref":"#/components/schemas/StorageInfo"},"Subjectivity":{"type":"string"},"SwearWords":{"items":{"$ref":"#/components/schemas/SlangWord"},"type":"array"},"Themes":{"items":{"$ref":"#/components/schemas/SentencePart"},"type":"array"},"Timestamp":{"format":"int64","type":"integer"},"TransactionCurrentDay":{"format":"int32","type":"integer"},"TransactionDailyLimit":{"format":"int32","type":"integer"},"TransactionTotalCreditsLeft":{"format":"int32","type":"integer"},"TransactionUseByDate":{"format":"date-time","type":"string"},"UserCategories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"}},"type":"object"},"PartOfSpeech":{"properties":{"Action":{"type":"string"},"Object":{"type":"string"},"ObjectSentimentPolarity":{"type":"string"},"ObjectSentimentResultString":{"type":"string"},"ObjectSentimentValue":{"format":"double","type":"number"},"Subject":{"type":"string"},"Text":{"type":"string"}},"type":"object"},"Sentence":{"properties":{"Magnitude":{"format":"double","type":"number"},"SentenceNumber":{"format":"int32","type":"integer"},"SentimentPolarity":{"type":"string"},"SentimentResultString":{"type":"string"},"SentimentValue":{"format":"double","type":"number"},"Text":{"type":"string"}},"type":"object"},"SentencePart":{"properties":{"KeywordType":{"type":"string"},"Magnitude":{"format":"double","type":"number"},"Mentions":{"format":"int32","type":"integer"},"SentencePartType":{"type":"string"},"SentenceText":{"type":"string"},"SentimentPolarity":{"type":"string"},"SentimentResult":{"type":"string"},"SentimentValue":{"format":"double","type":"number"},"Text":{"type":"string"}},"type":"object"},"SlangWord":{"properties":{"SlangWordText":{"type":"string"},"SlangWordTranslation":{"type":"string"}},"type":"object"},"StorageInfo":{"properties":{"CreateDate":{"format":"date-time","type":"string"},"DocumentText":{"type":"string"},"IP":{"type":"string"},"IsExcel":{"type":"boolean"},"IsGSExcel":{"type":"boolean"},"IsTwitterMode":{"type":"boolean"},"PrivateKey":{"type":"string"},"RequestIdentifier":{"type":"string"},"UserCategoryModelName":{"type":"string"}},"type":"object"}}}}