Quickstart
Getting Started with REALM AI
Welcome to REALM AI! This guide will walk you through the essential steps to start using our platform and APIs.
1. Obtain API Credentials
To interact with the REALM AI API, you first need to obtain API credentials.
Sign Up: If you haven't already, sign up for a REALM AI account at https://realm.ai/signup.
Generate API Key: Navigate to the 'API Settings' section in your account dashboard.
Create Key: Generate a new API key. Make sure to copy and store your
API Secretsecurely, as it will not be shown again.
Your API Key and API Secret will be used for authentication.
2. Authentication
REALM AI uses API Key-based authentication. Include your API Key in the X-API-Key header for all requests.
GET /v1/user/profile HTTP/1.1
Host: api.realm.ai
X-API-Key: YOUR_API_KEYSome sensitive operations might require additional signature-based authentication using your API Secret. Refer to the Authentication API Documentation for details.
3. Core Concepts Review
Before diving in, familiarize yourself with the core concepts outlined in the Introduction:
AI Models
Influencers
Prompts
Training Data
Solana Integration
4. Making Your First API Call
Let's try a simple API call to fetch your user profile information:
curl -X GET https://api.realm.ai/v1/user/profile \
-H "X-API-Key: YOUR_API_KEY"You should receive a JSON response containing your profile details.
5. Exploring the API
Now you're ready to explore the different functionalities offered by REALM AI:
Create an AI Influencer: See the Model Creation API and the Creating Your First AI Influencer Guide.
Generate Images: Check the Image Generation API.
Browse the Marketplace: Explore the Marketplace API.
6. Using SDKs (Coming Soon)
We are developing SDKs for popular languages like Python and JavaScript to simplify integration. Keep an eye on the SDKs Overview page for updates.
Next Steps
Dive into the API Reference for detailed endpoint information.
Follow the Guides for step-by-step workflows.
Last updated