API Reference
  1. SkipCalls Public API
  2. agents

Create a new agent

post
https://be.skipcalls.com/agents

Creates a voice AI agent with the provided configuration. The agent won't receive calls until a phone number is assigned, but it can be tested immediately. Instructions are validated by an LLM and rejected if vague or off-topic. Subscription agent-count limits are enforced. Mobile users auto-get isVoiceMailAgent=true; avatar is auto-generated from name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
string
boolean
boolean
string
required
toolIds
array of strings
toolIds
string
enum
Defaults to gemini-3-flash-preview

Model to use for the agent

Allowed:
string

Voice to use for the agent

number
0 to 1
Defaults to 0.5

Voice pace from slow to fast. 0.5 is normal/provider default. Not all voice providers support speed control.

boolean
Defaults to false

Whether the agent has access to knowledge

string
enum
Defaults to NONE

Knowledge access mode for the agent

Allowed:
knowledgeAccessTags
array of strings
Defaults to []

Tags that the agent has access to (only used when knowledgeAccessMode is TAGS_ONLY)

knowledgeAccessTags
boolean
Defaults to true

Include the user's profile info (owner name, phone, address, DOB, company) in the agent prompt.

boolean
Defaults to true

Include business Q&A presets (hours, pricing, services) from /business-profile in the agent prompt

boolean
Defaults to false

Use per-agent receptionist profile fields in prompts instead of only the account profile

string

Prompt-facing represented person, practice, or business name

string

Prompt-facing represented company or business name

string

Prompt-facing represented company website

string

Prompt-facing represented company description

string

Prompt-facing represented company industry

string

Prompt-facing represented business street address

string

Prompt-facing represented business city

string

Prompt-facing represented business state

string

Prompt-facing represented business ZIP/postal code

string

Prompt-facing represented business timezone as an IANA timezone name

boolean
Defaults to false

Whether the agent allows call transfer

string

Number to transfer the call to

transferHours
object

Work hours for call transfer in HHMM format (e.g., {"MONDAY": [900, 1730]}). If null, transfer is always allowed.

string

First message to send from the agent

boolean
Defaults to false

Whether recipients can interrupt the initial greeting on outbound calls

boolean
Defaults to true

Whether the generated voice prompt includes provider-specific expression guidance

string

Closing phrase the agent says before ending an inbound call

number
0 to 20
Defaults to 0

Seconds to wait before the voice agent joins an inbound call.

string
enum
Defaults to EN

Voice recognition mode: EN for English-only (highest accuracy), MULTI for multilingual support

Allowed:
boolean
Defaults to false

Whether the agent allows follow-ups

string

Custom instructions for smart follow-up messages. When provided, the AI uses these to guide follow-up content.

boolean
Defaults to false

Whether the agent allows gathering information on incoming call

number
Defaults to 3

Max duration of incoming call in minutes

number
Defaults to 10

Max duration of outgoing call in minutes

string

Instructions for the agent on incoming calls

string

Welcoming voice mail message for contacts

string

Welcoming voice mail message for others

boolean
Defaults to false

Is agent a voice mail agent

outgoingCallFlow
object

Flow structure for outgoing calls

incomingCallFlow
object

Flow structure for incoming calls

boolean
Defaults to true

Whether the agent has a typing sound for incoming calls

boolean
Defaults to true

Whether the agent has a background sound for incoming calls

boolean
Defaults to true

Whether the agent has a typing sound for outgoing calls

boolean
Defaults to true

Whether the agent has a background sound for outgoing calls

boolean
Defaults to false

Whether the agent allows incoming SMS messages

string

Instructions for the agent on incoming SMS messages

boolean
Defaults to true

Whether the agent automatically responds to SMS messages

number
Defaults to 1

Delay in seconds before responding to SMS messages

boolean
Defaults to false

Use incoming call flow for SMS conversations (creativity slider)

string

Post-call SMS message to send after incoming calls complete

boolean
Defaults to false

Whether the agent can send SMS messages during calls via the send_sms tool

boolean
Defaults to false

Whether the agent requires data consent before starting calls

string

Custom text/instructions for what consent is being requested for

boolean
Defaults to false

Whether to enable post-call outbound actions (scheduling calls after incoming calls)

string

Free-form instructions for post-call actions. Example: "If HVAC emergency, call John at +1234567890 immediately. If plumbing issue, call Mike at +1555555555 in 5 minutes."

string
enum
Defaults to employee

Behavior preset for normal agent create/update. New agents are currently created as employee; lead-qualify is manual/admin-only.

Allowed:
boolean
Defaults to false

Strictly reject incoming calls detected as spam before connecting to the agent

string | null

Custom rule for detecting valuable incoming calls after each call. Max 300 characters.

string | null

UUID of a verified caller ID to use for outbound calls. Null to clear.

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?