Skip to main content

Official Python SDK for the Neuratel API

Project description

neuratelai

PyPI Python Docs

Official Python SDK for the Neuratel API — build and manage AI voice agents in a few lines of code.

Installation

pip install neuratelai
# or
uv add neuratelai

Quick Start

from neuratelai import Neuratel

client = Neuratel()  # reads NEURATEL_API_KEY from env

# Create an agent
agent = client.agents.create(
    name="Support Bot",
    brain={"provider": "openai", "model": "gpt-4.1", "instructions": "You are a helpful support agent."},
    voice={"provider": "elevenlabs", "voice_id": "gHu9GtaHOXcSqFTK06ux", "model": "eleven_flash_v2_5"},
    transcriber={"provider": "deepgram", "model": "nova-3"},
)
print(agent["id"])

# Place an outbound call
call = client.calls.outbound(
    agent_id=agent["id"],
    to_number="+14155551234",
    number_id="pn_your_number_id",
)
print(call["status"])

# Iterate all agents (auto-paginates)
for agent in client.agents.list().auto_paging_iter():
    print(agent["id"], agent["name"])

Async

import asyncio
from neuratelai import AsyncNeuratel

async def main():
    async with AsyncNeuratel() as client:
        agent = await client.agents.create(
            name="Bot",
            brain={"provider": "openai", "model": "gpt-4.1", "instructions": "..."},
        )
        async for a in await client.agents.list():
            print(a["id"])

asyncio.run(main())

Resources

Resource Methods
agents create, list, get, update, delete, duplicate, web_call, list_versions, get_version, restore_version
calls list, get, delete, outbound, active, concurrency, hangup, listen, whisper, barge
phone_numbers list, get, update, assign, unassign
campaigns create, list, get, update, delete, start, pause, stop, list_calls, get_call
call_lists create, list, get, update, delete, bulk_import, add_contact, list_contacts, update_contact, delete_contact
knowledge_base list, get, update, delete, from_file, from_url, from_text, query, list_for_agent, assign_to_agent
webhooks events, create, list, get, update, delete, test, rotate_secret, logs
billing balance, usage, balance_history
api_keys create, list, revoke, rotate, scopes
integrations list, create, update, delete, list_tools, refresh_tools

Error Handling

from neuratelai import AuthenticationError, NotFoundError, RateLimitError, APIError

try:
    agent = client.agents.get("ag_unknown")
except AuthenticationError:
    print("Invalid API key")
except NotFoundError:
    print("Agent not found")
except RateLimitError:
    print("Rate limited")
except APIError as e:
    print(f"HTTP {e.status_code}: {e}")

Requirements

Python 3.10+ · docs.neuratel.ai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuratelai-0.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuratelai-0.1.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file neuratelai-0.1.0.tar.gz.

File metadata

  • Download URL: neuratelai-0.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for neuratelai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a6fe68a3cef8191e6ca3c72f9e0927696179dd38e61d37242c6a30d8faeeb84f
MD5 96e35ebb93e9ac90a86dc5e5155db858
BLAKE2b-256 fa98b194cb53c50d1ebf951b740b375e8e8cf0f4505dcfeaf2456f2da75b6889

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuratelai-0.1.0.tar.gz:

Publisher: release.yml on Neuratel-AI/neuratel-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file neuratelai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: neuratelai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for neuratelai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c4d5cdf11f9d7174ba6bfd8f34ebe5a671f788332e0b37eae76c8a54994327b
MD5 09ea21378dc2b12e33add1762b441f86
BLAKE2b-256 3ac10604ce5607e194f06914f1ce3f361cc8cad529585bcdfb8c2d51c515a47f

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuratelai-0.1.0-py3-none-any.whl:

Publisher: release.yml on Neuratel-AI/neuratel-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page