{"_id":"55a8c513cf45e1390093f18c","user":"55a7ae50bf1be93100d89df1","__v":50,"parentDoc":null,"version":{"_id":"55a7aee84a33f92b00b7a153","__v":6,"project":"55a7aee84a33f92b00b7a150","createdAt":"2015-07-16T13:17:28.411Z","releaseDate":"2015-07-16T13:17:28.411Z","categories":["55a7aee94a33f92b00b7a154","55a7fefa3efe0c2f0074cbdf","55a8fb10c8bd450d000dd130","55a936b1cf45e1390093f362","55abddeaa36ccd0d00fdebe1","5624db675a86b423009462e1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"55a7aee84a33f92b00b7a150","category":{"_id":"55a8fb10c8bd450d000dd130","version":"55a7aee84a33f92b00b7a153","pages":["55a8fba727a17d21005251f2","55abb16e63a6b60d006616ec","56a217be2255370d00ad5ece","56b2187ba5a1020d00cf4c53"],"project":"55a7aee84a33f92b00b7a150","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-17T12:54:40.206Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-17T09:04:19.460Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Once you have your [API Key and ID](doc:api-key), you can use the Text Analysis API in two ways:\n\n1. By sending HTTP `POST` or `GET` requests to `https://api.aylien.com/api/v1` followed by the endpoint name, e.g. for a Concept Extraction call the full URL would be `https://api.aylien.com/api/v1/concepts`.\n2. By using one of our **SDKs**. If you're using an SDK please skip the following sections and jump straight to Endpoints for examples on how to utilize the API using any of the SDKs.\n\n<a href=\"/docs/node-sdk\" class=\"label label-success\" style=\"font-size: 14px; color: white;\"><i class=\"icon-nodejs\"></i> NodeJS SDK</a>&nbsp;  <a href=\"/docs/python-sdk\" class=\"label label-warning\" style=\"font-size: 14px; color: white;\"><i class=\"icon-python\"></i> Python SDK</a>&nbsp; <a href=\"/docs/php-sdk\" class=\"label label-primary\" style=\"font-size: 14px; color: white;\"><i class=\"icon-php\"></i> PHP SDK</a>&nbsp; <a href=\"/docs/java-sdk\" class=\"label label-default\" style=\"font-size: 14px; color: #fff;\"><i class=\"icon-java-bold\"></i> Java SDK</a>&nbsp;  <a href=\"/docs/ruby-sdk\" class=\"label label-danger\" style=\"font-size: 14px; color: white;\"><i class=\"icon-ruby\"></i> Ruby SDK</a>&nbsp;  <a href=\"/docs/go-sdk\" class=\"label label-info\" style=\"font-size: 14px; color: white;\"><i class=\"fa fa-cubes\"></i> Go SDK</a>&nbsp; <a href=\"/docs/csharp-sdk\" class=\"label label-primary\" style=\"font-size: 14px; color: white; background-color: rgb(177, 105, 189);\"><i class=\"icon-csharp\"></i> C# SDK</a>\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authorization\"\n}\n[/block]\nRequests to the API must be authorized by adding the following headers:\n\n- `X-AYLIEN-TextAPI-Application-Key` must be set to your Application Key.\n- `X-AYLIEN-TextAPI-Application-ID` must be set to your Application ID.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"GET or POST\"\n}\n[/block]\nMost endpoints support both `GET` and `POST` methods. If you're dealing with long text, please consider using `POST`.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Maximum Input Size\"\n}\n[/block]\nMaximum Request URI size is 8 kB and body can't be larger than 6 MB.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"JSON or XML\"\n}\n[/block]\nThe API by default returns JSON results. You can request results in JSON or XML formats for all of the endpoints. Set `Accept` header to `text/xml` or `application/json` to change the format of your results.","excerpt":"","slug":"usage","type":"basic","title":"Usage"}
Once you have your [API Key and ID](doc:api-key), you can use the Text Analysis API in two ways: 1. By sending HTTP `POST` or `GET` requests to `https://api.aylien.com/api/v1` followed by the endpoint name, e.g. for a Concept Extraction call the full URL would be `https://api.aylien.com/api/v1/concepts`. 2. By using one of our **SDKs**. If you're using an SDK please skip the following sections and jump straight to Endpoints for examples on how to utilize the API using any of the SDKs. <a href="/docs/node-sdk" class="label label-success" style="font-size: 14px; color: white;"><i class="icon-nodejs"></i> NodeJS SDK</a>&nbsp; <a href="/docs/python-sdk" class="label label-warning" style="font-size: 14px; color: white;"><i class="icon-python"></i> Python SDK</a>&nbsp; <a href="/docs/php-sdk" class="label label-primary" style="font-size: 14px; color: white;"><i class="icon-php"></i> PHP SDK</a>&nbsp; <a href="/docs/java-sdk" class="label label-default" style="font-size: 14px; color: #fff;"><i class="icon-java-bold"></i> Java SDK</a>&nbsp; <a href="/docs/ruby-sdk" class="label label-danger" style="font-size: 14px; color: white;"><i class="icon-ruby"></i> Ruby SDK</a>&nbsp; <a href="/docs/go-sdk" class="label label-info" style="font-size: 14px; color: white;"><i class="fa fa-cubes"></i> Go SDK</a>&nbsp; <a href="/docs/csharp-sdk" class="label label-primary" style="font-size: 14px; color: white; background-color: rgb(177, 105, 189);"><i class="icon-csharp"></i> C# SDK</a> [block:api-header] { "type": "basic", "title": "Authorization" } [/block] Requests to the API must be authorized by adding the following headers: - `X-AYLIEN-TextAPI-Application-Key` must be set to your Application Key. - `X-AYLIEN-TextAPI-Application-ID` must be set to your Application ID. [block:api-header] { "type": "basic", "title": "GET or POST" } [/block] Most endpoints support both `GET` and `POST` methods. If you're dealing with long text, please consider using `POST`. [block:api-header] { "type": "basic", "title": "Maximum Input Size" } [/block] Maximum Request URI size is 8 kB and body can't be larger than 6 MB. [block:api-header] { "type": "basic", "title": "JSON or XML" } [/block] The API by default returns JSON results. You can request results in JSON or XML formats for all of the endpoints. Set `Accept` header to `text/xml` or `application/json` to change the format of your results.