Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nixflex.com/llms.txt

Use this file to discover all available pages before exploring further.

The Nixflex API is REST over HTTPS. All requests use JSON. Authentication is via Bearer token (see Authentication).

​
Base URL

https://api.nixflex.com
All endpoints in this reference are relative to this base URL.

​
Versioning

The current version is v1. All paths are prefixed /v1/. When v2 is released, v1 will continue working unchanged for at least 12 months. Breaking changes always live behind a new version.

​
Authentication

Every request requires an Authorization header: 
Authorization: Bearer key_id:key_secret
The colon between key_id and key_secret is required. See Authentication for details.

​
Request format

POST, PUT, and PATCH requests must include Content-Type: application/json and a JSON body. GET requests use query parameters where applicable.

​
Response format

All responses are JSON. Success responses return the resource directly: 
{
  "agent_id": "agent_125207e452f8714a",
  "name": "Test Receptionist",
  ...
}
Error responses follow a consistent envelope (see Errors): 
{
  "error": {
    "type": "invalid_request",
    "code": "invalid_phone_format",
    "message": "..."
  }
}

​
Pagination

List endpoints (GET /v1/agents, GET /v1/calls, etc.) support pagination:
ParameterDefaultMax
limit25100
offset0—
curl "https://api.nixflex.com/v1/calls?limit=50&offset=100" \
  -H "Authorization: Bearer KEY_ID:KEY_SECRET"
Response includes a top-level count for total available results.

​
Resource list

Agents

Create and manage AI agents (prompt, voice, behaviour).

Calls

List, fetch, and trigger calls. Outbound + batch.

Phone numbers

Import Twilio numbers and attach them to agents.

SMS

Send individual messages and bulk campaigns.

Account

Manage API keys and view usage.

​
Status codes

CodeMeaning
200Success (GET, PUT, PATCH, DELETE)
201Created (POST)
400Invalid request — check parameters
401Not authenticated — check API key
403Authenticated but not permitted
404Resource not found
409Conflict (e.g. number already imported)
429Rate limited — see Retry-After header
500Server error — contact support
502Upstream provider error (Twilio, etc.)

​
Idempotency

Mutation endpoints (POST, PUT, PATCH, DELETE) accept an optional Idempotency-Key header for safe retries: 
Idempotency-Key: my-unique-request-id-123
Requests with the same key within 24 hours return the original response. Safe to retry on network failures.