> For the complete documentation index, see [llms.txt](https://help.bioinsight.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.bioinsight.illumina.com/connected-analytics/api-access/r-api.md).

# API Overview

Any operation from the Platform Core graphical user interface can also be performed with the API.

#### Beginner Guide

If you are new to the API, start here by learning how to [authenticate](/connected-analytics/api-access/getting-started/api-authentication.md) your requests. Then use the [API Beginner Guide](/connected-analytics/api-access/getting-started/api-introduction.md) for introductory examples that demonstrate how to make requests, work with responses, and use the Platform Core API with Python.

#### Testing individual API calls

To immediately start testing individual API calls, [authenticate](/connected-analytics/api-access/getting-started/api-authentication.md) the [Swagger API Reference](https://ica.illumina.com/ica/api/swagger/index.html) which shows detailed information about the API schemas in accordance to the OpenAPI 3.0 specification. There you will also find the option to call APIs from the browser page to test what each API call does. Alternatively, HTTP client tooling such as Postman or cURL can be used to make direct calls to the API outside of the browser. The APIs support Cross-origin resources sharing (CORS).


---

# 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 that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.bioinsight.illumina.com/connected-analytics/api-access/r-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.