Skip to main content
This guide walks you through everything you need to go from a fresh VInfer AI account to a live API call. By the end, you’ll have authenticated successfully, triggered your first Neuron outbound campaign, and submitted a recording for NeuronLens transcription — all from your terminal.
VInfer AI’s API uses Bearer token authentication. You’ll need a valid API key for every request. Store your key as an environment variable (e.g., VINFER_API_KEY) and never hardcode it directly in source files or commit it to version control.

​
Steps

1

Sign In to Your VInfer AI Account

Open your browser and navigate to app.vinfer.ai. Sign in with your registered email and password.If you don’t have an account yet, click Request Access on the sign-in page and a member of the VInfer AI team will reach out to provision your workspace. Once your workspace is active, you’ll receive a confirmation email with your login credentials.
2

Generate Your API Key

Once you’re signed in, navigate to Settings → API Keys in the left sidebar.
  1. Click Create New Key.
  2. Give your key a descriptive name — for example, dev-integration or production-crm.
  3. Click Generate. Your new API key appears once — copy it immediately.
  4. Store it securely. We recommend adding it to your environment as:
export VINFER_API_KEY="your_api_key_here"
VInfer AI does not display your API key again after you close the creation dialog. If you lose it, revoke the key and generate a new one from the same Settings → API Keys page.
3

Make Your First API Call

You can start with either product depending on your use case. Both examples below use your VINFER_API_KEY environment variable.
The following request creates an outbound voice campaign with a single contact. Neuron will initiate a call to the number you provide and run the conversation using the script you reference.
curl -X POST https://api.vinfer.ai/v1/campaigns \
  -H "Authorization: Bearer $VINFER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Campaign",
    "language": "en-IN",
    "contacts": [{"phone": "+919876543210", "name": "Raj Kumar"}],
    "script_id": "script_abc123"
  }'
A successful response returns a campaign_id and a status of queued, confirming your campaign has been accepted and the call will be placed shortly.
{
  "campaign_id": "camp_7f3a9c12d4",
  "name": "My First Campaign",
  "status": "queued",
  "language": "en-IN",
  "contact_count": 1,
  "created_at": "2024-08-15T10:30:00Z"
}
Replace script_id with the ID of a script you’ve already configured in your dashboard under Neuron → Scripts. If you haven’t created one yet, the quickstart script (script_abc123) is available as a sample in every new workspace.
4

View Results in Your Dashboard

Head back to app.vinfer.ai to see your results in real time.
  • Neuron campaigns appear under Neuron → Campaigns. Click into your campaign to see live call status, outcomes, and disposition summaries as calls complete.
  • NeuronLens transcription jobs appear under NeuronLens → Transcriptions. Once processing is complete (typically within a minute for a standard call), you’ll see the full transcript, speaker separation, and — if enabled — auto-generated summaries and QA scores.
You can also poll or subscribe to results programmatically. Set up a webhook endpoint in Settings → Webhooks to receive job-completion events pushed to your server automatically.
The API Reference documents every available endpoint with full request and response schemas, authentication details, error codes, and language-specific SDK examples. It’s the best place to go once you’re ready to build beyond these first calls.

​
Next Steps

Build Campaigns with Neuron

Learn how to configure scripts, set retry logic, manage contact lists, and track campaign performance end-to-end.

Analyze Calls with NeuronLens

Explore QA scoring, sentiment dashboards, compliance reports, and how to search your full conversation history.