> ## Documentation Index
> Fetch the complete documentation index at: https://bavlio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Plan a sequence's A/B tests

> Returns the A/B tests the given steps would start, without saving them: for each test the kind of change it tests, what each path changes, where leads start counting, and per goal the leads each path needs and the weeks that takes at the campaign's pace, with the rates and weekly pace the plan used. Send the steps as you would save them: a test the steps keep comes back with its test_id, one they add with test_id null. Nothing is saved.

## OpenAPI

```json
{
  "openapi": "3.2.0",
  "info": {
    "title": "Bavlio API",
    "version": "1.0.0"
  },
  "paths": {
    "/campaigns/{id}/sequence/ab-test-plans": {
      "post": {
        "tags": [
          "Sequences"
        ],
        "operationId": "sequences.planAbTests",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string",
              "description": "Campaign id."
            },
            "required": true
          }
        ],
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "numbers": {
                      "type": "object",
                      "properties": {
                        "source": {
                          "type": "string",
                          "enum": [
                            "campaign",
                            "bavlio",
                            "benchmark"
                          ],
                          "description": "Where the numbers come from: this campaign, all of Bavlio, or benchmarks when neither has enough data."
                        },
                        "leads_per_week": {
                          "anyOf": [
                            {
                              "type": "number"
                            },
                            {
                              "type": "string",
                              "enum": [
                                "Infinity",
                                "-Infinity",
                                "NaN"
                              ]
                            }
                          ]
                        },
                        "acceptance": {
                          "anyOf": [
                            {
                              "type": "number"
                            },
                            {
                              "type": "string",
                              "enum": [
                                "Infinity",
                                "-Infinity",
                                "NaN"
                              ]
                            }
                          ]
                        },
                        "rates": {
                          "type": "object",
                          "properties": {
                            "replied": {
                              "anyOf": [
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "Infinity",
                                    "-Infinity",
                                    "NaN"
                                  ]
                                }
                              ]
                            },
                            "positive_reply": {
                              "anyOf": [
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "Infinity",
                                    "-Infinity",
                                    "NaN"
                                  ]
                                }
                              ]
                            },
                            "meeting": {
                              "anyOf": [
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "Infinity",
                                    "-Infinity",
                                    "NaN"
                                  ]
                                }
                              ]
                            }
                          },
                          "required": [
                            "replied",
                            "positive_reply",
                            "meeting"
                          ],
                          "additionalProperties": false,
                          "description": "Share of leads who reach each goal."
                        }
                      },
                      "required": [
                        "source",
                        "leads_per_week",
                        "acceptance",
                        "rates"
                      ],
                      "additionalProperties": false,
                      "description": "The rates and pace A/B test plans are made from."
                    },
                    "plans": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "test_id": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Bavlio's id of the A/B test; null for a test the steps add. Plans follow the order of the tests in the steps."
                          },
                          "kind": {
                            "type": "string",
                            "enum": [
                              "shape",
                              "message",
                              "wording",
                              "timing"
                            ],
                            "description": "What the paths change: shape, message, wording or timing."
                          },
                          "expected_lift": {
                            "anyOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string",
                                "enum": [
                                  "Infinity",
                                  "-Infinity",
                                  "NaN"
                                ]
                              }
                            ]
                          },
                          "counts_from": {
                            "type": "string",
                            "enum": [
                              "invite",
                              "message",
                              "email"
                            ],
                            "description": "The first touch the paths send, where each lead's clock starts."
                          },
                          "changes": {
                            "type": "array",
                            "items": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "invite_note"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "enum": [
                                              "with_note",
                                              "without_note",
                                              "no_invite"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "follow_ups"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "integer",
                                            "minimum": 0,
                                            "maximum": 9007199254740991
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "emails"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "integer",
                                            "minimum": 0,
                                            "maximum": 9007199254740991
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "first_channel"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "enum": [
                                              "linkedin",
                                              "email",
                                              "none"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "wait_days"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "integer",
                                            "minimum": 0,
                                            "maximum": 9007199254740991
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "dimension": {
                                      "type": "string",
                                      "enum": [
                                        "writer"
                                      ]
                                    },
                                    "values": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "path": {
                                            "type": "string",
                                            "enum": [
                                              "a",
                                              "b",
                                              "c",
                                              "d"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "enum": [
                                              "template",
                                              "ai",
                                              "mixed",
                                              "none"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "path",
                                          "value"
                                        ],
                                        "additionalProperties": false
                                      },
                                      "description": "The value on each path."
                                    }
                                  },
                                  "required": [
                                    "dimension",
                                    "values"
                                  ],
                                  "additionalProperties": false
                                }
                              ],
                              "description": "One thing the paths change: invite_note, follow_ups, emails, first_channel, wait_days or writer (template or AI)."
                            }
                          },
                          "goals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "goal": {
                                  "type": "string",
                                  "enum": [
                                    "replied",
                                    "positive_reply",
                                    "meeting"
                                  ]
                                },
                                "rate": {
                                  "anyOf": [
                                    {
                                      "type": "number"
                                    },
                                    {
                                      "type": "string",
                                      "enum": [
                                        "Infinity",
                                        "-Infinity",
                                        "NaN"
                                      ]
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "The goal's usual rate; null when unknown."
                                },
                                "people_per_path": {
                                  "anyOf": [
                                    {
                                      "type": "integer",
                                      "minimum": 0,
                                      "maximum": 9007199254740991
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "Leads each path needs to show the usual change; null when unknown."
                                },
                                "weeks": {
                                  "anyOf": [
                                    {
                                      "type": "integer",
                                      "minimum": 0,
                                      "maximum": 9007199254740991
                                    },
                                    {
                                      "type": "null"
                                    }
                                  ],
                                  "description": "Weeks that takes at the campaign's pace; null past 26 weeks or when unknown."
                                }
                              },
                              "required": [
                                "goal",
                                "rate",
                                "people_per_path",
                                "weeks"
                              ],
                              "additionalProperties": false,
                              "description": "How long the test would take with this goal."
                            }
                          },
                          "recommended": {
                            "type": "string",
                            "enum": [
                              "replied",
                              "positive_reply",
                              "meeting"
                            ],
                            "description": "The goal that gives an answer soonest without settling for less."
                          }
                        },
                        "required": [
                          "test_id",
                          "kind",
                          "expected_lift",
                          "counts_from",
                          "changes",
                          "goals",
                          "recommended"
                        ],
                        "additionalProperties": false,
                        "description": "The plan for one A/B test."
                      }
                    }
                  },
                  "required": [
                    "numbers",
                    "plans"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "400": {
            "description": "SequenceInvalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SequenceInvalidEncoded"
                }
              }
            }
          },
          "401": {
            "description": "AuthMissing | AuthInvalid",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/AuthMissingEncoded"
                    },
                    {
                      "$ref": "#/components/schemas/AuthInvalidEncoded"
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "description": "CampaignNotFound | WorkspaceNotFound",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/CampaignNotFoundEncoded"
                    },
                    {
                      "$ref": "#/components/schemas/WorkspaceNotFoundEncoded"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "Returns the A/B tests the given steps would start, without saving them: for each test the kind of change it tests, what each path changes, where leads start counting, and per goal the leads each path needs and the weeks that takes at the campaign's pace, with the rates and weekly pace the plan used. Send the steps as you would save them: a test the steps keep comes back with its test_id, one they add with test_id null. Nothing is saved.",
        "summary": "Plan a sequence's A/B tests",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "steps": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Union_1"
                    },
                    "description": "The steps, in the order they run."
                  }
                },
                "required": [
                  "steps"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": true
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AuthInvalidEncoded": {
        "type": "object",
        "properties": {
          "_tag": {
            "type": "string",
            "enum": [
              "AuthInvalid"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              401
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "auth_invalid"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Bearer credential rejected"
            ]
          }
        },
        "required": [
          "_tag",
          "statusCode",
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "AuthMissingEncoded": {
        "type": "object",
        "properties": {
          "_tag": {
            "type": "string",
            "enum": [
              "AuthMissing"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              401
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "auth_missing"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Bearer credential required"
            ]
          }
        },
        "required": [
          "_tag",
          "statusCode",
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "WorkspaceNotFoundEncoded": {
        "type": "object",
        "properties": {
          "_tag": {
            "type": "string",
            "enum": [
              "WorkspaceNotFound"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              404
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "workspace_not_found"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "No such workspace for this account: save a company profile or pick a workspace you belong to"
            ]
          }
        },
        "required": [
          "_tag",
          "statusCode",
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "SequenceInvalidEncoded": {
        "type": "object",
        "properties": {
          "_tag": {
            "type": "string",
            "enum": [
              "SequenceInvalid"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              400
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "sequence_invalid"
            ]
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "_tag",
          "statusCode",
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "CampaignNotFoundEncoded": {
        "type": "object",
        "properties": {
          "_tag": {
            "type": "string",
            "enum": [
              "CampaignNotFound"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              404
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "campaign_not_found"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "No campaign with this id belongs to the workspace"
            ]
          }
        },
        "required": [
          "_tag",
          "statusCode",
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "Union_1": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "visit_profile"
                ]
              }
            },
            "required": [
              "id",
              "kind"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "like_post"
                ]
              }
            },
            "required": [
              "id",
              "kind"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "invite"
                ]
              },
              "note": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200,
                    "description": "Invite note; no links or {@booking_link}. Braces mark what is filled in per lead. Inside braces, an @ names a lead's value: @first_name, @company, @title, @moment, @booking_link, @lead_id, or a custom field from a file uploaded to the campaign, like @city. Options split by | are tried in order and the first whose @ values the lead has is used, like {@first_name|there} or {@age year olds|Gen Z}; an option without an @ is plain text. Braces with a custom field end with an option without one, because leads Bavlio finds have no custom fields. Braces without an @ hold choices, one picked per lead, like {Hi|Hello|Hey}. Everything else is sent as written, an @ outside braces included."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "any_time": {
                "type": "boolean",
                "description": "true sends as soon as the step is due, outside the working days and hours too; the daily limits still apply. Left out, false: the step waits for the working hours."
              }
            },
            "required": [
              "id",
              "kind",
              "note"
            ],
            "additionalProperties": false,
            "description": "Send a LinkedIn invite, with the note or, when null, without."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "message"
                ]
              },
              "mode": {
                "type": "string",
                "enum": [
                  "template"
                ]
              },
              "template": {
                "type": "object",
                "properties": {
                  "body": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1900,
                    "description": "LinkedIn message. Braces mark what is filled in per lead. Inside braces, an @ names a lead's value: @first_name, @company, @title, @moment, @booking_link, @lead_id, or a custom field from a file uploaded to the campaign, like @city. Options split by | are tried in order and the first whose @ values the lead has is used, like {@first_name|there} or {@age year olds|Gen Z}; an option without an @ is plain text. Braces with a custom field end with an option without one, because leads Bavlio finds have no custom fields. Braces without an @ hold choices, one picked per lead, like {Hi|Hello|Hey}. Everything else is sent as written, an @ outside braces included."
                  }
                },
                "required": [
                  "body"
                ],
                "additionalProperties": false
              },
              "any_time": {
                "type": "boolean",
                "description": "true sends as soon as the step is due, outside the working days and hours too; the daily limits still apply. Left out, false: the step waits for the working hours."
              }
            },
            "required": [
              "id",
              "kind",
              "mode",
              "template"
            ],
            "additionalProperties": false,
            "description": "Send a LinkedIn message filled in from the template."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "message"
                ]
              },
              "mode": {
                "type": "string",
                "enum": [
                  "ai"
                ]
              },
              "ai": {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1000,
                    "description": "Instructions the AI writes the text from, for each lead."
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": false
              },
              "any_time": {
                "type": "boolean",
                "description": "true sends as soon as the step is due, outside the working days and hours too; the daily limits still apply. Left out, false: the step waits for the working hours."
              }
            },
            "required": [
              "id",
              "kind",
              "mode",
              "ai"
            ],
            "additionalProperties": false,
            "description": "Send a LinkedIn message the AI writes from the brief."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "email"
                ]
              },
              "subject": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 150,
                    "description": "Email subject. Braces mark what is filled in per lead. Inside braces, an @ names a lead's value: @first_name, @company, @title, @moment, @booking_link, @lead_id, or a custom field from a file uploaded to the campaign, like @city. Options split by | are tried in order and the first whose @ values the lead has is used, like {@first_name|there} or {@age year olds|Gen Z}; an option without an @ is plain text. Braces with a custom field end with an option without one, because leads Bavlio finds have no custom fields. Braces without an @ hold choices, one picked per lead, like {Hi|Hello|Hey}. Everything else is sent as written, an @ outside braces included."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Subject; null replies in the thread of the lead's earlier email."
              },
              "mode": {
                "type": "string",
                "enum": [
                  "template"
                ]
              },
              "template": {
                "type": "object",
                "properties": {
                  "body": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 5000,
                    "description": "Email body. Braces mark what is filled in per lead. Inside braces, an @ names a lead's value: @first_name, @company, @title, @moment, @booking_link, @lead_id, or a custom field from a file uploaded to the campaign, like @city. Options split by | are tried in order and the first whose @ values the lead has is used, like {@first_name|there} or {@age year olds|Gen Z}; an option without an @ is plain text. Braces with a custom field end with an option without one, because leads Bavlio finds have no custom fields. Braces without an @ hold choices, one picked per lead, like {Hi|Hello|Hey}. Everything else is sent as written, an @ outside braces included."
                  }
                },
                "required": [
                  "body"
                ],
                "additionalProperties": false
              },
              "any_time": {
                "type": "boolean",
                "description": "true sends as soon as the step is due, outside the working days and hours too; the daily limits still apply. Left out, false: the step waits for the working hours."
              }
            },
            "required": [
              "id",
              "kind",
              "subject",
              "mode",
              "template"
            ],
            "additionalProperties": false,
            "description": "Send an email filled in from the template."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "email"
                ]
              },
              "subject": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 150,
                    "description": "Email subject. Braces mark what is filled in per lead. Inside braces, an @ names a lead's value: @first_name, @company, @title, @moment, @booking_link, @lead_id, or a custom field from a file uploaded to the campaign, like @city. Options split by | are tried in order and the first whose @ values the lead has is used, like {@first_name|there} or {@age year olds|Gen Z}; an option without an @ is plain text. Braces with a custom field end with an option without one, because leads Bavlio finds have no custom fields. Braces without an @ hold choices, one picked per lead, like {Hi|Hello|Hey}. Everything else is sent as written, an @ outside braces included."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Subject; null replies in the thread of the lead's earlier email."
              },
              "mode": {
                "type": "string",
                "enum": [
                  "ai"
                ]
              },
              "ai": {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1000,
                    "description": "Instructions the AI writes the text from, for each lead."
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": false
              },
              "any_time": {
                "type": "boolean",
                "description": "true sends as soon as the step is due, outside the working days and hours too; the daily limits still apply. Left out, false: the step waits for the working hours."
              }
            },
            "required": [
              "id",
              "kind",
              "subject",
              "mode",
              "ai"
            ],
            "additionalProperties": false,
            "description": "Send an email the AI writes from the brief."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "wait"
                ]
              },
              "days": {
                "type": "integer",
                "minimum": 1,
                "maximum": 30,
                "description": "Working days before the next step."
              }
            },
            "required": [
              "id",
              "kind",
              "days"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "wait"
                ]
              },
              "minutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 1439,
                "description": "Minutes on the clock before the next step, which runs then or in the next sending hours."
              }
            },
            "required": [
              "id",
              "kind",
              "minutes"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Unique step id; leads stay on a step whose id a new version keeps."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "branch"
                ]
              },
              "condition": {
                "type": "string",
                "enum": [
                  "invite_accepted",
                  "replied"
                ]
              },
              "within_days": {
                "type": "integer",
                "minimum": 1,
                "maximum": 30,
                "description": "Days to wait for the condition before taking no; yes is taken as soon as it is met."
              },
              "yes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Union_1"
                },
                "description": "Steps once the condition is met."
              },
              "no": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Union_1"
                },
                "description": "Steps when it is not met in time."
              }
            },
            "required": [
              "id",
              "kind",
              "condition",
              "within_days",
              "yes",
              "no"
            ],
            "additionalProperties": false,
            "description": "Wait for the condition, then take the yes or no steps."
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "description": "Bavlio's id of this A/B test, as the sequence you read has it. Leave it out of a new test: Bavlio gives it one."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "ab_test"
                ]
              },
              "goal": {
                "type": "string",
                "enum": [
                  "replied",
                  "positive_reply",
                  "meeting"
                ],
                "description": "What counts as a win: replied, positive_reply or meeting."
              },
              "paths": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "steps": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Union_1"
                      },
                      "description": "Steps on this path; the paths must differ."
                    }
                  },
                  "required": [
                    "steps"
                  ],
                  "additionalProperties": false
                },
                "description": "The paths, 2 to 4. Bavlio letters them a, b, c and d in this order.",
                "minItems": 2,
                "maxItems": 4
              }
            },
            "required": [
              "kind",
              "goal",
              "paths"
            ],
            "additionalProperties": false,
            "description": "Send each lead who reaches this step down one path, then on to the steps after it. Bavlio shares leads between the paths, stops a path that does harm and keeps the winner."
          }
        ],
        "description": "One step. visit_profile visits the lead's LinkedIn profile, like_post likes their latest post, wait pauses for the working days or the minutes given."
      }
    },
    "securitySchemes": {
      "bearer": {
        "description": "Send `Authorization: Bearer <token>`. The token is an API key, which starts with `bav_` and comes from creating an API key or starting a registration, or the access token of a Bavlio sign-in.",
        "type": "http",
        "scheme": "Bearer"
      }
    }
  },
  "security": [],
  "tags": [
    {
      "name": "Registration",
      "description": "Open a Bavlio account without signing in. Starting a registration returns an API key for a new ephemeral account, which becomes permanent once its email address is verified."
    },
    {
      "name": "Authentication",
      "description": "Identify the calling account, finish a registration and manage the account's API keys."
    },
    {
      "name": "Account",
      "description": "The account behind your sign-in, and deleting it."
    },
    {
      "name": "Workspaces",
      "description": "A workspace holds the company profile, outreach schedule, team, campaigns and billing Bavlio works with. Calls that act in a workspace use the one whose id is in the bavlio-workspace header, or the account's default workspace when the header is absent."
    },
    {
      "name": "Teams",
      "description": "Manage who belongs to a workspace: its members, their roles and the invitations to join it. Each workspace's plan sets how many team seats it has."
    },
    {
      "name": "Campaigns",
      "description": "A campaign finds leads that match an ideal customer profile (ICP) and buying signals, and reaches out to them through its sequence of LinkedIn and email steps."
    },
    {
      "name": "Companies",
      "description": "Companies on LinkedIn, to pick as the competitors whose engaged audience a campaign watches."
    },
    {
      "name": "Do not contact",
      "description": "Companies and people the workspace's campaigns never reach, such as existing customers and partners. Every campaign checks the list before it adds a lead and before every step it sends."
    },
    {
      "name": "Lead imports",
      "description": "Bring your own leads: preview a CSV, confirm which column holds what, then import it into a campaign, where the leads go through the same sequence as the ones Bavlio finds."
    },
    {
      "name": "Sequences",
      "description": "A campaign's sequence is the steps Bavlio runs for each lead: profile visits, likes, invites, LinkedIn messages, emails, waits, conditions and A/B tests. Every message and email waits in the review queue for approval before it is sent."
    },
    {
      "name": "Inbox",
      "description": "Conversations with the people your campaigns reached and, for accounts that opt in, your other LinkedIn and email conversations: read them, reply to them and follow changes live."
    },
    {
      "name": "Reviews",
      "description": "Messages and emails go to a lead only after someone approves them. The review queue holds the replies Bavlio drafted for people who answered and the messages and emails it drafted for campaign sequences."
    },
    {
      "name": "Billing",
      "description": "The plans and add-ons on offer and the workspace's subscription and usage. Plan changes, add-ons, top-ups, cancellation and the billing portal need the workspace owner or an admin."
    },
    {
      "name": "LinkedIn",
      "description": "Connect the LinkedIn accounts your campaigns send from, confirm their sign-ins, choose the country LinkedIn sees them from, and disconnect them."
    },
    {
      "name": "Meetings",
      "description": "Meetings booked through the workspace's calendar tool (Google Calendar, Calendly or Cal.com), and the calendar connection that imports them."
    },
    {
      "name": "Email",
      "description": "Connect a Bavimail account, add sending domains and tracking domains, and create the inboxes campaigns send email from."
    },
    {
      "name": "Locations",
      "description": "Places to aim a campaign at, from a continent down to a city. Country, state and city names come from the Countries States Cities Database (https://github.com/dr5hn/countries-states-cities-database), made available under the Open Database License (ODbL) 1.0; continents from countries-list."
    }
  ],
  "servers": [
    {
      "url": "https://api.bavlio.com"
    }
  ]
}
```
