> For the complete documentation index, see [llms.txt](https://documentation.dnanexus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.dnanexus.com/developer/api.md).

# DNAnexus API

Learn to access the DNAnexus Platform programmatically.

The DNAnexus Platform can be accessed programmatically through an API using HTTP requests to the DNAnexus API servers. Each API method may receive zero or more arguments as fields in a JSON string, and may return some results, always as a JSON string. For specifics on how to call an API method, see [Protocols](/developer/api/protocols.md) and [Authentication](/developer/api/authentication.md).

To skip to a particular API method, you can look it up in the [Directory of API Methods](/developer/api/api-directory.md).

## The API methods

You can expect URLs corresponding to API methods to be always of the following form:

```
/subject/methodname
```

Where the subject can be one of the following:

1. The word "system", for system-wide methods. These methods are for search functionality, as well as other utilities that do not fall under a specific entity class. **Example**: `/system/findDataObjects` accepts query parameters and returns a list of matching data objects.
2. An entity class for which a new instance may be created **Example**: `/file/new` creates a new file data object that can be written to
3. An entity ID, for methods that act on existing instances, where the method name is a verb acting on the object. **Example**: `/file-xxxx/close` closes the file object with ID "file-xxxx"

### Data Types

When describing an input or output to an API method, the data type is given in **bold**. For example:

* `tags` **array of strings** Tags to be added to the file.

The following data types are used: **number, integer, timestamp, string, boolean, null, array, mapping**.

* **number, string, boolean, null, array** correspond to the [JSON data types](https://en.wikipedia.org/wiki/JSON#Data_types) of the same name.
* **integer** is an integer JSON number
* **mapping** is a [JSON object](https://en.wikipedia.org/wiki/JSON#Data_types).
* **timestamp** is an integer JSON number representing the number of milliseconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time) (UTC).

## Concepts

The following concepts in the DNAnexus API affect the operation of many API methods:

* [Regions](/developer/api/regions.md)


---

# 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://documentation.dnanexus.com/developer/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.