globalMOO API Documentation

Welcome to the globalMOO API documentation. This guide covers everything you need to know about using the globalMOO API and its associated SDKs.

Getting Started

• Getting Started Guide - Quick introduction to globalMOO

• Interactive Tutorial - Try globalMOO in an interactive Google Colab notebook

• Authentication - How to authenticate with the API

• Core Concepts - Key concepts and terminology

• Error Handling - Error types and handling strategies

• Event Handling - Process API events and webhooks

• SDK Initialization - Configure and initialize SDKs

• Debugging & Logging - Debug mode and logging configuration

Response Schemas

Detailed schema documentation for API responses:

• Result Schema - Objective result format

• Inverse Schema - Inverse optimization step format

API Resources

Account Management

• Account Endpoints

  • Account registration

  • API key management

Model Management

• Model Endpoints

  • Create and manage optimization models

  • List available models

Project Configuration

• Project Endpoints

  • Create optimization projects

  • Configure input parameters

Trial Execution

• Trial Endpoints

  • Read trial information

  • Monitor optimization progress

Objective Management

• Objective Endpoints

  • Define optimization objectives

  • Set optimization targets

Inverse Optimization

• Inverse Endpoints

  • Initialize inverse optimization

  • Manage optimization iterations

  • Load outputs

Output Management

• Output Endpoints

  • Load developed outputs

  • Manage output cases

API Versions

This documentation is for API version 1.0.

Support

For additional support:

• Contact technical support

• Join our community

• Read our tutorials

• Visit our blog