> ## 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.

# REST API

> HTTP API for all platform features

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

## Key Features

<CardGroup cols={2}>
  <Card title="Complete Coverage" icon="layer-group">
    Access all Noxus capabilities through RESTful HTTP endpoints with standard request/response patterns.
  </Card>

  <Card title="Language Agnostic" icon="code">
    Integrate from any language or platform that can make HTTP requests (JavaScript, Java, Go, Ruby, etc.).
  </Card>

  <Card title="Webhook Support" icon="webhook">
    Configure webhooks to receive real-time notifications about flow completions, agent actions, and system events.
  </Card>

  <Card title="OpenAPI Spec" icon="file-code">
    Complete OpenAPI/Swagger documentation for automatic client generation and API exploration.
  </Card>
</CardGroup>

## Common Use Cases

<AccordionGroup>
  <Accordion title="Frontend Applications" icon="browser">
    Build web or mobile interfaces that interact with Noxus:

    ```javascript theme={null}
    // 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();
    };
    ```
  </Accordion>

  <Accordion title="Microservices Integration" icon="cubes">
    Connect Noxus to your microservices architecture:

    ```go theme={null}
    // 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...
    }
    ```
  </Accordion>

  <Accordion title="Webhook Automation" icon="webhook">
    Trigger flows from external events:

    ```bash theme={null}
    # 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
        }
      }'
    ```
  </Accordion>

  <Accordion title="CI/CD Integration" icon="git-branch">
    Integrate AI flows into your deployment pipeline:

    ```yaml theme={null}
    # 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 }}"}}'
    ```
  </Accordion>

  <Accordion title="Third-Party Integrations" icon="plug">
    Connect Noxus to platforms like Zapier, Make, or n8n:

    * Create custom Zapier actions
    * Build Make.com modules
    * Add n8n nodes
    * Integrate with Pipedream flows
  </Accordion>
</AccordionGroup>

## Authentication

All API requests require authentication via API keys provided in the `X-API-KEY` header:

```bash theme={null}
curl -X GET https://backend.noxus.ai/v1/workflows \
  -H "X-API-KEY: your_api_key_here"
```

<Warning>
  Store API keys securely and never commit them to version control. Use environment variables or secret management systems.
</Warning>

## Getting Started

<Steps>
  <Step title="Generate API Key">
    Create an API key from your workspace settings
  </Step>

  <Step title="Test Connection">
    Make a test request to verify your credentials
  </Step>

  <Step title="Explore Endpoints">
    Browse the complete API reference
  </Step>

  <Step title="Implement Integration">
    Build your integration using the API
  </Step>
</Steps>

<Card title="API Reference" icon="book" href="/api-reference/introduction">
  Complete API documentation with all endpoints and examples
</Card>