yourang.ai Logo
Back to the platform
Documentation
Get started
  • What the platform is
  • First access
  • Platform overview
  • Quick glossary
Dashboard Assistant
  • What the dashboard assistant is
  • How to use it
  • What it can do
  • Safety and privacy
  • Plans and usage limits
Voice agent
  • Basic configuration
  • Voices and language
  • Instructions
  • Prompt tokens
  • Advanced settings
  • Evaluation criteria
  • Testing and playground
  • Updating instructions
  • External Tools
  • Built-in tools
  • MCP servers
Models offered
  • What models are and why they matter
  • Voice models
  • AI models
  • Choosing the right combination
Documents and knowledge base
  • What the knowledge base is
  • Uploading and managing documents
  • How search works during a call
  • Best practices
Calls
  • Call history
  • Transcripts and summaries
  • Audio recordings
  • Filters and search
  • Data export
Call transfers
  • When and why to transfer a call
  • Departments
  • System tools
  • AI after-hours
  • Routing rules
  • Operator app (iOS / Android)
WhatsApp
  • WhatsApp Business in yourang.ai
  • Real-time chat
  • Automations
  • Approved templates
  • WhatsApp contacts and lists
  • WhatsApp AI agents
Actions and campaigns
  • What actions are
  • SMS campaigns
  • Email campaigns
  • Scheduling and batch sends
Reservations
  • Calendar view
  • Availability rules
  • Confirmations and reminders
  • Changes and cancellations
Contacts
  • Customer directory
  • CSV import
  • Lists and segments
  • Custom fields
Shop and catalogue
  • The shop in yourang.ai
  • Product and service catalogue
  • Order management
  • OCR and price-list import
Integrations
  • Connect Apple Calendar
  • Connect HubSpot
  • Integrations overview
  • Calendar
  • WhatsApp
  • SMS and email
  • Business software and PMS
  • Outbound webhooks
Workflows
  • What workflows are
  • Nodes and blocks
  • Triggers and webhooks
  • Practical examples
Call center and dialer
  • What the yourang.ai call center does
  • Outbound campaigns
  • Human operators
  • Contact lists and live sync
  • Operator panel
External APIs and developers
  • yourang.ai for developers
  • API keys and authentication
  • Main endpoints
  • Incoming webhooks
Use cases
  • Hotels and accommodation
  • Restaurant
  • B&Bs and short-term rentals
  • Beauty center and spa
  • Travel agency
Pricing and plans
  • How pricing works
  • Subscription plans
  • Wallet and credits
  • Consumption and invoices
  • Changing, suspending, or cancelling the plan
Management
  • Account and organization
  • Billing and subscription
  • Team and roles
  • Security and privacy
  • Notifications
Business information
  • Business details
  • Location and address
  • Opening hours
  • AI assistant hours
  • Departments and team
Resources
  • Frequently asked questions
  • Complete glossary
  • Support
Documentation›External APIs and developers›Main endpoints

External APIs and developers

Main endpoints

Overview of API areas and the most common use cases.

The API is organized by resources, each with its own endpoints. Here's a map of the main areas.

Quick start

Three ready-to-use snippets to call the external API. Replace `yr_live_xxx` with your personal key (see the “API keys and authentication” page).

list-contacts.sh · bash
curl -X GET "https://api.yourang.ai.io/external/v1/contacts?limit=20" \
  -H "Authorization: Bearer yr_live_xxx" \
  -H "Accept: application/json"

API areas

  • Contacts. Read, create, update CRM contacts. Two-way synchronizations with management systems, periodic imports from external sources.
  • Calls. Retrieve call history with metadata, transcripts, summaries. Trigger outbound calls programmatically.
  • Reservations. Create, read, modify reservations. Sync the yourang.ai calendar with the PMS or management system.
  • Orders. For the Shop module: create orders from external systems, read status, receive payment confirmations.
  • Documents. Upload and manage the knowledge base via API. Useful for those who keep the catalog/price list in a source system and want to replicate it in yourang.ai.
  • Webhooks. Configure the URLs to which yourang.ai notifies events (see dedicated page).

Typical use cases

  • Sync management system -> yourang.ai. Every night the PMS publishes new contacts and the day's reservations to yourang.ai. The voice assistant works with always-aligned data.
  • yourang.ai -> management system. When the assistant records a new reservation, it reports it to the main management system via API. The assistant becomes an input channel to the central system.
  • Custom dashboard. A BI or Excel sheet connected to the API shows custom aggregated data, beyond the standard panel.
  • Automations with n8n / Make. No-code workflows that react to yourang.ai events to orchestrate actions in other systems: Slack, Notion, Airtable.

Pagination and filters

All list endpoints support pagination (limit + offset) and filters on the main fields. For bulk exports it's better to paginate with reasonable sizes (50-100 per page) rather than asking for everything at once: avoids timeouts and load on systems.

Rate limits

The API has rate limits to protect the system from abuse. Standard limits are generous for normal use; for integrations with high volumes, contact the sales team for dedicated plans.

Was this page helpful?

PreviousAPI keys and authenticationNextIncoming webhooks