Create a bot group

/v1/bot-groups

Members must all be your own saved bots, without repeats.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Body

application/json

namestringrequired

1-40 letters, digits, "_", "." or "-"; unique per account

membersstring[]required

Your saved-bot ids

Minimum array length: 2 Maximum array length: 6

Response

Created

application/json

groupobject

Show child attributes

idstringrequired

namestringrequired

membersstring[]required

Saved-bot ids, 2 to 6

created_atinteger

Unix seconds

updated_atinteger

Unix seconds

invalid_json — body is not valid JSON or YAML; invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

name_taken — you already have a group with that name

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_name or invalid_members — the name is not 1-40 letters, digits, "_", "." or "-", or the members are not 2 to 6 distinct bots of yours

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_enabled — bot groups are not enabled yet (migration 0139 is pending)

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os
import requests

response = requests.post(
    "https://api.plungeai.com/v1/bot-groups",
    headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"},
    json={
        "name": "<string>",
        "members": [
            "<string>",
        ],
    },
)
if not response.ok:
    raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}")
print(response.json())

const response = await fetch('https://api.plungeai.com/v1/bot-groups', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "<string>",
    "members": [
      "<string>"
    ]
  }),
})
if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`)
console.log(await response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.plungeai.com/v1/bot-groups"))
            .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"members\":[\"<string>\"]}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse(""));
            return;
        }
        System.out.println(response.body());
    }
}

curl -X POST 'https://api.plungeai.com/v1/bot-groups' \
  -H "Authorization: Bearer $PLUNGE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"<string>","members":["<string>"]}'

Example generated from schema

{
  "group": {
    "id": "<string>",
    "name": "<string>",
    "members": [
      "<string>"
    ],
    "created_at": 0,
    "updated_at": 0
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Create a bot group

Authorizations

Body

Response

Planned: TI-33

Planned: TI-34