POST
/
v4
/
application-variants
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const applicationVariant = await client.applicationVariants.create({
    account_id: 'account_id',
    application_spec_id: 'application_spec_id',
    configuration: {
      edges: [{ from_field: 'from_field', from_node: 'from_node', to_field: 'to_field', to_node: 'to_node' }],
      nodes: [{ id: 'id', application_node_schema_id: 'text_input_schema' }],
    },
    name: 'name',
    version: 'V0',
  });

  console.log(applicationVariant);
}

main();
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "configuration": {
    "metadata": {},
    "guardrail_config": {
      "guardrails_to_execute": [
        "<string>"
      ]
    },
    "nodes": [
      {
        "id": "<string>",
        "application_node_schema_id": "text_input_schema",
        "configuration": {}
      }
    ],
    "edges": [
      {
        "from_node": "<string>",
        "to_node": "<string>",
        "from_field": "<string>",
        "to_field": "<string>"
      }
    ]
  },
  "version": "V0",
  "application_spec_id": "<string>",
  "draft": true,
  "published_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json
name
string
required
configuration
object
required
version
enum<string>
required
Available options:
V0
application_spec_id
string
required
account_id
string
required

The ID of the account that owns the given entity.

description
string

Optional description of the application variant

draft
boolean

Boolean to indicate whether the variant is in draft mode

published_at
string

The date and time that the variant was published.

Response

200
application/json
Successful Response
id
string
required
name
string
required
configuration
object
required
version
enum<string>
required
Available options:
V0
application_spec_id
string
required
draft
boolean
required

Boolean to indicate whether the variant is in draft mode

account_id
string
required

The ID of the account that owns the given entity.

created_at
string
required

The date and time when the entity was created in ISO format.

updated_at
string
required

The date and time when the entity was last updated in ISO format.

description
string

Optional description of the application variant

published_at
string

The date and time that the variant was published.

created_by_user_id
string

The user who originally created the entity.