COMPREHENSIVE DOCUMENTATION

Welcome to NeuralFlow AI

Build powerful AI applications with our comprehensive documentation and API reference. Get started in minutes with our quick start guide.

⌘K

Getting Started

4 articles

Explore

API Reference

4 articles

Explore

Workflows

4 articles

Explore

Integrations

4 articles

Explore

Quick Start Get Running in Minutes

Follow these simple steps to integrate NeuralFlow AI into your application

Get Your API Key

// Store your API key securely
const API_KEY = process.env.NEURALFLOW_API_KEY;

Install the SDK

Install our official SDK using your preferred package manager.

npm install @neuralflow/sdk
# or
yarn add @neuralflow/sdk

Make Your First Request

Initialize the client and make your first API call.

import { NeuralFlow } from '@neuralflow/sdk';

const client = new NeuralFlow({
  apiKey: process.env.NEURALFLOW_API_KEY
});

const response = await client.analyze({
  input: "Hello, NeuralFlow!",
  model: "gpt-4"
});

Try the Builder Browse Templates

API Endpoints RESTful & GraphQL

Comprehensive API reference with interactive examples and best practices

POST

~250ms

Core

/v1/analyze

Analyze text using AI models with advanced NLP capabilities

Parameters: input model options

Request Example

{
  "input": "Analyze this text",
  "model": "gpt-4",
  "options": {
    "temperature": 0.7,
    "max_tokens": 1000
  }
}

Response Example

{
  "id": "req_abc123",
  "result": "Analysis complete",
  "tokens_used": 245,
  "model": "gpt-4"
}

Test this endpoint with your API key

GET

~50ms

Core

/v1/models

List all available AI models with capabilities and pricing

Parameters: filter sort

Request Example

GET /v1/models?filter=gpt

Response Example

{
  "models": [
    {
      "id": "gpt-4",
      "name": "GPT-4",
      "context_length": 8192,
      "pricing": "$0.03/1K tokens"
    }
  ]
}

Test this endpoint with your API key

POST

~500ms

Workflows

/v1/workflows

Create and deploy custom AI workflows with multiple nodes

Parameters: name nodes connections

Request Example

{
  "name": "Content Generator",
  "nodes": [...],
  "connections": [...]
}

Response Example

{
  "id": "wf_xyz789",
  "status": "deployed",
  "url": "/workflows/wf_xyz789"
}

Test this endpoint with your API key

GET

~100ms

Workflows

/v1/workflows/:id

Retrieve workflow details, execution history, and analytics

Parameters: id include_history

Request Example

GET /v1/workflows/wf_xyz789

Response Example

{
  "id": "wf_xyz789",
  "name": "Content Generator",
  "status": "active",
  "executions": 1247
}

Test this endpoint with your API key

PUT

~300ms

Workflows

/v1/workflows/:id

Update workflow configuration and node connections

Parameters: id updates

Request Example

{
  "name": "Updated Name",
  "nodes": [...]
}

Response Example

{
  "id": "wf_xyz789",
  "updated_at": "2024-01-15T10:30:00Z"
}

Test this endpoint with your API key

DELETE

~200ms

Workflows

/v1/workflows/:id

Delete a workflow and all associated data

Parameters: id

Request Example

DELETE /v1/workflows/wf_xyz789

Response Example

{
  "deleted": true,
  "id": "wf_xyz789"
}

Test this endpoint with your API key

POST

~150ms

Integrations

/v1/webhooks

Parameters: url events secret

Request Example

{
  "url": "https://api.example.com/webhook",
  "events": ["workflow.completed"],
  "secret": "whsec_..."
}

Response Example

{
  "id": "wh_abc123",
  "status": "active"
}

Test this endpoint with your API key

GET

~120ms

Analytics

/v1/usage

Get detailed usage statistics and billing information

Parameters: start_date end_date granularity

Request Example

GET /v1/usage?start_date=2024-01-01

Response Example

{
  "total_requests": 15420,
  "total_tokens": 2450000,
  "cost": "$73.50"
}

Test this endpoint with your API key

Official SDKs Multiple Languages

Get started quickly with our official client libraries for your favorite programming language

JavaScript

Official SDK

import { NeuralFlow } from '@neuralflow/sdk';

const client = new NeuralFlow({
  apiKey: process.env.NEURALFLOW_API_KEY
});

// Analyze text
const result = await client.analyze({
  input: "Your text here",
  model: "gpt-4",
  options: {
    temperature: 0.7,
    max_tokens: 1000
  }
});

console.log(result);

View Documentation Docs Examples

Python

Official SDK

from neuralflow import NeuralFlow

client = NeuralFlow(
    api_key=os.environ.get("NEURALFLOW_API_KEY")
)

# Analyze text
result = client.analyze(
    input="Your text here",
    model="gpt-4",
    options={
        "temperature": 0.7,
        "max_tokens": 1000
    }
)

print(result)

View Documentation Docs Examples

Go

Official SDK

package main

import (
    "github.com/neuralflow/go-sdk"
)

func main() {
    client := neuralflow.NewClient(
        os.Getenv("NEURALFLOW_API_KEY"),
    )

    // Analyze text
    result, err := client.Analyze(&neuralflow.AnalyzeRequest{
        Input: "Your text here",
        Model: "gpt-4",
        Options: &neuralflow.Options{
            Temperature: 0.7,
            MaxTokens:   1000,
        },
    })

    fmt.Println(result)
}

View Documentation Docs Examples

Ruby

Official SDK

require 'neuralflow'

client = NeuralFlow::Client.new(
  api_key: ENV['NEURALFLOW_API_KEY']
)

# Analyze text
result = client.analyze(
  input: "Your text here",
  model: "gpt-4",
  options: {
    temperature: 0.7,
    max_tokens: 1000
  }
)

puts result

View Documentation Docs Examples

Need support for another language?

Request a new SDK

Error Codes Handle Errors Gracefully

Comprehensive error code reference with solutions and best practices

400

Bad Request

HTTP Status Code

The request was malformed or missing required parameters

Example

Missing required field: "input"

Solution

Check your request payload and ensure all required fields are present

401

Unauthorized

HTTP Status Code

Invalid or missing API key

Example

Invalid API key provided

Solution

Verify your API key is correct and included in the Authorization header

403

Forbidden

HTTP Status Code

Your API key does not have permission to access this resource

Example

Insufficient permissions for this endpoint

Solution

Upgrade your plan or contact support for access

404

Not Found

HTTP Status Code

The requested resource does not exist

Example

Workflow not found: wf_xyz789

Solution

Verify the resource ID is correct

429

Too Many Requests

HTTP Status Code

Rate limit exceeded

Example

Rate limit exceeded. Retry after 60 seconds

Solution

Implement exponential backoff and respect rate limit headers

500

Internal Server Error

HTTP Status Code

An error occurred on our servers

Example

Internal server error. Please try again

Solution

Retry the request. If the issue persists, contact support

503

Service Unavailable

HTTP Status Code

The service is temporarily unavailable

Example

Service temporarily unavailable

Solution

Wait a few moments and retry. Check our status page for updates

Error Handling Best Practices

Implement Retry Logic

Use exponential backoff for transient errors (429, 503)

Log Error Details

Capture request IDs and timestamps for debugging

Graceful Degradation

Provide fallback responses when API is unavailable

Rate Limits Fair Usage Policy

API rate limits vary by plan. Monitor your usage in the dashboard.

Plan	Requests/Day	Rate Limit	Burst Limit
Free	100/day	10/min	20
Starter	10,000/day	100/min	200
Professional	100,000/day	1,000/min	2,000
Enterprise	Unlimited	Custom	Custom

Rate Limit Headers

Check X-RateLimit-* headers in API responses

Retry Logic

Implement exponential backoff for 429 errors

Monitoring

Track usage in real-time via dashboard

NEED ASSISTANCE?

We're Here to Help 24/7 Support

Can't find what you're looking for? Our support team is ready to assist you.

Live Chat

Get instant help from our support team

Start Chat →

Community

Join our developer community

Join Discord →

Email Support

Reach out via email anytime

Send Email →

Go to Dashboard View Pricing