> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vambe.me/llms.txt
> Use this file to discover all available pages before exploring further.

# 🔌 Integration to the API

> Integration can be a headache 😵‍💫, here is a quick breakdown of our API to help you get started.

## ✅ Prerequisites

Before you begin, make sure you have:

* A Vambe account.
* Access to your **API Key**.
* A tool to make HTTP requests (e.g. Postman, Insomnia, curl).
* Basic understanding of REST APIs and JSON.

***

## 🔐 Authentication

All requests to the Vambe API require authentication via your own API Key.

### Step 1: Get Your API Key

Getting Your API Key

### Step 2: Add Authorization Header

Include your API key in the request header like this:

```
x-api-key: YOUR_API_KEY
```

***

## 📦 Base URL

All API requests use this base URL:

```
https://iris-backend-production.up.railway.app/api
```

***

## ⚙️ Request & Response Format

* All requests and responses are in **JSON**.
* Use `Content-Type: application/json` for all POST requests.

***

## 📛 Error Codes

The API uses standard HTTP response codes. Here are some common ones:

| Code | Meaning           | Description                        |
| ---- | ----------------- | ---------------------------------- |
| 200  | OK                | Request succeeded                  |
| 400  | Bad Request       | Invalid input or missing fields    |
| 401  | Unauthorized      | API key missing or invalid         |
| 404  | Not Found         | Endpoint or resource doesn’t exist |
| 429  | Too Many Requests | You’ve hit the rate limit          |
| 500  | Server Error      | Something went wrong on our side   |

<Info>
  ### **Tip:** Always log the response body when testing to troubleshoot issues

  quickly.
</Info>

***

[Welcome 👋](/docs/getting-started)

[🔐 API Key](/docs/integration-to-the-api)

Ask AI

* [Table of Contents](#)

* * [✅ Prerequisites](#-prerequisites)

  * [🔐 Authentication](#-authentication)

  * * [Step 1: Get Your API Key](#step-1-get-your-api-key)
    * [Step 2: Add Authorization Header](#step-2-add-authorization-header)

  * [📦 Base URL](#-base-url)

  * [⚙️ Request & Response Format](#%EF%B8%8F-request--response-format)

  * [📛 Error Codes](#-error-codes)