agents

Generate connection note

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.

post/v1/agents/generateConnectionNote

Request

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

Request body

identifierstring required

LinkedIn public identifier or provider ID

sender_namestring

Your name. Required unless the active Zevari profile has full_name saved.

sender_companystring

Your company. Required unless the active Zevari profile has company_name saved.

product_offeringstring

What you sell. Required unless the active Zevari profile has product_offering saved.

languagestring

Language for the note

template_slugstring

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_variantstring

Variant within the template's framework (e.g. 'active' or 'inactive' for hook-starter). Ignored when the slug already encodes the variant.

custom_promptstring

One-shot prompt override. Replaces the template prompt for this call only.

Response

Successful Zevari API response.

okboolean required

False when the underlying tool reports an error or a partial failure.

methodstring required

Public API method name.

dataunknown required
request_idstring required

Request correlation ID. Also returned in X-Zevari-Request-Id.

Example response

{
  "method": "campaigns.delete"
}

Changes

No recorded changes to this operation across all 1 revision of this API.