AigentlyDevelopers
All pages

Get started

Aigently API

Place calls, start chats and read every conversation from your own server.

View as Markdown

Your agents already answer phones, talk on your website and chat on WhatsApp. The API lets your own systems take part: place a call when a lead arrives, give an inbound caller's details to the agent before it says hello, run a chat from your app, and read back the transcript, the analysis and the recording of every conversation.

Start here

  • Quickstart — a test key, a test call that rings nobody, its transcript, and its webhooks on your laptop, in about twenty minutes.
  • API reference — every operation, with an example in seven languages and a Try it that takes a test key.
  • Test mode — everything you can do without a phone number or credit.

How it works

  • Address. https://api.aigently.ai/v1. A company running its own copy of Aigently uses its own address with /v1 on the end.
  • Keys. An organization API key in Authorization: Bearer <key>. Keys are made on the console's API keys page. A test key (ag_test_…) sees only test data and never rings a real phone; a live key (ag_live_…) places real calls. See API keys.
  • JSON, with snake_case fields. Unknown fields in a request are refused, so a typo fails loudly. Responses may gain fields at any time; read the ones you know.
  • Errors are problem documents with a stable code — see Errors.
  • Retries are safe where they matter: a call needs an Idempotency-Key, and sending the same request again returns the same conversation. See Safe retries.
Check your key
#!/bin/sh
# Check your key
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/me" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Examples in your language

Every example on this site is in curl, JavaScript, Python, Go, Java, C# and PHP, using each language's usual HTTP tool — there is nothing of ours to install. Pick a language once and every example follows. Every example is run against the platform before it is published.

Downloads