Chroma Golem API Documentation

Capabilities

Generating Data

Our text generation API also doubles as a data generation service when coupled with pre-defined data schemas, enabling you to create new data for your game while your players are playing.

Examples of data generation tasks our API is great for

Constructing your prompt

Just like with text generation, data generation prompts come in two required parts:

  1. System message: This is a description of what the AI will be tasked with generating and often includes examples of both input and output.
    Tip: This is where you should define the schema for the data you want to generate; give an example of the format!
  2. User message: This provides all the context needed for a single data generation request.
    Tip: This is where you'll typically provide your "input" to the data generation: ingredients, materials, etc.

Data Serialization

When generating data, we recommend using structured formats for both input and output. This ensures consistency and makes it easier to parse the results in your game. Here are the recommended formats:

JSON

Most common format, supported by all major game engines and programming languages.

{
  "item": {
    "name": "Crystal Sword",
    "type": "weapon",
    "stats": {
      "damage": 45,
      "durability": 100
    },
    "materials": ["iron", "crystal"]
  }
}

YAML

More human-readable format, great for complex nested structures.

item:
  name: Crystal Sword
  type: weapon
  stats:
    damage: 45
    durability: 100
  materials:
    - iron
    - crystal

Pro tip: Always validate your generated data against a schema before using it in your game. This helps catch any unexpected variations in the output.

Make your API request

curl https://api.chromagolem.com/v1/chat/completions \
    -H "Content-Type: application/json" \
    -d '{
    "api_key": "cg-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "client_id": "123456789",
    "messages": [
        {
        "role": "system",
        "content": "I want to combine these items:\n{\"item1\": {\"name\": \"Steel Dagger\", \"type\": \"weapon\", \"damage\": 5, \"durability\": 100}, \"item2\": {\"name\": \"Frozen Flame\", \"type\": \"magical_essence\", \"element\": \"ice\", \"power\": 8}}"
        },
        {
        "role": "user",
        "content": "{\"item1\": {\"name\": \"Steel Dagger\", \"type\": \"weapon\", \"damage\": 5, \"durability\": 100}, \"item2\": {\"name\": \"Frozen Flame\", \"type\": \"magical_essence\", \"element\": \"ice\", \"power\": 8}}"
        }
    ]
    }'
Response: 
{
  "result": {
    "name": "Frost-Touched Dagger",
    "type": "magical_weapon",
    "base_damage": 7,
    "ice_damage": 4,
    "durability": 120,
    "effects": [
      "Freezes targets on critical hits",
      "Emits cold aura"
    ],
    "rarity": "rare"
  }
}

using System.Net.Http;
using Newtonsoft.Json;

var url = 'https://api.chromagolem.com/v1/chat/completions';

var items = new
{
    item1 = new { 
        name = "Steel Dagger", 
        type = "weapon", 
        damage = 5, 
        durability = 100
    },
    item2 = new { 
        name = "Frozen Flame", 
        type = "magical_essence", 
        element = "ice", 
        power = 8
    }
};

var data = new
{
    api_key = "cg-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    client_id = "123456789",
    messages = new[]
    {
        new { role = "system", content = "Simulate the process of combining two items to create a new magical weapon or armor at an enchanted forge. You should output a single JSON blob of this format: [format]" },
        new { role = "user", content = JsonConvert.SerializeObject(items) }
    }
};

var json = JsonConvert.SerializeObject(data);
var content = new StringContent(json, Encoding.UTF8, "application/json");

using(var client = new HttpClient())
{
    var response = await client.PostAsync(url, content);
    var responseString = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseString);
}

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id 
import requests
import json

url = 'https://api.chromagolem.com/v1/chat/completions'
items = {
    "item1": {
        "name": "Steel Dagger",
        "type": "weapon",
        "damage": 5,
        "durability": 100
    },
    "item2": {
        "name": "Frozen Flame",
        "type": "magical_essence",
        "element": "ice",
        "power": 8
    }
}

data = {
    "api_key": "cg-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "client_id": "123456789",
    "messages": [
        {
            "role": "system",
            "content": "Simulate the process of combining two items to create a new magical weapon or armor at an enchanted forge. You should output a single JSON blob of this format: [format]"
        },
        {
            "role": "user",
            "content": json.dumps(items)
        }
    ]
}

headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id 
require 'net/http'
require 'json'

items = {
  item1: {
    name: "Steel Dagger",
    type: "weapon",
    damage: 5,
    durability: 100
  },
  item2: {
    name: "Frozen Flame",
    type: "magical_essence",
    element: "ice",
    power: 8
  }
}

uri = URI('https://api.chromagolem.com/v1/chat/completions')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = JSON.dump({
  api_key: "cg-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  client_id: "123456789",
  messages: [
    {
      role: "system",
      content: "Simulate the process of combining two items to create a new magical weapon or armor at an enchanted forge. You should output a single JSON blob of this format: [format]"
    },
    {
      role: "user",
      content: items.to_json
    }
  ]
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.body

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id 
#include <iostream>
#include <string>
#include <curl/curl.h>

int main() {
    CURL *curl;
    CURLcode res;
    std::string readBuffer;

    curl = curl_easy_init();
    if(curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.chromagolem.com/v1/chat/completions");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"api_key\": \"cg-ABCDEFGHIJKLMNOPQRSTUVWXYZ\", \"client_id\": \"123456789\", \"messages\": [{\"role\": \"system\", \"content\": \"Simulate the process of combining two items to create a new magical weapon or armor at an enchanted forge. You should output a single JSON blob of this format: [format]\"}, {\"role\": \"user\", \"content\": \"{\\\"item1\\\": {\\\"name\\\": \\\"Steel Dagger\\\", \\\"type\\\": \\\"weapon\\\", \\\"damage\\\": 5, \\\"durability\\\": 100}, \\\"item2\\\": {\\\"name\\\": \\\"Frozen Flame\\\", \\\"type\\\": \\\"magical_essence\\\", \\\"element\\\": \\\"ice\\\", \\\"power\\\": 8}}\"}]}");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, "Content-Type: application/json");

        res = curl_easy_perform(curl);
        if(res != CURLE_OK)
            fprintf(stderr, "curl_easy_perform() failed: %s\n", curl_easy_strerror(res));

        curl_easy_cleanup(curl);
    }
    return 0;
}

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id
We'll also be releasing a Unity asset soon. Join our Discord to stay updated.

Request parameters

Parameter Description
Required
api_key string 		Your API key that identifies you, the developer. You can create and find your API keys on your dashboard.
Required
client_id string 		A unique client ID that refers to a specific player. This should typically be a value that is randomized for each player that does not identify them in any way, but does differentiate them from other players.
Required
messages array 		The messages array is a list of messages that the AI will use to generate content. Each message object should have a role and content property. The role property should be either "system", "user", or "assistant" and the content property should be a string.
Optional
generation_only bool 		Defaults false. Setting this to true will omit all structure and metadata for your response, and only return the generated text as plaintext.
Optional
prompt_id string 		Defaults null. You may pass a unique identifier per prompt to tag requests and compare per-prompt analytics.

Response format See full documentation 

  {
    "choices": [
      {
        "message": {
          "content": "{\"name\": \"Thunderstruck Warhammer\", \"type\": \"weapon\", \"damage\": 12, \"durability\": 85, \"description\": \"A mighty hammer crackling with residual storm energy\", \"effects\": [\"Echoing impact\"]}",
          "role": "assistant"
        },
        "finish_reason": "stop",
        "content_filter_results": {
          "hate": {
            "filtered": false,
            "severity": "safe"
          },
          "self_harm": {
            "filtered": false,
            "severity": "safe"
          },
          "sexual": {
            "filtered": false,
            "severity": "safe"
          },
          "violence": {
            "filtered": false,
            "severity": "safe"
          }
        }
      }
    ],
    "created": 1723233503,
    "id": "chatcmpl-9uFxrHYZYk2CxnfQIU854bvmOpuRU",
    "model": "gpt-35-turbo",
    "usage": {
      "completion_tokens": 45,
      "prompt_tokens": 42,
      "total_tokens": 87
    }
  }

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id 
  {
    "name": "Thunderstruck Warhammer",
    "type": "weapon",
    "damage": 12,
    "durability": 85,
    "description": "A mighty hammer crackling with residual storm energy",
    "effects": [
      "Echoing impact"
    ]
}

Code example

This example will make a request to our APIs directly from your console. You can use this as a starting point to integrate our APIs into your game using whatever web request library you're familiar with.

Required parameters

api_key client_id messages

Optional parameters

generation_only prompt_id

Have questions?

Need a little extra help? Join our Discord server for game devs to chat with our team and other developers.

Back to your dashboard
View my API keys