Platform WebSockets API 2.11.0

Accepts one of the following messages:

• #0New Convo StepconvoNewStep

  A new step either (1) authored by the user, sent to the server, or (2) authored by an LLM or another user, sent by the server.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-new-step"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "isAlternate": true,
      "shouldDeferResponse": true,
      "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
      "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
      "config": {
        "modelAlias": "claude-3-haiku",
        "provider": "anthropic"
      },
      "text": "string",
      "files": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
          "providerFileId": "string"
        }
      ],
      "annotations": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "createdByProvider": true,
      "errorAt": "2019-08-24T14:15:22Z",
      "partialOrder": 0
    },
    "_ws": {
      "funcName": "convo-new-step"
    }
  }
  

  This example has been generated automatically.

• #1New Convo Step GroupconvoNewStepGroup

  A new step group authored by the user, sent to the server. The server will respond with steps only, and those step objects will include a server-generated group ID.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepGroup

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  step

  Expand all

  allOf

  Consists of:

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  And with:

  any

  A convo step that will be used for all models defined in the group

  config

  Expand all

  object

  primary

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  alternate

  Expand all

  array<object>

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-new-step-group"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "step": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
        "isAlternate": true,
        "shouldDeferResponse": true,
        "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
        "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
        "config": {
          "modelAlias": "claude-3-haiku",
          "provider": "anthropic"
        },
        "text": "string",
        "files": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
            "providerFileId": "string"
          }
        ],
        "annotations": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
          }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
        "createdByProvider": true,
        "errorAt": "2019-08-24T14:15:22Z",
        "partialOrder": 0
      },
      "config": {
        "primary": {
          "modelAlias": "claude-3-haiku",
          "provider": "anthropic"
        },
        "alternate": [
          {
            "modelAlias": "claude-3-haiku",
            "provider": "anthropic"
          }
        ]
      }
    },
    "_ws": {
      "funcName": "convo-new-step-group"
    }
  }
  

  This example has been generated automatically.

• #2Delete Convo StepconvoStepDeletion

  A request to delete a step.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepDeletion

  stepId

  string

  format: uuid

  The ID of the step to delete

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-deletion"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d"
    },
    "_ws": {
      "funcName": "convo-step-deletion"
    }
  }
  

  This example has been generated automatically.

• #3Add Step to GroupconvoStepGroupAddition

  A request to add a step a step group; if a group doesn't exist, then a group will be automatically created. This is possible because the payload asks for the primary step ID, not the group ID. If a group was created, then a step update message will be sent from the server to indicate the new group ID.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepGroupAddition

  primaryStepId

  string

  format: uuid

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-group-addition"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "primaryStepId": "a8e6daf6-5f00-448b-a84c-d8c22c0543cc",
      "config": {
        "modelAlias": "claude-3-haiku",
        "provider": "anthropic"
      }
    },
    "_ws": {
      "funcName": "convo-step-group-addition"
    }
  }
  

  This example has been generated automatically.

• #4Regen Convo StepconvoStepRegen

  A request to regenerate ("regen") a step that has already either fully, successfully completed a run or has failed. A step regen is the equivalent of deleting and creating a new step, but where the new step will automatically retain the original (deleted) step's config.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepRegen

  May be used in a request to regen (regenerate) a step, whereby running a step takes place as if it had never taken place before. Mechanically, the original step (the one being regen) is deleted and a new step takes it place while retaining certain metadata from the original step, such as timestamp (which ensures the regen version of a step will not appear out of order in a convo)

  stepId

  string

  format: uuid

  The ID of the step that will be deleted and replaced during the regen operation

  newStep

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-regen"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
      "newStep": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
        "isAlternate": true,
        "shouldDeferResponse": true,
        "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
        "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
        "config": {
          "modelAlias": "claude-3-haiku",
          "provider": "anthropic"
        },
        "text": "string",
        "files": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
            "providerFileId": "string"
          }
        ],
        "annotations": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
          }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
        "createdByProvider": true,
        "errorAt": "2019-08-24T14:15:22Z",
        "partialOrder": 0
      }
    },
    "_ws": {
      "funcName": "convo-step-regen"
    }
  }
  

  This example has been generated automatically.

• #5Update Convo StepconvoStepUpdate

  A request to update any of the patchable properties of a step. See the payload schema for the properties that are supported. To leave a property unchanged, do not include it in the payload.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepUpdate

  May be used in a request to update any of the patchable properties of a step, or may be an update sent from the server to indicate a property has been updated

  stepId

  string

  format: uuid

  The step being updated

  convoId

  string

  format: uuid

  The convo ID, for reference only; set by the server only.

  groupId

  string

  format: uuid

  Defined by the server only; any value set by the client will be ignored. This value is only guaranteed to contain a value if the server just set a new group ID for the step. Otherwise, emptiness of this value shall not imply anything at all.

  isAlternate

  boolean

  Leave null to not cause change. By setting this to false, the step with ID stepId will become the primary and the isAlternate value for all other steps in the group (assuming there is one) will be set to true automatically, as there can only be one primary step in a group.

  Allowed values:
  • false
  • null

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-update"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
      "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "isAlternate": false
    },
    "_ws": {
      "funcName": "convo-step-update"
    }
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Errorerror

  A description of an error encountered by the server

  • application/json

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  error

  string

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "error"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "error": "string"
    },
    "_ws": {
      "funcName": "error"
    }
  }
  

  This example has been generated automatically.

• #1New Convo StepconvoNewStep

  A new step either (1) authored by the user, sent to the server, or (2) authored by an LLM or another user, sent by the server.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-new-step"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "isAlternate": true,
      "shouldDeferResponse": true,
      "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
      "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
      "config": {
        "modelAlias": "claude-3-haiku",
        "provider": "anthropic"
      },
      "text": "string",
      "files": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
          "providerFileId": "string"
        }
      ],
      "annotations": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "createdByProvider": true,
      "errorAt": "2019-08-24T14:15:22Z",
      "partialOrder": 0
    },
    "_ws": {
      "funcName": "convo-new-step"
    }
  }
  

  This example has been generated automatically.

• #2Convo StatusconvoStatus

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-status"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "isAlternate": true,
      "shouldDeferResponse": true,
      "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
      "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
      "config": {
        "modelAlias": "claude-3-haiku",
        "provider": "anthropic"
      },
      "text": "string",
      "files": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
          "providerFileId": "string"
        }
      ],
      "annotations": [
        {
          "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "createdByProvider": true,
      "errorAt": "2019-08-24T14:15:22Z",
      "partialOrder": 0
    },
    "_ws": {
      "funcName": "convo-status"
    }
  }
  

  This example has been generated automatically.

• #3Delete Convo StepconvoStepDeletion

  A request to delete a step.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepDeletion

  stepId

  string

  format: uuid

  The ID of the step to delete

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-deletion"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d"
    },
    "_ws": {
      "funcName": "convo-step-deletion"
    }
  }
  

  This example has been generated automatically.

• #4Regen Convo StepconvoStepRegen

  A request to regenerate ("regen") a step that has already either fully, successfully completed a run or has failed. A step regen is the equivalent of deleting and creating a new step, but where the new step will automatically retain the original (deleted) step's config.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepRegen

  May be used in a request to regen (regenerate) a step, whereby running a step takes place as if it had never taken place before. Mechanically, the original step (the one being regen) is deleted and a new step takes it place while retaining certain metadata from the original step, such as timestamp (which ensures the regen version of a step will not appear out of order in a convo)

  stepId

  string

  format: uuid

  The ID of the step that will be deleted and replaced during the regen operation

  newStep

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-regen"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
      "newStep": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
        "isAlternate": true,
        "shouldDeferResponse": true,
        "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
        "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
        "config": {
          "modelAlias": "claude-3-haiku",
          "provider": "anthropic"
        },
        "text": "string",
        "files": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
            "providerFileId": "string"
          }
        ],
        "annotations": [
          {
            "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
          }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
        "createdByProvider": true,
        "errorAt": "2019-08-24T14:15:22Z",
        "partialOrder": 0
      }
    },
    "_ws": {
      "funcName": "convo-step-regen"
    }
  }
  

  This example has been generated automatically.

• #5Update Convo StepconvoStepUpdate

  A request to update any of the patchable properties of a step. See the payload schema for the properties that are supported. To leave a property unchanged, do not include it in the payload.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: stepUpdate

  May be used in a request to update any of the patchable properties of a step, or may be an update sent from the server to indicate a property has been updated

  stepId

  string

  format: uuid

  The step being updated

  convoId

  string

  format: uuid

  The convo ID, for reference only; set by the server only.

  groupId

  string

  format: uuid

  Defined by the server only; any value set by the client will be ignored. This value is only guaranteed to contain a value if the server just set a new group ID for the step. Otherwise, emptiness of this value shall not imply anything at all.

  isAlternate

  boolean

  Leave null to not cause change. By setting this to false, the step with ID stepId will become the primary and the isAlternate value for all other steps in the group (assuming there is one) will be set to true automatically, as there can only be one primary step in a group.

  Allowed values:
  • false
  • null

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-update"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
      "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "isAlternate": false
    },
    "_ws": {
      "funcName": "convo-step-update"
    }
  }
  

  This example has been generated automatically.

• #6Update ConvoconvoUpdate

  Sent by the server to indicate that properties of the convo have changed. Primarily used when a convo name is auto-generated.

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  payload

  Expand all

  object

  uid: convoUpdate

  convo

  Expand all

  object

  uid: convo

  id

  string

  format: uuid

  name

  string

  createdAt

  string

  format: date-time

  createdBy

  string

  format: uuid

  latestStep

  Expand all

  object

  uid: step

  id

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored

  groupId

  string

  format: uuid

  Defined by the server; any value set by the client will be ignored. Only applies if step is part of a group.

  isAlternate

  boolean

  Only applies if step is part of a group. Specifies whether this step was designated as an alternate step. The primary/alternate step designations can be changed. Only one step per group can (and must) be primary.

  shouldDeferResponse

  boolean

  If set to true, the creator of the step is indicating that the AI should not respond specifically to this step, but rather should consider this step as soon as any non-deferred step is submitted at a later time. An example use case is the @kallo tag in multi-user convos in the Kallo UI.

  convoId

  required

  string

  format: uuid

  inferenceId

  string

  format: uuid

  Defined by the server; for diagnostic purposes only

  config

  Expand all

  object

  uid: stepConfig

  modelAlias

  string

  Allowed values:
  • "claude-3-haiku"
  • "claude-3-sonnet"
  • "claude-3-opus"
  • "claude-3.5-sonnet"
  • "gemini-1.0-pro"
  • "gemini-1.5-pro"
  • "gpt-3.5"
  • "gpt-4.0"
  • "gpt-4.0o"
  • "mistral-8x7b"
  • "mistral-medium"
  • "mistral-large"

  provider

  string

  Allowed values:
  • "anthropic"
  • "mistral"
  • "openai"
  • "google"

  Additional properties are allowed.

  text

  string

  files

  Expand all

  array<object>

  dataSourceId

  required

  string

  format: uuid

  providerFileId

  required

  string

  annotations

  Expand all

  required

  array<object>

  dataSourceId

  required

  string

  format: uuid

  createdAt

  required

  string

  format: date-time

  createdBy

  string

  format: uuid

  createdByProvider

  required

  boolean

  errorAt

  string

  format: date-time

  partialOrder

  number

  Any non-zero value indicates that the step content is not yet finished being generated. A higher number indicates newer content than a lower number. Only the server can set this to a non-zero value.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And with:

  Expand all

  object

  _ws

  Expand all

  object

  funcName

  string

  Allowed values:
  • "convo-step-update"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "payload": {
      "convo": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
        "latestStep": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
          "isAlternate": true,
          "shouldDeferResponse": true,
          "convoId": "ce76207c-af32-41c0-aa93-80b97e1f2c9f",
          "inferenceId": "b5e4b117-5f05-48de-98cd-3848592d29cf",
          "config": {
            "modelAlias": "claude-3-haiku",
            "provider": "anthropic"
          },
          "text": "string",
          "files": [
            {
              "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574",
              "providerFileId": "string"
            }
          ],
          "annotations": [
            {
              "dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
            }
          ],
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
          "createdByProvider": true,
          "errorAt": "2019-08-24T14:15:22Z",
          "partialOrder": 0
        }
      }
    },
    "_ws": {
      "funcName": "convo-step-update"
    }
  }
  

  This example has been generated automatically.