Preview AI Agent Instructions

Request

Generate instructions without creating an agent. agent_name, agent_role, business_type, business_name, and business_description are required, with the matching custom field when a role or business type is other. greeting is optional; voice and instructions are ignored.

Security

HTTP_BASIC

Bodyapplication/jsonrequired

One of:

Details used to generate an instruction preview. agent_name, agent_role, business_type, business_name, and business_description are required; greeting is optional, while voice and instructions are ignored.

agent_namestring, non-emptyrequired

Friendly agent name; required for an instruction preview.

Example:"Reception AI"

agent_rolestringrequired

Role key returned by List Agent Options. Required when instructions are generated.

Enum:"receptionist""support""sales""info""other"

Example:"receptionist"

custom_agent_rolestring or null

Required when agent_role is other.

Example:"After hours receptionist"

business_typestringrequired

Business type key returned by List Agent Options. Required when instructions are generated.

Enum:"professional""healthcare""realestate""legal""home""retail""restaurant""technology""education""automotive"

Example:"realestate"

Value:"other"

custom_business_typestring, non-emptyrequired

Required when business_type is other.

Example:"Boat dealership"

business_namestring, non-emptyrequired

Business name used by the agent. Required when instructions are generated.

Example:"Example Realty"

business_descriptionstring, non-emptyrequired

Short business description; required for an instruction preview.

Example:"Real estate agency based in Sydney"

contact_emailstring or null, (email)

Business contact email; must be a valid email address when provided.

Example:"reception@example.tld"

greetingstring or null

Optional greeting style key returned by List Agent Options.

Enum:"formal""friendly""brief""warm"null

Example:"warm"

curl -i -X POST \
  -u '<username>:<password>' \
  https://tapi.avanser.com/v1/aiagents/preview-instruction \
  -H 'Content-Type: application/json' \
  -d '{
    "agent_name": "Reception AI",
    "agent_role": "receptionist",
    "business_type": "realestate",
    "business_name": "Example Realty",
    "business_description": "Real estate agency based in Sydney",
    "contact_email": "reception@example.tld",
    "greeting": "warm"
  }'

Responses

Successful response

Bodyapplication/json

@transactionobject

responseobject

Response

{
  "@transaction": {
    "id": "c9220015e2f48bc7cf4b38186a7b2025",
    "account-id": "1234",
    "request": { … }
  },
  "response": {
    "message": "Success",
    "code": 200,
    "instructions": "### Role and Responsibilities\n- Answer callers as a reception assistant.\n- Help with appointments and general questions."
  }
}