Get the reply agent

GET/v1/campaigns/{campaign_id}/responder

Scope: campaigns:read

The campaign's reply agent, the AI Appointment Setter: whether it answers replies (is_enabled), where it sends an interested prospect (goal_link), the links it may share (assets), its tone and instructions. responder is null when the campaign has never been configured; create the configuration with Update the reply agent.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Response

200

campaign_idstring or null
messagestring or null
responderobject or null
Show 16 child attributesHide child attributes
- agent_namestring or null
- agent_versioninteger or null
  2 is the current agent. Configurations created through the API are always version 2.
- assetsarray of objects or null
  Links the agent may share, each with a link and a description of when to share it.
- campaign_descriptionstring or null
- campaign_idstring or null
- company_namestring or null
- custom_instructionsstring or null
- first_message_modestring or null
- goalstring or null
- goal_linkstring or null
  Where the agent sends an interested prospect, such as a booking page.
- idstring or null
- is_enabledboolean or null
  Whether the agent answers replies. Mirrors the campaign's responder_enabled.
- max_repliesinteger or null
- modestring or null
- tonestring or null
  friendly, direct or formal.
- updated_atstring · date-time or null
successboolean
Default true

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.