Documentation

Getting Started

Welcome to NexusAI! This guide will help you set up your account and create your first automation workflow in under 10 minutes.

Step 1: Create Your Account

Sign up at app.nexusai.dev using your work email. You'll get a 14-day free trial of the Pro plan with access to all features. No credit card required.

Step 2: Create Your First Workspace

After signing in, create a workspace for your team. A workspace is where all your workflows, agents, and integrations live. You can invite team members and assign roles (Admin, Editor, Viewer).

Step 3: Build a Workflow

Click "New Workflow" to open the visual builder. Here's a simple example that classifies incoming emails:

Trigger: New email received in Gmail
  → AI Agent: Email Classifier
  → Condition: If category == "support"
    → Action: Create Jira ticket
    → Action: Send Slack notification to #support
  → Condition: If category == "sales"
    → Action: Create HubSpot deal
    → Action: Notify sales team

API Reference

NexusAI provides a RESTful API for programmatic access to all platform features. All API requests require authentication via API key or OAuth 2.0 token.

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer nxai_sk_your_api_key" \
  https://api.nexusai.dev/v1/workflows

Workflows API

Manage workflows programmatically:

• GET /v1/workflows - List all workflows in your workspace
• POST /v1/workflows - Create a new workflow
• GET /v1/workflows/:id - Get workflow details
• PUT /v1/workflows/:id - Update a workflow
• DELETE /v1/workflows/:id - Delete a workflow
• POST /v1/workflows/:id/execute - Trigger a workflow execution
• GET /v1/workflows/:id/runs - List execution history

Agents API

Interact with AI agents directly:

• GET /v1/agents - List available agents
• POST /v1/agents/:id/run - Execute an agent with input data
• GET /v1/agents/:id/runs/:runId - Get execution result

Webhooks

Configure webhooks to receive real-time notifications about workflow events:

POST /v1/webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["workflow.completed", "workflow.failed", "agent.error"],
  "secret": "your_webhook_secret"
}

SDK & Libraries

We provide official SDKs for popular programming languages:

• Python: pip install nexusai - Full-featured SDK with async support
• Node.js: npm install @nexusai/sdk - TypeScript-first with full type definitions
• Go: go get github.com/nexusai/go-sdk - Lightweight and concurrent
• Java: Available via Maven Central as com.nexusai:sdk

Python SDK Example

from nexusai import NexusAI

client = NexusAI(api_key="nxai_sk_your_key")

# Execute a workflow
result = client.workflows.execute(
    workflow_id="wf_abc123",
    input_data={"email": "customer@example.com", "subject": "Need help"}
)

print(f"Status: {result.status}")  # "completed"
print(f"Output: {result.output}")  # {"category": "support", "priority": "high"}

Rate Limits

API rate limits depend on your plan:

• Starter: 100 requests/minute, 10,000 requests/day
• Pro: 500 requests/minute, 100,000 requests/day
• Enterprise: Custom limits, dedicated infrastructure available

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.