Neural Partners API v1 Documentation

Base URL: https://api.neuralpartners.ai/v1/
Protocol: HTTPS only
Authentication: None required (public read-only access)
Rate Limit: 100 requests per minute per IP
Format: JSON
Methods: GET only (read-only API)

Response Format

Success Response

{
  "success": true,
  "data": [...],
  "meta": {
    "timestamp": "2025-08-24T12:00:00Z",
    "total": 25,
    "limit": 10,
    "offset": 0
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "timestamp": "2025-08-24T12:00:00Z"
  }
}

Services Endpoints

GET List Services

/v1/services/list

Retrieve all available services with optional filtering.

Parameter Type Description Required
category string Filter by service category Optional
limit integer Maximum number of results (default: 50) Optional
Example:
GET https://api.neuralpartners.ai/v1/services/list?category=digital&limit=10

GET Get Service Details

/v1/services/get

Retrieve details for a specific service.

Parameter Type Description Required
id string Service ID or slug Required
Example:
GET https://api.neuralpartners.ai/v1/services/get?id=digital-experience

GET List Service Categories

/v1/services/categories

Get all available service categories.

Example:
GET https://api.neuralpartners.ai/v1/services/categories

Expertise Endpoints

GET List Expertise Areas

/v1/expertise/list

Retrieve all expertise areas with optional filtering.

Parameter Type Description Required
category string Filter by expertise category Optional
industry string Filter by industry Optional
limit integer Maximum number of results (default: 50) Optional
Example:
GET https://api.neuralpartners.ai/v1/expertise/list?industry=retail

GET Get Technologies

/v1/expertise/technologies

List all technologies and platforms we work with.

Example:
GET https://api.neuralpartners.ai/v1/expertise/technologies

GET Get Industries

/v1/expertise/industries

List all industries we serve.

Example:
GET https://api.neuralpartners.ai/v1/expertise/industries

Intelligence (Blog) Endpoints

GET List Articles

/v1/intelligence/list

Retrieve published articles with pagination.

Parameter Type Description Required
topic string Filter by topic or category Optional
limit integer Results per page (default: 20, max: 100) Optional
offset integer Skip first N results (default: 0) Optional
Example:
GET https://api.neuralpartners.ai/v1/intelligence/list?topic=ai-marketing&limit=5

GET Get Latest Articles

/v1/intelligence/latest

Get the most recent articles.

Parameter Type Description Required
count integer Number of articles (default: 5, max: 20) Optional
Example:
GET https://api.neuralpartners.ai/v1/intelligence/latest?count=3

GET Get Article Topics

/v1/intelligence/topics

Get all article topics and categories.

Example:
GET https://api.neuralpartners.ai/v1/intelligence/topics

System Endpoints

GET Health Check

/v1/health/check

Check API health and availability.

Example Response: 
{
  "success": true,
  "data": {
    "status": "healthy",
    "version": "1.0.0",
    "resources": ["services", "expertise", "intelligence"]
  },
  "meta": {
    "timestamp": "2025-08-24T12:00:00Z"
  }
}

Error Codes

Code HTTP Status Description
NOT_FOUND 404 Resource or endpoint not found
MISSING_PARAMETER 400 Required parameter is missing
INVALID_PARAMETER 400 Parameter value is invalid
METHOD_NOT_ALLOWED 405 HTTP method not allowed (only GET)
RATE_LIMIT_EXCEEDED 429 Too many requests
INTERNAL_ERROR 500 Internal server error

Code Examples

JavaScript/Node.js

// Fetch services
const response = await fetch('https://api.neuralpartners.ai/v1/services/list');
const data = await response.json();

if (data.success) {
  console.log('Services:', data.data);
  console.log('Total:', data.meta.total);
} else {
  console.error('Error:', data.error.message);
}

Python

import requests

# Fetch latest articles
response = requests.get('https://api.neuralpartners.ai/v1/intelligence/latest', 
                        params={'count': 5})
data = response.json()

if data['success']:
    for article in data['data']:
        print(f"{article['title']} - {article['date']}")
else:
    print(f"Error: {data['error']['message']}")

cURL

# Get service details
curl "https://api.neuralpartners.ai/v1/services/get?id=digital-experience"

# List expertise with filtering
curl "https://api.neuralpartners.ai/v1/expertise/list?industry=retail&limit=10"

# Get latest blog articles
curl "https://api.neuralpartners.ai/v1/intelligence/latest?count=3"

Best Practices

For AI/LLM Systems:
• Cache responses for at least 1 hour to reduce API calls
• Use the topic parameter to filter relevant content
• Include pagination parameters for large result sets
• Handle rate limiting gracefully with exponential backoff
For General Use:
• Always check the success field before processing data
• Use specific endpoints rather than fetching all data
• Include error handling for network failures
• Respect rate limits to ensure service availability

Contact & Support

For API support or to report issues, please contact: team@neuralpartners.ai

Location: Vermont, USA

API Version: 1.0.0 | Last updated: August 24, 2025