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

# API

Welcome to the HIVO API! You can use our API to access HIVO API endpoints.

This API follows the [json:api specification](https://jsonapi.org/). You can register a new HIVO API key by contacting HIVO Support.\
\
HIVO expects a `USER_ID` and `API_KEY` in all API requests to the server in headers.

#### Response Details <a href="#response-details" id="response-details"></a>

Every response has the following properties:

* All responses are of type `application/json; charset=utf-8`.
* All responses are a JSON object containing the `meta` property.
* The response either contains the `data` or `errors` property depending on whether the request was successful. The two properties will never coexist.
* The `meta` object always contains a `timestamp` property, which is a server timestamp in milliseconds.
* If the User was successfully authenticated, the `meta` object will contain the properties:
  * `authentication` - property describing how the User was authenticated. If using an API key, this will be `"apiKey"`.
  * `links.meta` - link to the User who was authenticated.
* If the request contains the `Accept-Encoding: gzip` header, the response may be gzipped and returned with the `Content-Encoding: gzip` header.


---

# 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 dynamically by asking a question.

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

```
GET https://support.hivo.co/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.