---
title: "Generate connection note"
method: POST
path: "/v1/agents/generateConnectionNote"
tags: ["agents"]
---

# Generate connection note

`POST /v1/agents/generateConnectionNote`

## Request

- Base URL: `https://api.zevari.ai`
- URL: `https://api.zevari.ai/v1/agents/generateConnectionNote`
- Auth: HTTP bearer

Transport: call this endpoint with HTTP POST and a JSON request body. Generate a personalized LinkedIn connection request note based on the prospect's profile and your business context. Max length depends on sender tier: 200 chars for free accounts, 300 for paid. Before using this for real outreach, call library_context_get(skill_slug='craft-outreach', include_examples=true) and apply the returned Outreach template plus Brand context. Generated connection notes are capped by the active sender tier: 200 characters for free LinkedIn senders and 300 for paid/Premium/Sales Navigator senders. For API automation, include sender_name, sender_company, and product_offering unless those values are already saved on the Zevari profile. If any are missing, the response data includes error='missing_required_fields' and missing_fields.

## Request body

- object
  - `identifier` string, required: LinkedIn public identifier or provider ID
  - `sender_name` string: Your name. Required unless the active Zevari profile has full_name saved.
  - `sender_company` string: Your company. Required unless the active Zevari profile has company_name saved.
  - `product_offering` string: What you sell. Required unless the active Zevari profile has product_offering saved.
  - `language` string: Language for the note
  - `template_slug` string: Outreach template slug (e.g. 'hook-starter-active'). Prefer the primary_outreach_templates value returned by library_context_get. Falls back to the built-in connection-note instructions when omitted.
  - `template_variant` string: Variant within the template's framework (e.g. 'active' or 'inactive' for hook-starter). Ignored when the slug already encodes the variant.
  - `custom_prompt` string: One-shot prompt override. Replaces the template prompt for this call only.

## Response `200`

Successful Zevari API response.

- ZevariResponseEnvelope
  - `ok` boolean, required: False when the underlying tool reports an error or a partial failure.
  - `method` string, required: Public API method name.
  - `data` unknown, required
  - `request_id` string, required: Request correlation ID. Also returned in X-Zevari-Request-Id.

## Other responses

- `400`: Invalid arguments or method execution error.
- `401`: Missing, invalid, expired, revoked, or unauthorized API key.
- `404`: Unknown or non-public Zevari API method.
- `429`: API key rate limit exceeded.
- `500`: Unhandled server error.

---

[API](https://skmtc.dev/zevari/apis/zevari-public-api.md) · [All operations](https://skmtc.dev/zevari/apis/zevari-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zevari/apis/zevari-public-api/revisions/a0bc3afac227?raw)