# API Handbook

## API Handbook

- [Introduction](https://docs.scicrunch.io/api-service-gateway-overview/readme.md): Overview of the FAIR Data Informatics Laboratory's APIs hosted at api.scicrunch.io
- [Getting Started with the APIs](https://docs.scicrunch.io/api-service-gateway-overview/getting-started-with-sparc-apis.md): Instructions for getting started with the APIs
- [Using your API key](https://docs.scicrunch.io/api-service-gateway-overview/using-your-api-key.md): Overview of API key usage
- [API Rate Limiting](https://docs.scicrunch.io/api-service-gateway-overview/api-rate-limiting.md)
- [API Service Gateway Responses](https://docs.scicrunch.io/api-service-gateway-overview/api-service-gateway-responses.md): Overview of API Service Gateway Responses
- [Resource Information Network (RIN) Services](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services.md)
- [Research Resource Identifiers](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/research-resource-identifiers.md)
- [The RRID Resolver](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/the-rrid-resolver.md): Information about RRID resolver
- [Searching RIN Indices](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/searching-rin-indices.md): Introduction to searching the RIN indices
- [Basic RIN Search Examples](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/basic-rin-search-examples.md)
- [RIN Elaticsearch JSON Data Model](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/rin-elaticsearch-json-data-model.md)
- [Download Larger Datasets](https://docs.scicrunch.io/elasticsearch-metadata-services/resource-information-network-rin-services/download-larger-datasets.md)
- [SPARC Datasets](https://docs.scicrunch.io/elasticsearch-metadata-services/sparc-datasets.md): Overview of SPARC Dataset Services
- [Searching SPARC Dataset Indices](https://docs.scicrunch.io/elasticsearch-metadata-services/sparc-datasets/searching-sparc-dataset-indices.md)
- [Basic SPARC Search Examples](https://docs.scicrunch.io/elasticsearch-metadata-services/sparc-datasets/map-core-competency-searches.md)
- [SPARC Dataset Elasticsearch JSON Data Model](https://docs.scicrunch.io/elasticsearch-metadata-services/sparc-datasets/sparc-dataset-elasticsearch-json-data-model.md): The data model for results from Elasticsearch is provided below. We provide documentation as "comments" within a trimmed JSON document for a SPARC dataset.
- [InterLex](https://docs.scicrunch.io/terminology-services/interlex.md)
- [Searching InterLex](https://docs.scicrunch.io/terminology-services/interlex/untitled.md)
- [Basic Interlex Search Example](https://docs.scicrunch.io/terminology-services/interlex/basic-interlex-search-example.md)
- [Bulk Add](https://docs.scicrunch.io/terminology-services/interlex/bulk-add.md): Simplified example of bulk add for InterLex terms.
- [Bulk Update](https://docs.scicrunch.io/terminology-services/interlex/bulk-update.md): Simplified example of bulk update for InterLex terms.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.scicrunch.io/api-service-gateway-overview/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.