Our GraphQL API is intended to give you full control over the objects in your account. We chose GraphQL because it avoids a great deal of programming and is completely generic: if you know how to access FaceBook or GitHub, you know how to access the API.

GraphQL is self-documenting and some excellent tooling exists to enable you to use it.

You can access our GraphQL API through our site

The actual endpoint is

The main page uses the Playground access tool. Voyager and GraphiQL are also supported on other pages.

Whatever language and platform you use will have support, normally in the form of a library, for GraphQL.

The general form for accessing the GraphQL API from your own code will be the following.

The GraphQL query language is very simple to learn, and is a kind of simplified json. Read more here

Javascript example code

An example of this process for javascript using the graphql.js client library is shown here.

    var graph = graphql("");
    var allrulesets = graph(`{ rulesets { name }}`);
    const rs = await allrulesets();

in this example rs contains a list of the ruleset names in your account.

Another example using parameters is:

    var graph = graphql("");
    var darlContent = graph(`query getdarl($name: String!){  getDarlFromRuleSet(ruleSetName: $name)}`);
    var content = await darlContent({ name: rsname });

Where the GraphQL fetches the DARL content of a ruleset, the name of which is determined by the parameter $name which is provided when darlContent is called.

Finally an example of mutation writes the darl code back. Here there are two parameters: the filename and the darl content.

    var graph = graphql("");
    var savecontent = graph('mutation setdarl($name: String!, $darl: String!){updateDarlInRuleset(ruleSetName: $name, darl: $darl)}');
    await savecontent({ name: rsname, darl: content });

C# example code

A similar example can be seen using the .net graphql-client library. With this library you specify the operation name, variables in an anonymous class, and the graphQL text. This code fetches the name and author of a particular machine learning model.

    GraphQLClient client = new GraphQLClient("");
    var req = new GraphQLRequest() { OperationName = "getModelByName", Variables = new { name = models[0].Name }, Query = @"query getModelByName($name: String!){  mlmodelByName(name: $name){ name mlmodel{ author}}}" };
    var resp = await client.PostAsync(req);