Searching InterLex

Introduction

The InterLex APIs are provided via an ElasticSearch endpoint.

Access to the InterLex APIs

Access to the InterLex API is provided via an Elasticsearch pass-through.

Elasticsearch Pass-Through

POST https://api.scicrunch.io/elastic/v1/Interlex_pr/_search

The pass-through is accessible at https://scicrunch.org/api/1/elastic. Similar to standard Elasticsearch APIs you must then supply an index and an action. In this case the Interlex index (Interlex_pr) and the search command (_search). Documentation on the Elasticsearch Search API is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search.html

Path Parameters

Name	Type	Description
index*	string	For InterLex this is Interlex_pr

Headers

Name	Type	Description
apikey*	String	Your API key to access the services

Request Body

Name	Type	Description
data	String	JSON query body

200

{
    "took": 35,
    "timed_out": false,
    "_shards": {
        "total": 2,
        "successful": 2,
        "skipped": 0,
        "failed": 0
    },
    "hits": {...

Elasticsearch Pass-Through

GET https://api.scicrunch.io/elastic/v1/Interlex_pr/_search

The pass-through is accessible at https://scicrunch.org/api/1/elastic. Similar to standard Elasticsearch APIs you must then supply an index and an action. In this case the Interlex index (Interlex_pr) and the search command (_search). Documentation on the Elasticsearch Search API is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search.html

Path Parameters

Name	Type	Description
index*	String	For InterLex this is Interlex_pr

Query Parameters

Name	Type	Description
q	String	Search String

Headers

Name	Type	Description
apikey*	String	Your API key to access the services

Interlex indices

Management of indices is accomplished via Elasticsearch aliases. The index aliases are provided:

Index Alias	Description
Interlex_pr	Production Interlex index

Using aliases will allow for testing on updates and enhancements to the index structure. If needed additional aliases can be constructed for specialized testing.