Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.noxus.ai/llms.txt

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

Language-agnostic HTTP API for integrating Noxus into any application or platform.

​
Key Features

Complete Coverage

Access all Noxus capabilities through RESTful HTTP endpoints with standard request/response patterns.

Language Agnostic

Integrate from any language or platform that can make HTTP requests (JavaScript, Java, Go, Ruby, etc.).

Webhook Support

Configure webhooks to receive real-time notifications about flow completions, agent actions, and system events.

OpenAPI Spec

Complete OpenAPI/Swagger documentation for automatic client generation and API exploration.

​
Common Use Cases

Build web or mobile interfaces that interact with Noxus:
// React example
const runFlow = async (inputs) => {
  const response = await fetch('https://backend.noxus.ai/v1/workflows/wf_123/runs', {
    method: 'POST',
    headers: {
      'X-API-KEY': apiKey,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ input: inputs })
  });
  
  return await response.json();
};
Connect Noxus to your microservices architecture:
// Go example
type FlowRequest struct {
    Input map[string]interface{} `json:"input"`
}

func runNoxusFlow(flowID string, inputs map[string]interface{}) error {
    req := FlowRequest{Input: inputs}
    body, _ := json.Marshal(req)
    
    resp, err := http.Post(
        fmt.Sprintf("https://backend.noxus.ai/v1/workflows/%s/runs", flowID),
        "application/json",
        bytes.NewBuffer(body),
    )
    // Handle response...
}
Trigger flows from external events:
# Stripe webhook example
curl -X POST https://backend.noxus.ai/v1/workflows/wf_123/runs \
  -H "X-API-KEY: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "event": "payment_succeeded",
      "customer_id": "cust_123",
      "amount": 4999
    }
  }'
Integrate AI flows into your deployment pipeline:
# GitHub Actions example
- name: Run Noxus Flow
  run: |
    curl -X POST https://backend.noxus.ai/v1/workflows/wf_123/runs \
      -H "X-API-KEY: ${{ secrets.NOXUS_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d '{"input": {"pr_number": "${{ github.event.pull_request.number }}"}}'
Connect Noxus to platforms like Zapier, Make, or n8n:
  • Create custom Zapier actions
  • Build Make.com modules
  • Add n8n nodes
  • Integrate with Pipedream flows

​
Authentication

All API requests require authentication via API keys provided in the X-API-KEY header: 
curl -X GET https://backend.noxus.ai/v1/workflows \
  -H "X-API-KEY: your_api_key_here"
Store API keys securely and never commit them to version control. Use environment variables or secret management systems.

​
Getting Started

1

Generate API Key

Create an API key from your workspace settings
2

Test Connection

Make a test request to verify your credentials
3

Explore Endpoints

Browse the complete API reference
4

Implement Integration

Build your integration using the API

API Reference

Complete API documentation with all endpoints and examples