AMIGO DEVELOPERSAPI v1API Beta

Your platform. Amigo’s voice.

Trigger a call, receive its results and bring resident signals into your product. Everything you need to build your integration.

Start building API keys API reference

Enterprise integration

API v1BetaThe essentialsEnterprise integration

Enterprise integration guide

From alert to conversation.

Connect your company’s software to the Amigos deployed for your residents: calls, results and signals in your dashboard.

API reference

Connect

Create an API key for your organization and register your HTTPS webhook.

Trigger

Request a call with the resident ID and relevant context.

Sync

Verify the notification and fetch authorized signals.

Call a resident in your organization

This workflow is for companies with an Amigo organization. The resident must be active and linked to an Amigo deployed within that organization. Use a key with calls:write, calls:read, residents:read and the required signal scopes. Map your software’s resident identifier to the Amigo resident_id, then register your receiver using the Webhooks section.

POST /api/public/v1/calls

export AMIGO_BASE_URL="https://app.tryamigo.io"
export AMIGO_API_KEY="YOUR_SERVER_API_KEY"

curl -X POST "$AMIGO_BASE_URL/api/public/v1/calls" \
  -H "Authorization: Bearer $AMIGO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: device-alert-9271" \
  -d '{
    "resident_id": "8c9f8c7e-91db-4dc9-883c-4c91b87538a8",
    "external_user_id": "resident-482",
    "external_reference": "device-alert-9271",
    "trigger": {
      "type": "device_alert",
      "description": "No refrigerator opening detected today. Ask how the resident is feeling and whether they have eaten.",
      "device_id": "sensor-12"
    }
  }'

202 Accepted. Save data.call_request_id. call_id remains null until the accepted call is linked to your request. The top-level request_id is only an HTTP trace identifier.

Track request · retrieve results

curl "$AMIGO_BASE_URL/api/public/v1/call-requests/$CALL_REQUEST_ID" \
  -H "Authorization: Bearer $AMIGO_API_KEY"

curl "$AMIGO_BASE_URL/api/public/v1/calls/$CALL_ID/results" \
  -H "Authorization: Bearer $AMIGO_API_KEY"

curl "$AMIGO_BASE_URL/api/public/v1/residents/$RESIDENT_ID/signals?range=30d" \
  -H "Authorization: Bearer $AMIGO_API_KEY"

Run these requests server-side. Never expose the API key in dashboard browser code. Examples use AMIGO_BASE_URL for your HTTPS domain.