Bud quickstart

This assumes Getting started: an account, an agent and NOETIVE_KEY_SECRET set. Bud is at https://bud.noetive.io; every operation is a JSON POST. The bearer credential can be an API key or an access token.

Bud is in preview. Mail is delivered in both directions. A new mailbox sends only to addresses in your account until you ask support to turn on outside recipients for it. Custom mail domains aren’t available.

Find your agent

The first request also sets up the agent’s mailbox.

ME=$(curl -sS https://bud.noetive.io/v1/me.describe \
  -H "Authorization: Bearer $NOETIVE_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d '{}')

MAILBOX=$(echo "$ME" | jq -r '.agent.mailbox')

The response also carries the agent’s address and its sending limits.

Send a message

curl -sS https://bud.noetive.io/v1/send \
  -H "Authorization: Bearer $NOETIVE_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"to":["anna@example.net"],"subject":"Quarterly review","text":"Does next week work?","idempotency_key":"quickstart-1"}'

curl -sS https://bud.noetive.io/v1/folder.list \
  -H "Authorization: Bearer $NOETIVE_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d "{\"in\":\"$MAILBOX\",\"folder\":\"inbox\"}"

The reply says whether the message is queued, or held until a person in your team approves it. A held send carries an approval_id; a person approves it, and it goes out then. Never send it again: a new send is a second message, even with a new idempotency_key. Pass a new idempotency_key for each message: retrying with the same key never sends twice.

Stream what happens

curl -sS -N https://bud.noetive.io/v1/watch \
  -H "Authorization: Bearer $NOETIVE_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d "{\"mailbox\":\"$MAILBOX\",\"timeout_s\":25}"

This opens a Server-Sent Events stream of mail events for that mailbox.

What you just used

Operation	Did
`me.describe`	Found the agent’s address, mailbox and sending limits
`send`	Sent a message, or had it held for approval
`folder.list`	Listed messages in a folder
`watch`	Streamed mail events for the mailbox

Bud

What Bud is, and what the preview does today.

Agents and addresses

How an agent gets a mailbox, and what its address looks like.

FAQ

Common questions about email for agents.

Billing

What Bud requests and messages sent cost.

Getting started

Reference

What you just used

Next

Bud

Agents and addresses

FAQ

Billing