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

# Getting Started

The Valtt API is a REST API that provides specific endpoints, receives form-data, and returns JSON encoded responses. Errors are sent using standard HTTP response codes and easy to read and understand JSON encoded error messages.\
\
The API can be used in test or live mode. The API key that is used determines which mode is being used. The same type and method of authentication is used in test and live mode.

### Getting Started

In order to use the Valtt API you will need an API Key and API Secret. In the Valtt [Dashboard](https://dashboard.valtt.com), under Account on the left menu, select API Keys, and create a new test or live API Key set.

### Authentication

The Valtt API uses Basic Auth with the API Key and API Secret that are generated in the Valtt [Dashboard](https://dashboard.valtt.com). Authentication is required for all requests except for the Status API endpoint.\
\
All API requests must be made using **HTTPS**.


---

# 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://docs.valtt.com/valtt-api/getting-started.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.
