ExplorationApi

All URIs are relative to https://model-service.worldmodelers.com

list_models_post

AvailableModels list_models_post()

Obtain a list of current models

Request a list of currently available models.

Example

import requests

response = requests.post('https://model-service.worldmodelers.com/list_models')

Parameters

This endpoint does not need any parameter.

Return type

AvailableModels

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

model_config_model_name_get

ModelConfig model_config_model_name_get(model_name)

Obtain configurations for a given model.

Submit a model name and receive all configurations for the given model.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/model_config/malnutrition_model')

Parameters

Return type

ModelConfig

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

model_info_model_name_get

Model model_info_model_name_get(model_name)

Get basic metadata information for a specified model.

Submit a model name and receive metadata information about the model, such as its purpose, who maintains it, and how it can be run.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/model_info/malnutrition_model')

Parameters

Return type

Model

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

model_outputs_model_name_get

list[Variable] model_outputs_model_name_get(model_name)

Obtain information on a given model’s outputs.

Submit a model name and receive information about the output variables produced by this model.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/model_outputs/malnutrition_model')

Parameters

Return type

list[Variable]

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

model_parameters_model_name_get

list[Parameter] model_parameters_model_name_get(model_name)

Obtain information about a model’s parameters.

Submit a model name and receive information about the parameters used by this model. Specific parameters are used on a per-configuration basis.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/model_parameters/malnutrition_model')

Parameters

Return type

list[Parameter]

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]