Blossom API Access

Realtime Connection

URL

Query Parameters

Headers

Authorization: Bearer YOUR_API_KEY

OpenAI-Beta: realtime=v1

Substitute YOUR_API_KEY with a standard API key on the server, or an ephemeral token on insecure clients (note that WebRTC is recommended for this use case).

This header is required during the beta period.

Sample Code

import WebSocket from "ws";

const url = "wss://api.openai.com/v1/realtime?model=gpt-4o-realtime-preview-2024-12-17";
const ws = new WebSocket(url, {
  headers: {
    "Authorization": "Bearer " + process.env.OPENAI_API_KEY,
    "OpenAI-Beta": "realtime=v1",
  },
});

ws.on("open", function open() {
  console.log("Connected to server.");
});

ws.on("message", function incoming(message) {
  console.log(JSON.parse(message.toString()));
});

Generate Response

URL

Query Parameters

Headers

Authorization: Bearer YOUR_API_KEY

Content-Type: application/json

Substitute YOUR_API_KEY with the API key generated from your account.

Sample Code

import axios from 'axios';

const apiKey = 'YOUR_API_KEY';
const url = 'https://[your-domain]/api/v1/generate?agent=motivation_mapping';

async function generateResponse() {
    try {
        const response = await axios.post(url, {
            prompt: 'What motivates successful community engagement?'
        }, {
            headers: {
                'Authorization': `Bearer ${apiKey}`,
                'Content-Type': 'application/json'
            }
        });
        console.log(response.data);
    } catch (error) {
        console.error('Error:', error.response?.data || error.message);
    }
}

generateResponse();

Authorization: Bearer YOUR_API_KEY

Content-Type: application/json

import axios from 'axios';

const apiKey = 'YOUR_API_KEY';
const url = 'https://[your-domain]/api/v1/analyze?user_id=example_user&timeframe=last_7_days';

async function analyzeEngagement() {
    try {
        const response = await axios.post(url, {
            metrics: ['participation', 'consistency']
        }, {
            headers: {
                'Authorization': `Bearer ${apiKey}`,
                'Content-Type': 'application/json'
            }
        });
        console.log(response.data);
    } catch (error) {
        console.error('Error:', error.response?.data || error.message);
    }
}

analyzeEngagement();