Getting Started

Welcome to Reimage API! This guide will help you get up and running with the Reimage image and video processing API.

What is Reimage?

Reimage is a powerful image and video processing API that allows you to:

• Upload and store images and videos in the cloud
• Transform images on-the-fly using URL-based parameters
• Remove backgrounds from images automatically
• Process videos with HLS streaming support
• Search images using AI-powered semantic search
• Organize assets with tags and folders

Base URL

All API requests should be made to:

https://api.reimage.dev

Prerequisites

Before you begin, you'll need:

1. A Reimage account with an API key
2. Your unique bucket/directory identifier
3. Basic knowledge of REST APIs

Getting Your API Key

1. Log into your Reimage Dashboard
2. Navigate to Settings → API Keys
3. Copy your API key (keep it secure!)

Your API key should look like this:

sk_live_abc123def456ghi789

Authentication

All API requests (except image retrieval via CDN) require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

See the Authentication Guide for detailed examples in different languages.

Your First Request

Let's make your first API call to get your user information:

JavaScript

const response = await fetch('https://api.reimage.dev/user/', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const user = await response.json();
console.log(user);
// {
//   name: "John Doe",
//   bucket_id: "abc123",
//   storage_used: 1024,
//   storage_limit: 10485760,
//   image_count: 5
// }

Python

import requests

response = requests.get(
    'https://api.reimage.dev/user/',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

user = response.json()
print(user)

PHP

<?php
$ch = curl_init('https://api.reimage.dev/user/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$user = json_decode($response, true);
print_r($user);
?>

Go

package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.reimage.dev/user/", nil)
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    var user map[string]interface{}
    json.Unmarshal(body, &user)
    fmt.Println(user)
}

Rust

use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut headers = HeaderMap::new();
    headers.insert(
        AUTHORIZATION,
        HeaderValue::from_str("Bearer YOUR_API_KEY")?
    );

    let client = reqwest::Client::new();
    let response = client
        .get("https://api.reimage.dev/user/")
        .headers(headers)
        .send()
        .await?;

    let user: serde_json::Value = response.json().await?;
    println!("{:?}", user);
    Ok(())
}

Next Steps

Now that you have your API key configured:

1. Learn about Authentication - Detailed authentication examples
2. Quick Start Guide - Upload your first image
3. API Reference - Explore all available endpoints
4. Image Transformations - Learn about on-the-fly image processing

Need Help?

• Check out our API Reference for detailed endpoint documentation
• Review common Error Handling scenarios
• Contact support at [email protected]