API definitions

Get Task Status

get

Get the status of a background task.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Path parameters

task_idstringRequired

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Responses

200

The status of the task. The backing task may have succeeded, failed, or may still be pending. Examine the returned task object for the status of the task.

application/json

idstringRequired

statusstring · enumRequiredPossible values:

result_typestring · enumRequired

The type that the result will be, if that result is present. This can be used to determine the type of the result field. This field will be set regardless of task status or error condition.

Possible values:

resultany ofRequired

The final response, if available. If this task has errored, please check the error field instead. The type of this field is based on the request type: /infer gives an InferenceResponse, /actionselect gives an ActionSelectionResponse, /learn gives a LearnResponse, /validate gives a ValidationResponse, and /csv-validate gives a CSVValidationResult. Response is returned by /import.

or

or

or

or

object · ValidationResponseOptional

or

or

or

nullOptional

errorany ofOptional

stringOptional

or

nullOptional

created_atstring · date-timeRequired

completed_atany ofOptional

string · date-timeOptional

or

nullOptional

202

The task is still pending. The task object will be returned, but the result field will be None.

application/json

422

In the event of an unparseable task_id, a plain-text description of the error will be returned

text/plain

get

/status/{task_id}

HTTPcURLJavaScriptPython

GET /status/{task_id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "status": "pending",
  "result_type": "InferenceResponse",
  "result": {
    "success": true,
    "error": "text",
    "warnings": [
      "text"
    ],
    "metadata": {
      "execution_time": 1,
      "memory_used": [],
      "system_cpu_avg_peak": [],
      "user_cpu_avg_peak": []
    },
    "result": {
      "probabilities": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "evidence": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "most_likely_state": "text"
    }
  },
  "error": "text",
  "created_at": "2026-03-06T05:22:36.046Z",
  "completed_at": "2026-03-06T05:22:36.046Z"
}

Get All Tasks

get

Retrieves a list of all tasks. Result bodies will be empty, even if results have been completed, since results can be quite large. To get results for a specific task, use the /status/TASK_ID endpoint.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Responses

200

Returns a list of all tasks

application/json

idstringRequired

statusstring · enumRequiredPossible values:

result_typestring · enumRequired

The type that the result will be, if that result is present. This can be used to determine the type of the result field. This field will be set regardless of task status or error condition.

Possible values:

resultany ofRequired

The final response, if available. If this task has errored, please check the error field instead. The type of this field is based on the request type: /infer gives an InferenceResponse, /actionselect gives an ActionSelectionResponse, /learn gives a LearnResponse, /validate gives a ValidationResponse, and /csv-validate gives a CSVValidationResult. Response is returned by /import.

or

or

or

or

object · ValidationResponseOptional

or

or

or

nullOptional

errorany ofOptional

stringOptional

or

nullOptional

created_atstring · date-timeRequired

completed_atany ofOptional

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/status

HTTPcURLJavaScriptPython

GET /status HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "status": "pending",
    "result_type": "InferenceResponse",
    "result": {
      "success": true,
      "error": "text",
      "warnings": [
        "text"
      ],
      "metadata": {
        "execution_time": 1,
        "memory_used": [],
        "system_cpu_avg_peak": [],
        "user_cpu_avg_peak": []
      },
      "result": {
        "probabilities": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "evidence": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "most_likely_state": "text"
      }
    },
    "error": "text",
    "created_at": "2026-03-06T05:22:36.046Z",
    "completed_at": "2026-03-06T05:22:36.046Z"
  }
]

Get Graph

get

Gets the current graph stored in this Genius instance.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Responses

200

The current graph stored in this Genius instance

application/json

anyOptional

204

204 No Content will be returned iff there is no graph stored in the Genius instance

text/plain

422

Validation Error

application/json

get

/graph

HTTPcURLJavaScriptPython

GET /graph HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vfg": {
    "factors": [
      {
        "distribution": "categorical",
        "values": [
          0.5,
          0.5
        ],
        "variables": [
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.8,
            0.2
          ],
          [
            0.2,
            0.8
          ]
        ],
        "variables": [
          "rain",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.5,
            0.9
          ],
          [
            0.5,
            0.1
          ]
        ],
        "variables": [
          "sprinkler",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            [
              1,
              0.1
            ],
            [
              0.1,
              0.01
            ]
          ],
          [
            [
              0,
              0.9
            ],
            [
              0.9,
              0.99
            ]
          ]
        ],
        "variables": [
          "wet_grass",
          "sprinkler",
          "rain"
        ]
      }
    ],
    "variables": {
      "cloudy": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "rain": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "sprinkler": {
        "elements": [
          "off",
          "on"
        ]
      },
      "wet_grass": {
        "elements": [
          "no",
          "yes"
        ]
      }
    },
    "version": "0.4.0",
    "metadata": {
      "model_type": "bayesian_network",
      "model_version": "2q",
      "description": "A simple sprinkler demo"
    }
  }
}

Set Graph

post

Sets the VFG graph to the given value.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Header parameters

if-unmodified-sinceany ofOptional

A matcher header, where the graph must not be newer than the timestamp. Timestamps are specified as RFC7231 datetime. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-matchany ofOptional

An ETag to match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-none-matchany ofOptional

An ETag to not match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

dateany ofOptional

The user's datetime, as an RFC7231 timestamp. Used as the authoritative modification time if set. Note that most clients will set this by default.

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

400

On user input error, a plain-text description of the error will be returned

text/plain

412

Preconditions are the If-Modified-Since, If-Match, and If-Not-Match headers, at least one of which must be sent. If precondition is not valid, a string detailing the failure. will be returned. To unconditionally set the graph, send "If-Not-Match": ETAG

text/plain

422

This failed to validate as a valid VFG, a description of the error will be returned.

text/plain

500

On internal server error, a plain-text description of the error will be returned

text/plain

post

/graph

HTTPcURLJavaScriptPython

POST /graph HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 730

{
  "vfg": {
    "factors": [
      {
        "distribution": "categorical",
        "values": [
          0.5,
          0.5
        ],
        "variables": [
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.8,
            0.2
          ],
          [
            0.2,
            0.8
          ]
        ],
        "variables": [
          "rain",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.5,
            0.9
          ],
          [
            0.5,
            0.1
          ]
        ],
        "variables": [
          "sprinkler",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            [
              1,
              0.1
            ],
            [
              0.1,
              0.01
            ]
          ],
          [
            [
              0,
              0.9
            ],
            [
              0.9,
              0.99
            ]
          ]
        ],
        "variables": [
          "wet_grass",
          "sprinkler",
          "rain"
        ]
      }
    ],
    "variables": {
      "cloudy": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "rain": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "sprinkler": {
        "elements": [
          "off",
          "on"
        ]
      },
      "wet_grass": {
        "elements": [
          "no",
          "yes"
        ]
      }
    },
    "version": "0.4.0",
    "metadata": {
      "model_type": "bayesian_network",
      "model_version": "2q",
      "description": "A simple sprinkler demo"
    }
  }
}

SprinklerGridWorld

{
  "vfg": {
    "version": "0.5.0",
    "metadata": {
      "model_version": "text",
      "model_type": "bayesian_network",
      "description": "text"
    },
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": {
        "elements": [
          "text"
        ],
        "role": "control_state"
      }
    },
    "factors": [
      {
        "variables": [
          "text"
        ],
        "distribution": "categorical",
        "counts": [
          1
        ],
        "values": [
          1
        ],
        "role": "transition"
      }
    ],
    "visualization_metadata": null
  }
}

Set Graph

put

Sets the VFG graph to the given value.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Header parameters

if-unmodified-sinceany ofOptional

A matcher header, where the graph must not be newer than the timestamp. Timestamps are specified as RFC7231 datetime. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-matchany ofOptional

An ETag to match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-none-matchany ofOptional

An ETag to not match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

dateany ofOptional

The user's datetime, as an RFC7231 timestamp. Used as the authoritative modification time if set. Note that most clients will set this by default.

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

400

On user input error, a plain-text description of the error will be returned

text/plain

412

Preconditions are the If-Modified-Since, If-Match, and If-Not-Match headers, at least one of which must be sent. If precondition is not valid, a string detailing the failure. will be returned. To unconditionally set the graph, send If-Match: *

text/plain

422

This failed to validate as a valid VFG, a description of the error will be returned.

text/plain

500

On internal server error, a plain-text description of the error will be returned

text/plain

put

/graph

HTTPcURLJavaScriptPython

PUT /graph HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 730

{
  "vfg": {
    "factors": [
      {
        "distribution": "categorical",
        "values": [
          0.5,
          0.5
        ],
        "variables": [
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.8,
            0.2
          ],
          [
            0.2,
            0.8
          ]
        ],
        "variables": [
          "rain",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.5,
            0.9
          ],
          [
            0.5,
            0.1
          ]
        ],
        "variables": [
          "sprinkler",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            [
              1,
              0.1
            ],
            [
              0.1,
              0.01
            ]
          ],
          [
            [
              0,
              0.9
            ],
            [
              0.9,
              0.99
            ]
          ]
        ],
        "variables": [
          "wet_grass",
          "sprinkler",
          "rain"
        ]
      }
    ],
    "variables": {
      "cloudy": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "rain": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "sprinkler": {
        "elements": [
          "off",
          "on"
        ]
      },
      "wet_grass": {
        "elements": [
          "no",
          "yes"
        ]
      }
    },
    "version": "0.4.0",
    "metadata": {
      "model_type": "bayesian_network",
      "model_version": "2q",
      "description": "A simple sprinkler demo"
    }
  }
}

SprinklerGridWorld

{
  "vfg": {
    "version": "0.5.0",
    "metadata": {
      "model_version": "text",
      "model_type": "bayesian_network",
      "description": "text"
    },
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": {
        "elements": [
          "text"
        ],
        "role": "control_state"
      }
    },
    "factors": [
      {
        "variables": [
          "text"
        ],
        "distribution": "categorical",
        "counts": [
          1
        ],
        "values": [
          1
        ],
        "role": "transition"
      }
    ],
    "visualization_metadata": null
  }
}

Delete Graph

delete

Deletes the VFG graph.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Header parameters

if-unmodified-sinceany ofOptional

A matcher header, where the graph must not be newer than the timestamp. Timestamps are specified as RFC7231 datetime. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-matchany ofOptional

An ETag to match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

if-none-matchany ofOptional

An ETag to not match. ETags are returned from the service via the "ETag" header. One of three required matchers; at least one must be set.

stringOptional

or

nullOptional

dateany ofOptional

The user's datetime, as an RFC7231 timestamp. Used as the authoritative modification time if set. Note that most clients will set this by default.

stringOptional

or

nullOptional

Responses

200

On success, returns no body.

application/jsontext/plain

object · EmptyResponseOptional

412

Preconditions are the If-Modified-Since, If-Match, and If-Not-Match headers, at least one of which must be sent. If precondition is not valid, a string detailing the failure. will be returned. To unconditionally set the graph, send If-Match: *

text/plain

422

Validation Error

application/json

delete

/graph

HTTPcURLJavaScriptPython

DELETE /graph HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{}

Patch Graph

patch

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Header parameters

if-unmodified-sinceany ofOptional

stringOptional

or

nullOptional

if-matchany ofOptional

stringOptional

or

nullOptional

if-none-matchany ofOptional

stringOptional

or

nullOptional

user-dateany ofOptional

stringOptional

or

nullOptional

acceptany ofOptional

stringOptional

or

nullOptional

content-typeany ofOptional

stringOptional

or

nullOptional

Bodyobject[]

application/json

object[]Optional

Responses

200

Successful Response

application/json

anyOptional

400

On user input error, a plain-text description of the error will be returned

text/plain

412

Preconditions are the If-Modified-Since, If-Match, and If-Not-Match headers, at least one of which must be sent. If precondition is not valid, a string detailing the failure. will be returned. To unconditionally set the graph, send "If-Not-Match": ETAG

text/plain

415

Content-Type must be application/json-patch+json for PATCH endpoint

text/plain

422

Validation Error

application/json

500

On internal server error, a plain-text description of the error will be returned

text/plain

patch

/graph

HTTPcURLJavaScriptPython

PATCH /graph HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*

No content

Infer

post

Asynchronously generates a distribution of values for the variables, given the values of all observed variables in evidence. Returns a task ID that can be used to poll for results.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

application/json

fail_on_warningany ofOptional

If True, raise an exception on warning

Default: false

booleanOptional

or

nullOptional

variablesany ofRequired

Variable id(s) to query

stringOptional

or

string[]Optional

evidenceany ofRequired

Optional key/value pairs of variable IDs and observed values on which inference is conditioned.

or

nullOptional

librarystring · enumRequired

library name, example: pgmpy

Possible values:

Responses

200

Successful Response

application/json

anyOptional

202

The task was successfully created and is being processed in the background. The response contains the task ID.

application/json

422

Validation Error

application/json

post

/infer

HTTPcURLJavaScriptPython

POST /infer HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "library": "pgmpy",
  "variables": [
    "rain",
    "sprinkler"
  ],
  "evidence": {
    "cloudy": "no"
  }
}

No content

Actionselection

post

Asynchronously returns the correct action for the next policy_len steps given the observation state index. library parameter must be set to "pymdp". Returns a task ID that can be used to poll for results.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

application/json

fail_on_warningany ofOptional

If True, raise an exception on warning

Default: false

booleanOptional

or

nullOptional

learn_likelihoodsany ofOptional

Boolean flag or parameters for learning A matrices

booleanOptional

or

or

nullOptional

learn_transitionsany ofOptional

Boolean flag or parameters for learning B matrices

booleanOptional

or

or

nullOptional

learn_initial_state_priorsany ofOptional

Boolean flag or parameters for learning D matrices

booleanOptional

or

or

nullOptional

librarystring · enumRequiredPossible values:

observationany ofRequired

integerOptional

or

stringOptional

or

policy_lenintegerRequired

use_utilityany ofOptional

Whether to use preferences for action selection

Default: true

booleanOptional

or

nullOptional

use_infogainany ofOptional

Whether to use infogain for action selection

Default: true

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

202

The task was successfully created and is being processed in the background. The response contains the task ID.

application/json

422

Validation Error

application/json

post

/actionselection

HTTPcURLJavaScriptPython

POST /actionselection HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "library": "pymdp",
  "observation": {
    "observation": 2
  },
  "policy_len": 2
}

No content

Learn

post

Asynchronously updates the parameters of the model with the given observations. Returns a task ID that can be used to poll for results.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

application/json

observations_csvstringRequired

CSV data representing observations to use for parameter estimation.

librarystring · enumOptional

library name, should be verses or pgmpy

Possible values:

algorithmany ofOptional

Algorithm to use for learning

string · enumOptionalPossible values:

or

nullOptional

initialize_parametersany ofOptional

If True, reinitialize parameters to a context-specific default before learning. If an Initialization instance, compute the initialization from the provided value.

booleanOptional

or

string · enumOptionalPossible values:

or

or

or

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

202

The task was successfully created and is being processed in the background. The response contains the task ID.

application/json

422

Validation Error

application/json

post

/learn

HTTPcURLJavaScriptPython

POST /learn HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "observations_csv": "cloudy,rain,sprinkler,wet_grass\nyes,yes,on,yes\nno,yes,on,yes\nyes,no,off,no\nno,no,off,no\nno,yes,on,yes\nno,no,off,no\nno,no,off,no\nyes,yes,on,yes\nno,yes,on,yes\nno,no,off,no\n"
}

No content

Validate

post

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

model_typestring · enumOptionalDefault: factor_graphPossible values:

correct_errorsbooleanOptionalDefault: false

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

application/json

Responses

200

Successful Response

application/json

vfgany ofOptional

or

nullOptional

errorsany ofOptionalDefault: []

or

nullOptional

400

On user input error, a plain-text description of the error will be returned

text/plain

422

This failed to validate as a valid VFG, a description of the error will be returned.

text/plain

500

On internal server error, a plain-text description of the error will be returned

text/plain

post

/validate

HTTPcURLJavaScriptPython

POST /validate HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 730

{
  "vfg": {
    "factors": [
      {
        "distribution": "categorical",
        "values": [
          0.5,
          0.5
        ],
        "variables": [
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.8,
            0.2
          ],
          [
            0.2,
            0.8
          ]
        ],
        "variables": [
          "rain",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            0.5,
            0.9
          ],
          [
            0.5,
            0.1
          ]
        ],
        "variables": [
          "sprinkler",
          "cloudy"
        ]
      },
      {
        "distribution": "categorical_conditional",
        "values": [
          [
            [
              1,
              0.1
            ],
            [
              0.1,
              0.01
            ]
          ],
          [
            [
              0,
              0.9
            ],
            [
              0.9,
              0.99
            ]
          ]
        ],
        "variables": [
          "wet_grass",
          "sprinkler",
          "rain"
        ]
      }
    ],
    "variables": {
      "cloudy": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "rain": {
        "elements": [
          "no",
          "yes"
        ]
      },
      "sprinkler": {
        "elements": [
          "off",
          "on"
        ]
      },
      "wet_grass": {
        "elements": [
          "no",
          "yes"
        ]
      }
    },
    "version": "0.4.0",
    "metadata": {
      "model_type": "bayesian_network",
      "model_version": "2q",
      "description": "A simple sprinkler demo"
    }
  }
}

SprinklerGridWorld

{
  "vfg": {
    "version": "0.5.0",
    "metadata": {
      "model_version": "text",
      "model_type": "bayesian_network",
      "description": "text"
    },
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": {
        "elements": [
          "text"
        ],
        "role": "control_state"
      }
    },
    "factors": [
      {
        "variables": [
          "text"
        ],
        "distribution": "categorical",
        "counts": [
          1
        ],
        "values": [
          1
        ],
        "role": "transition"
      }
    ],
    "visualization_metadata": null
  },
  "errors": [
    {
      "exception": "text",
      "message": "text",
      "parameters": {},
      "patch": [
        {}
      ]
    }
  ]
}

Get Version

get

Gets the current versions of deployed components.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Responses

200

Successful Response

application/json

pyvfgstringRequired

gpilstringRequired

gpilserverstringRequired

422

Validation Error

application/json

get

/version

HTTPcURLJavaScriptPython

GET /version HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "pyvfg": "text",
  "gpil": "text",
  "gpilserver": "text"
}

Validate Csv Endpoint

post

Validates a CSV file according to VFG rules.

The CSV must:

• Have headers

• Headers must be valid VFG variable names

• All rows must have same number of columns

• No empty/null/NA values allowed

• No columns with dates

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

text/csv

stringOptional

CSV data to validate

Responses

200

Successful Response

application/json

400

On user input error, a plain-text description of the error will be returned

text/plain

422

This denotes invalid CSV format or content. A plain-text description will be returned. Alternatively, if json is returned, a structured error with the validation failures will be returned.

text/plainapplication/json

500

On internal server error, a plain-text description of the error will be returned

text/plain

post

/validate-csv

HTTPcURLJavaScriptPython

POST /validate-csv HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: text/csv
Accept: */*
Content-Length: 3695

"OrderID,CustomerID,EmployeeID,OrderDate,ShipperID,ProductID,Quantity,ProductName,Price,CompanyName\n10248,90,5,1996-07-04,3,11,12,Queso Cabrales,21,Wilman Kala\n10248,90,5,1996-07-04,3,42,10,Singaporean Hokkien Fried Mee,14,Wilman Kala\n10248,90,5,1996-07-04,3,72,5,Mozzarella di Giovanni,34.8,Wilman Kala\n10249,81,6,1996-07-05,1,14,9,Tofu,23.25,Tradição Hipermercados\n10249,81,6,1996-07-05,1,51,40,Manjimup Dried Apples,53,Tradição Hipermercados\n10250,34,4,1996-07-08,2,41,10,Jack's New England Clam Chowder,9.65,Hanari Carnes\n10250,34,4,1996-07-08,2,51,35,Manjimup Dried Apples,53,Hanari Carnes\n10250,34,4,1996-07-08,2,65,15,Louisiana Fiery Hot Pepper Sauce,21.05,Hanari Carnes\n10251,84,3,1996-07-08,1,22,6,Gustaf's Knäckebröd,21,Victuailles en stock\n10251,84,3,1996-07-08,1,57,15,Ravioli Angelo,19.5,Victuailles en stock\n10251,84,3,1996-07-08,1,65,20,Louisiana Fiery Hot Pepper Sauce,21.05,Victuailles en stock\n10252,76,4,1996-07-09,2,20,40,Sir Rodney's Marmalade,81,Suprêmes délices\n10252,76,4,1996-07-09,2,33,25,Geitost,2.5,Suprêmes délices\n10252,76,4,1996-07-09,2,60,40,Camembert Pierrot,34,Suprêmes délices\n10253,34,3,1996-07-10,2,31,20,Gorgonzola Telino,12.5,Hanari Carnes\n10253,34,3,1996-07-10,2,39,42,Chartreuse verte,18,Hanari Carnes\n10253,34,3,1996-07-10,2,49,40,Maxilaku,20,Hanari Carnes\n10254,14,5,1996-07-11,2,24,15,Guaraná Fantástica,4.5,Chop-suey Chinese\n10254,14,5,1996-07-11,2,55,21,Pâté chinois,24,Chop-suey Chinese\n10254,14,5,1996-07-11,2,74,21,Longlife Tofu,10,Chop-suey Chinese\n10255,68,9,1996-07-12,3,2,20,Chang,19,Richter Supermarkt\n10255,68,9,1996-07-12,3,16,35,Pavlova,17.45,Richter Supermarkt\n10255,68,9,1996-07-12,3,36,25,Inlagd Sill,19,Richter Supermarkt\n10255,68,9,1996-07-12,3,59,30,Raclette Courdavault,55,Richter Supermarkt\n10256,88,3,1996-07-15,2,53,15,Perth Pasties,32.8,Wellington Importadora\n10256,88,3,1996-07-15,2,77,12,Original Frankfurter grüne Soße,13,Wellington Importadora\n10257,35,4,1996-07-16,3,27,25,Schoggi Schokolade,43.9,HILARIÓN-Abastos\n10257,35,4,1996-07-16,3,39,6,Chartreuse verte,18,HILARIÓN-Abastos\n10257,35,4,1996-07-16,3,77,15,Original Frankfurter grüne Soße,13,HILARIÓN-Abastos\n10258,20,1,1996-07-17,1,2,50,Chang,19,Ernst Handel\n10258,20,1,1996-07-17,1,5,65,Chef Anton's Gumbo Mix,21.35,Ernst Handel\n10258,20,1,1996-07-17,1,32,6,Mascarpone Fabioli,32,Ernst Handel\n10259,13,4,1996-07-18,3,21,10,Sir Rodney's Scones,10,Centro comercial Moctezuma\n10259,13,4,1996-07-18,3,37,1,Gravad lax,26,Centro comercial Moctezuma\n10260,55,4,1996-07-19,1,41,16,Jack's New England Clam Chowder,9.65,Old World Delicatessen\n10260,55,4,1996-07-19,1,57,50,Ravioli Angelo,19.5,Old World Delicatessen\n10260,55,4,1996-07-19,1,62,15,Tarte au sucre,49.3,Old World Delicatessen\n10260,55,4,1996-07-19,1,70,21,Outback Lager,15,Old World Delicatessen\n10261,61,4,1996-07-19,2,21,20,Sir Rodney's Scones,10,Que Delícia\n10261,61,4,1996-07-19,2,35,20,Steeleye Stout,18,Que Delícia\n10262,65,8,1996-07-22,3,5,12,Chef Anton's Gumbo Mix,21.35,Rattlesnake Canyon Grocery\n10262,65,8,1996-07-22,3,7,15,Uncle Bob's Organic Dried Pears,30,Rattlesnake Canyon Grocery\n10262,65,8,1996-07-22,3,56,2,Gnocchi di nonna Alice,38,Rattlesnake Canyon Grocery\n10263,20,9,1996-07-23,3,16,60,Pavlova,17.45,Ernst Handel\n10263,20,9,1996-07-23,3,24,28,Guaraná Fantástica,4.5,Ernst Handel\n10263,20,9,1996-07-23,3,30,60,Nord-Ost Matjeshering,25.89,Ernst Handel\n10263,20,9,1996-07-23,3,74,36,Longlife Tofu,10,Ernst Handel\n10264,24,6,1996-07-24,3,2,35,Chang,19,Folk och fä HB\n10264,24,6,1996-07-24,3,41,25,Jack's New England Clam Chowder,9.65,Folk och fä HB\n10265,7,2,1996-07-25,1,17,30,Alice Mutton,39,Blondel père et fils"

{
  "errors": [
    {
      "row": 1,
      "col": 1,
      "message": "text"
    }
  ],
  "warnings": [
    {
      "row": 1,
      "col": 1,
      "message": "text"
    }
  ]
}

Auto Bin One Off

post

Automatically bins a given column with the chosen binning strategy and number of bins.

For Continuous data, the binning strategy can be one of:

• quantile: Bins have approximately the same number of observations.

• fixed_width: Bins have the same width.

For Categorical data, the binning strategy can be:

• k_cluster: Bins are created by clustering the data, using as features the columns specified in y_columns (or all columns if y_columns is not specified).

Numeric data is generally treated as continuous, but can be coerced to categorical by setting variable_type to discrete.

If an incorrect strategy is used, a 400 will be returned with the message "Invalid binning strategy", and the list of available binning strategies. (See the Response schema.)

If the number of bins is too large for the data provided, a 400 will be returned with a message recommending fewer bins.

Authorizations

API KeyBearer Token

x-api-keystringRequired

API Key for authentication

Query parameters

profilebooleanOptional

Set to true to profile the method and return an interactive HTML profile report

Default: false

Body

application/json

Get a binning for a variable, or a set of variables

csvstringRequired

CSV data to use for binning

Responses

200

Returns a dict mapping variable names to binning results or errors.

application/json

binned_csvany ofRequired

Binned csv string

stringOptional

or

nullOptional

400

On user input error, the error message will be set and the list of available binning strategies will be returned. Not all binning strategies are suitable for all data types.

application/json

422

The CSV failed to be read, a description of the error will be returned.

text/plain

500

On internal server error, a plain-text description of the error will be returned

text/plain

post

/auto-bin-one-off

HTTPcURLJavaScriptPython

POST /auto-bin-one-off HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "csv": "\nlevel,name,state,mile,score\n1,alvin,nebraska,1.5,0.1\n1,beatrice,nebraska,2.5,0.1\n1,charlie,nebraska,3.5,0.1\n1,diana,nebraska,4.5,0.1\n1,edgar,indiana,5.5,0.5\n1,fiona,nebraska,6.5,0.1\n1,george,nebraska,7.5,0.1\n2,harriet,nebraska,8.5,0.7\n1,igor,ohio,9.5,0.8\n1,josephine,minnesota,10.5,1.0\n",
  "variables": {
    "score": {
      "binning_strategy": "quantile",
      "num_bins": 3,
      "x_column": "score"
    }
  }
}

Quantile BinningK-Means Cluster BinningFixed Width BinningK-Means Cluster, taking into account a subset of columnsCoerce a numerical column to discrete

{
  "success": {
    "variables": {
      "score": [
        0.1,
        0.55,
        1
      ],
      "name": {
        "alvin": 1,
        "beatrice": 1,
        "charlie": 1,
        "diana": 1,
        "edgar": 1,
        "fiona": 2,
        "george": 2,
        "harriet": 0,
        "josephine": 0,
        "igor": 0
      }
    }
  },
  "errors": {
    "variables": {
      "name": {
        "error": "Number of bins (11) cannot be greater than the number of unique values (10) for string data.",
        "available_binning_strategies": [
          "k_cluster"
        ]
      },
      "score": {
        "error": "Invalid binning strategy: k_cluster.",
        "available_binning_strategies": [
          "fixed_width",
          "quantile"
        ]
      }
    }
  }
}