globalMOO Documentation
  • globalMOO API Documentation
  • core
    • Authentication
    • Core Concepts
    • Getting Started with globalMOO
    • Error Handling
    • Event Handling
    • SDK Initialization
    • Debugging & Logging
  • schemas
    • Account Schema
    • Model Schema
    • Project Schema
    • Trial Schema
    • Objective Schema
    • Result Schema
    • Inverse Schema
  • quickstart
    • Your First Optimization with globalMOO
  • endpoints
    • accounts
      • Account Endpoints
      • Register Account
    • inverse
      • Inverse Optimization Endpoints
      • Initialize Inverse Optimization
      • Load Inverse Output
      • Suggest Inverse Step
    • models
      • Create Model
      • Model Endpoints
      • List Models
    • objectives
      • Objective Endpoints
      • Load Objectives
    • outputs
      • Output Endpoints
      • Load Output Cases
      • Load Developed Outputs
    • projects
      • Create Project
      • Project Endpoints
    • trials
      • Trial Endpoints
      • Read Trial
Powered by GitBook
On this page
  • Available Endpoints
  • Project Object
  • Input Types
  • Common Use Cases
  1. endpoints
  2. projects

Project Endpoints

PreviousCreate ProjectNexttrials

Last updated 3 months ago

Projects in globalMOO define the optimization space for a model by specifying input variables and their constraints.

Available Endpoints

  • - Create a new project under a model

Project Object

A project object contains the following fields:

{
    "id": 123,
    "model_id": 456,
    "input_count": 3,
    "minimums": [0.0, -10.0, 0.0],
    "maximums": [100.0, 10.0, 1.0],
    "input_types": ["float", "integer", "boolean"],
    "categories": [],
    "created_at": "2025-01-31T10:00:00.000Z",
    "updated_at": "2025-01-31T10:00:00.000Z"
}
Field
Type
Description

id

integer

Unique identifier for the project

model_id

integer

ID of the parent model

input_count

integer

Number of input variables (must be > 0)

minimums

array[float]

Minimum values for each input variable

maximums

array[float]

Maximum values for each input variable

input_types

array[string]

Type for each input variable (see Input Types below)

categories

array[string]

Categories for category type inputs

created_at

string

ISO 8601 timestamp with millisecond precision

updated_at

string

ISO 8601 timestamp with millisecond precision

disabled_at

string

Optional ISO 8601 timestamp when project was disabled

developed_at

string

Optional ISO 8601 timestamp when project was developed

input_cases

array[array[float]]

Array of input test cases

case_count

integer

Number of test cases

Input Types

Projects support the following input types:

  1. float - Real-valued numbers within defined min/max range

  2. integer - Whole numbers within defined min/max range

  3. category - Values from a predefined category list

  4. boolean - Boolean values (0 or 1)

Common Use Cases

  1. Defining optimization parameters for a model

  2. Setting up constraints for optimization variables

  3. Preparing for trial runs with different input configurations

Create Project