Documentation

Welcome to SigOpt’s developer documentation. If you have a question you can’t answer, feel free to contact us!

Project Create

https://api.sigopt.com/v1/clients/CLIENT_ID/projects

Creates a new Project.

Request Method: POST

Parameters

NameTypeRequired?Description
idstringYA user-specified id for this project. This id will be used to access the project from our API. Only lowercase letters, numbers, hyphens (-), underscores (_) and periods (.) are permitted.
namestringYA user-specified name for this project.
metadataMetadataNOptional user-provided object. See Using Metadata for more information.

Response

Project object.

Example Request

project = conn.clients(CLIENT_ID).projects().create(
  name="Classification Models",
  id="classification-models"
  )
print("Created experiment: https://app.sigopt.com/experiment/" + experiment.id)
Response
{
  "client": "1",
  "created": 1414800000,
  "experiment_count": 1,
  "id": "classification-models",
  "metadata": null,
  "name": "Classification Models",
  "object": "project",
  "updated": 1446422400,
  "user": "1234"
}