Copy page

Guides

Organization Management

Your organization is the top-level workspace in Neuratel. It contains your agents, phone numbers, team members, and all configuration. This guide covers organization settings, bring-your-own-key (BYOK) provider credentials, and data retention.

Organization Settings

Update Name, Timezone, and Logo

Code
curl -X PATCH https://api.neuratel.ai/v1/organization \
  -H "Authorization: Bearer nk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp AI",
    "timezone": "America/New_York",
    "logo_url": "https://acme.com/logo.png"
  }'

Code
import httpx

client = httpx.Client(
    base_url="https://api.neuratel.ai",
    headers={"Authorization": "Bearer nk_live_your_api_key"},
)

client.patch("/v1/organization", json={
    "name": "Acme Corp AI",
    "timezone": "America/New_York",
    "logo_url": "https://acme.com/logo.png",
})

Code
await fetch("https://api.neuratel.ai/v1/organization", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer nk_live_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Acme Corp AI",
    timezone: "America/New_York",
    logo_url: "https://acme.com/logo.png",
  }),
});

The timezone field accepts IANA timezone names (e.g. America/New_York, Europe/London, Asia/Dubai). This affects how timestamps are displayed in the dashboard and reports.

Get Organization Details

Code
curl https://api.neuratel.ai/v1/organization \
  -H "Authorization: Bearer nk_live_your_api_key"

Response:

Code
{
  "id": "org_abc123",
  "name": "Acme Corp AI",
  "timezone": "America/New_York",
  "logo_url": "https://acme.com/logo.png",
  "sku": "scale",
  "created_at": "2025-01-15T08:00:00Z"
}

Provider Credentials (BYOK)

Neuratel supports Bring Your Own Key for major AI providers. Enable BYOK through your account team.

Supported providers:

• LLM: OpenAI, xAI (Grok), Groq
• TTS: ElevenLabs, Cartesia, Phantom Speech
• STT: Deepgram, Soniox, OpenAI

BYOK is configured by the Neuratel team. Contact [email protected] to set it up for your account.

Data Retention Settings

Configure how long call records, transcripts, and recordings are kept before automatic deletion.

Code
curl -X PATCH https://api.neuratel.ai/v1/organization/retention \
  -H "Authorization: Bearer nk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "call_logs_days": 365,
    "transcripts_days": 180,
    "recordings_days": 90
  }'

Code
client.patch("/v1/organization/retention", json={
    "call_logs_days": 365,
    "transcripts_days": 180,
    "recordings_days": 90,
})

Field	Description	Default
call_logs_days	Days to retain call metadata	Indefinite
transcripts_days	Days to retain conversation transcripts	Indefinite
recordings_days	Days to retain audio recordings	Indefinite

Set any field to null to retain indefinitely. Set to 0 to delete immediately after the call ends.

For GDPR compliance, configure retention periods that match your data processing agreements. Contact [email protected] to request individual record deletion.

Sub-Organizations

Enterprise accounts can create sub-organizations to isolate teams, clients, or business units under a single billing relationship. Sub-organizations have their own agents, team members, phone numbers, and settings. Usage rolls up to the parent for billing purposes. Contact your account team to enable this feature.

API Reference

Endpoint	Method	Description
/v1/organization	GET	Get organization details
/v1/organization	PATCH	Update name, timezone, logo
/v1/organization/credentials	GET	List provider credentials
/v1/organization/credentials	POST	Add provider credential
/v1/organization/credentials/{id}	PATCH	Update credential
/v1/organization/credentials/{id}	DELETE	Remove credential
/v1/organization/retention	GET	Get retention settings
/v1/organization/retention	PATCH	Update retention settings

Next Steps

• Managing Your Team — invite team members and assign roles
• Billing and Usage — manage credits and payment methods
• Security — API key best practices and webhook verification