Skip to main content

​
✅ 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:
CodeMeaningDescription
200OKRequest succeeded
400Bad RequestInvalid input or missing fields
401UnauthorizedAPI key missing or invalid
404Not FoundEndpoint or resource doesn’t exist
429Too Many RequestsYou’ve hit the rate limit
500Server ErrorSomething went wrong on our side

​
Tip: Always log the response body when testing to troubleshoot issues

quickly.
Welcome 👋 🔐 API Key Ask AI
⌘I