Docs

Quickstart

From an API key to a live call: start a conversation with an existing agent, then read transcript, recording, and intent-filter extraction.

1. Create an API key

In the Convophi app, open Govern → Partner API (admin). Create a key and copy the secret once (vp_live_… or vp_test_…).

2. Confirm credentials

curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  https://echophi.variphi.com/api/external/v1/me

3. Pick an agent

curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  "https://echophi.variphi.com/api/external/v1/agents?page=1&page_size=20"

Copy an agent_id, then fetch detail for template variables (list responses omit them):

curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  https://echophi.variphi.com/api/external/v1/agents/$AGENT_ID

Use each variables[].name as a key in the create-conversation body map.

4. Start conversation with agent

curl -sS -X POST -H "X-Api-Key: $CONVOPHI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "agent_id":"agt_…",
  "phone_number":"+15551234567",
  "variables":{"customer_name":"Ada","order_id":"123"}
}' \
  https://echophi.variphi.com/api/external/v1/conversations

Optional variables is a string map of agent template variables. Status / outcome codes: Status codes or GET /reference/statuses.

5. Transcript, recording, extraction

After the call progresses (or completes), use the conversation id:

# Transcript
curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  https://echophi.variphi.com/api/external/v1/conversations/$CONV_ID/transcript

# Recording metadata (presigned URL when available)
curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  https://echophi.variphi.com/api/external/v1/conversations/$CONV_ID/recording

# Intent filter / structured extraction
curl -sS -H "X-Api-Key: $CONVOPHI_API_KEY" \
  https://echophi.variphi.com/api/external/v1/conversations/$CONV_ID/extraction

6. Try it in the browser

Use the Playground or browse the curated API Reference.

7. Webhooks for call completion

Open Govern → Partner API , add your HTTPS URL, copy the signing secret.
Click Test — confirm webhook.test on your receiver and in Recent Deliveries.
Start a conversation; when the call ends, receive conversation.ended and inspect it under View.
Verify HMAC — guide.