# Audienti API

This is based on an writeup on building a secure API in Rails from [here](https://www.evernote.com/shard/s1/nl/33603/62450f51-e267-4abe-9d2e-1d6157fd7455/?csrfBusterToken=U%3D8343%3AP%3D%2F%3AE%3D15172f8a439%3AS%3Df1b8d9d819df14847d32300056480f74) and [here](https://www.evernote.com/shard/s1/nl/33603/c322621b-b88e-4e53-9da2-9846d80a51cf/?csrfBusterToken=U%3D8343%3AP%3D%2F%3AE%3D151731a6df9%3AS%3D12c7b44fafe25e2360173d73b9473bef)

The Audienti API is a versioned API, currently at v1 (THIS IS NOT IMPLEMENTED YET).

## Version 1 scope

* The API only consumes and responds with JSON.
* The API uses Devise for API keys. An API key is available to each user. And, this API only provides access to items that would be available to that user in using the traditional UI.
* The API is primarily being setup to allow JSON requests for the Workflow builder. Though, it is assumed that we will expand this rapidly in the coming weeks and months.
* The API is read only.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://omalab.gitbook.io/guide/engineering-wiki/api/audienti-api.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.
