Create a new project

curl --request POST \
  --url https://api.salesnip.com/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Acme",
  "description": "[Acme] is a company that sells [product] with great quality and low prices.",
  "support": {
    "method": "EMAIL",
    "url": "https//example.com/support",
    "email": "[email protected]"
  },
  "theme": {
    "shapes": "ROUNDED",
    "light": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    },
    "dark": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    }
  }
}
'

{
  "id": "project_abcdefghjijklmnop"
}

POST

projects

curl --request POST \
  --url https://api.salesnip.com/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Acme",
  "description": "[Acme] is a company that sells [product] with great quality and low prices.",
  "support": {
    "method": "EMAIL",
    "url": "https//example.com/support",
    "email": "[email protected]"
  },
  "theme": {
    "shapes": "ROUNDED",
    "light": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    },
    "dark": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    }
  }
}
'

{
  "id": "project_abcdefghjijklmnop"
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

name

string

required

The name of the project.

Required string length: 3 - 25

Example:

"Acme"

description

string

required

A short description of the project that helps the AI to understand the project.

Maximum string length: 1000

Example:

"[Acme] is a company that sells [product] with great quality and low prices."

support

object

required

Show child attributes

support.method

enum<string>

required

The support method to choose from.

Available options:

EMAIL,

URL

support.url

string<uri>

The URL to redirect to if the user requests to contact the support. This is required if you have support.method set to "URL".

Example:

"https//example.com/support"

support.email

string<email>

The email address to redirect to if the user requests to contact the support. This is required if you have support.method set to "EMAIL".

Example:

"[email protected]"

theme

object

The theme of the SaleSnip widget. This can be used to customize the colors of the widget to match your branding.

Show child attributes

theme.shapes

enum<string>

This field determines the overall shape style of UI components in the SaleSnip widget.

Available options:

ROUNDED,

PILL,

RECTANGULAR

Example:

"ROUNDED"

theme.light

object

The colors of the SaleSnip widget in light mode.

Show child attributes

theme.light.overview

object

Show child attributes

theme.light.overview.background

string

A hex color code.

Example:

"#4043ff"

theme.light.overview.foreground

string

A hex color code.

Example:

"#4043ff"

theme.light.chat

object

Show child attributes

theme.light.chat.background

string

A hex color code.

Example:

"#4043ff"

theme.light.chat.foreground

string

A hex color code.

Example:

"#4043ff"

theme.light.primary

object

Show child attributes

theme.light.primary.background

string

A hex color code.

Example:

"#4043ff"

theme.light.primary.foreground

string

A hex color code.

Example:

"#4043ff"

theme.light.input

object

Show child attributes

theme.light.input.background

string

A hex color code.

Example:

"#4043ff"

theme.light.input.foreground

string

A hex color code.

Example:

"#4043ff"

theme.light.message

object

Show child attributes

theme.light.message.user

object

Show child attributes

theme.light.message.user.background

string

A hex color code.

Example:

"#4043ff"

theme.light.message.user.foreground

string

A hex color code.

Example:

"#4043ff"

theme.light.message.bot

object

Show child attributes

theme.light.message.bot.background

string

A hex color code.

Example:

"#4043ff"

theme.light.message.bot.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark

object

The colors of the SaleSnip widget in dark mode.

Show child attributes

theme.dark.overview

object

Show child attributes

theme.dark.overview.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.overview.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark.chat

object

Show child attributes

theme.dark.chat.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.chat.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark.primary

object

Show child attributes

theme.dark.primary.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.primary.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark.input

object

Show child attributes

theme.dark.input.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.input.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark.message

object

Show child attributes

theme.dark.message.user

object

Show child attributes

theme.dark.message.user.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.message.user.foreground

string

A hex color code.

Example:

"#4043ff"

theme.dark.message.bot

object

Show child attributes

theme.dark.message.bot.background

string

A hex color code.

Example:

"#4043ff"

theme.dark.message.bot.foreground

string

A hex color code.

Example:

"#4043ff"

Response

Created

string

required

The unique ID of the project.

Minimum string length: 1

Example:

"project_abcdefghjijklmnop"

Get a single project

⌘I

Projects

Sessions

Plugins

Create a new project

Authorizations

Body

Response