KosmoKrator

marketing

Brevo CLI for AI Agents

Use the Brevo CLI from KosmoKrator to call Brevo tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 5 read 2 write API key auth

Brevo CLI Setup

Brevo can be configured headlessly with `kosmokrator integrations:configure brevo`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure brevo --set api_key="$BREVO_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor brevo --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
api_key BREVO_API_KEY Secret secret yes API Key

Call Brevo Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call brevo.brevo_list_contacts '{
  "limit": 1,
  "offset": 1,
  "search": "example_search"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:brevo brevo_list_contacts '{
  "limit": 1,
  "offset": 1,
  "search": "example_search"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs brevo --json
kosmo integrations:docs brevo.brevo_list_contacts --json
kosmo integrations:schema brevo.brevo_list_contacts --json
kosmo integrations:search "Brevo" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Brevo.

brevo.brevo_list_contacts

Read read

List contacts in your Brevo account. Supports pagination and filtering by email or search term.

Parameters
limit, offset, search

Generic CLI call

kosmo integrations:call brevo.brevo_list_contacts '{"limit":1,"offset":1,"search":"example_search"}' --json

Provider shortcut

kosmo integrations:brevo brevo_list_contacts '{"limit":1,"offset":1,"search":"example_search"}' --json

brevo.brevo_get_contact

Read read

Get details of a specific contact in Brevo by their email address. Returns contact attributes, list memberships, and creation date.

Parameters
email

Generic CLI call

kosmo integrations:call brevo.brevo_get_contact '{"email":"example_email"}' --json

Provider shortcut

kosmo integrations:brevo brevo_get_contact '{"email":"example_email"}' --json

brevo.brevo_create_contact

Write write

Create a new contact in Brevo. You can set attributes like first name and last name, and add the contact to one or more lists.

Parameters
email, attributes, listIds

Generic CLI call

kosmo integrations:call brevo.brevo_create_contact '{"email":"example_email","attributes":"example_attributes","listIds":"example_listIds"}' --json

Provider shortcut

kosmo integrations:brevo brevo_create_contact '{"email":"example_email","attributes":"example_attributes","listIds":"example_listIds"}' --json

brevo.brevo_list_lists

Read read

List all contact lists in your Brevo account. Supports pagination with limit and offset.

Parameters
limit, offset

Generic CLI call

kosmo integrations:call brevo.brevo_list_lists '{"limit":1,"offset":1}' --json

Provider shortcut

kosmo integrations:brevo brevo_list_lists '{"limit":1,"offset":1}' --json

brevo.brevo_get_list

Read read

Get details of a specific contact list in Brevo by its ID. Returns the list name, total subscribers, and other metadata.

Parameters
id

Generic CLI call

kosmo integrations:call brevo.brevo_get_list '{"id":1}' --json

Provider shortcut

kosmo integrations:brevo brevo_get_list '{"id":1}' --json

brevo.brevo_send_email

Write write

Send a transactional email via Brevo. Specify sender, recipients, subject, and HTML or text content.

Parameters
sender, to, subject, htmlContent, textContent

Generic CLI call

kosmo integrations:call brevo.brevo_send_email '{"sender":"example_sender","to":"example_to","subject":"example_subject","htmlContent":"example_htmlContent","textContent":"example_textContent"}' --json

Provider shortcut

kosmo integrations:brevo brevo_send_email '{"sender":"example_sender","to":"example_to","subject":"example_subject","htmlContent":"example_htmlContent","textContent":"example_textContent"}' --json

brevo.brevo_get_account

Read read

Get information about the connected Brevo account, including email, plan details, and account statistics.

Parameters
none

Generic CLI call

kosmo integrations:call brevo.brevo_get_account '{}' --json

Provider shortcut

kosmo integrations:brevo brevo_get_account '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

brevo.brevo_list_contacts

List contacts in your Brevo account. Supports pagination and filtering by email or search term.

Operation
Read read
Schema command
kosmo integrations:schema brevo.brevo_list_contacts --json
ParameterTypeRequiredDescription
limit integer no Maximum number of contacts to return (default: 50, max: 1000).
offset integer no Number of contacts to skip for pagination (default: 0).
search string no Search term to filter contacts by email or attributes (e.g., "[email protected]").

brevo.brevo_get_contact

Get details of a specific contact in Brevo by their email address. Returns contact attributes, list memberships, and creation date.

Operation
Read read
Schema command
kosmo integrations:schema brevo.brevo_get_contact --json
ParameterTypeRequiredDescription
email string yes The email address of the contact to retrieve (used as the contact identifier in Brevo).

brevo.brevo_create_contact

Create a new contact in Brevo. You can set attributes like first name and last name, and add the contact to one or more lists.

Operation
Write write
Schema command
kosmo integrations:schema brevo.brevo_create_contact --json
ParameterTypeRequiredDescription
email string yes The email address for the new contact.
attributes object no Contact attributes such as {"FIRSTNAME": "John", "LASTNAME": "Doe"}. Keys must match attribute names in your Brevo account.
listIds array no Array of list IDs (integers) to add the contact to, e.g. [2, 5].

brevo.brevo_list_lists

List all contact lists in your Brevo account. Supports pagination with limit and offset.

Operation
Read read
Schema command
kosmo integrations:schema brevo.brevo_list_lists --json
ParameterTypeRequiredDescription
limit integer no Maximum number of lists to return (default: 50, max: 1000).
offset integer no Number of lists to skip for pagination (default: 0).

brevo.brevo_get_list

Get details of a specific contact list in Brevo by its ID. Returns the list name, total subscribers, and other metadata.

Operation
Read read
Schema command
kosmo integrations:schema brevo.brevo_get_list --json
ParameterTypeRequiredDescription
id integer yes The ID of the contact list to retrieve.

brevo.brevo_send_email

Send a transactional email via Brevo. Specify sender, recipients, subject, and HTML or text content.

Operation
Write write
Schema command
kosmo integrations:schema brevo.brevo_send_email --json
ParameterTypeRequiredDescription
sender object yes Sender details as an object with "name" and "email" keys, e.g. {"name": "My App", "email": "[email protected]"}.
to array yes Array of recipient objects, each with "email" and optionally "name", e.g. [{"email": "[email protected]", "name": "John"}].
subject string yes The email subject line.
htmlContent string no HTML body of the email. Required unless textContent is provided.
textContent string no Plain text body of the email. Required unless htmlContent is provided.

brevo.brevo_get_account

Get information about the connected Brevo account, including email, plan details, and account statistics.

Operation
Read read
Schema command
kosmo integrations:schema brevo.brevo_get_account --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.