Neo Service Layer API Reference

Base URL

All API endpoints use the following base URL:

https://api.neo-service-layer.io/v1

Authentication

All API requests require authentication using an API key. Include your API key in theX-API-Key header with each request:

curl -X GET "https://api.neo-service-layer.io/v1/functions" \
  -H "X-API-Key: your-api-key-here"

For detailed information about API authentication, see the Authentication documentation.

Response Format

All API responses are returned in JSON format. A typical successful response has the following structure:

{
  "success": true,
  "data": {
    // Response data specific to the endpoint
  }
}

Error responses include error information:

{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Detailed error message"
  }
}

Rate Limiting

API requests are subject to rate limiting based on your plan tier. The current limits are included in the response headers:

X-Rate-Limit-Limit: 100       // Number of requests allowed in the period
X-Rate-Limit-Remaining: 95    // Number of remaining requests in the current period
X-Rate-Limit-Reset: 1625097600 // Unix timestamp when the limit resets

Pagination

Endpoints that return lists of resources support pagination using limit and offset parameters:

# Get the first 10 functions
GET /v1/functions?limit=10&offset=0

# Get the next 10 functions
GET /v1/functions?limit=10&offset=10

Pagination information is included in the response:

{
  "success": true,
  "data": [...],
  "pagination": {
    "total": 45,
    "limit": 10,
    "offset": 0,
    "hasMore": true
  }
}

Filtering

Many list endpoints support filtering using query parameters:

# Get functions with a specific tag
GET /v1/functions?tag=production

# Get functions with multiple filters
GET /v1/functions?tag=production&status=active

Sorting

List endpoints typically support sorting using sort and order parameters:

# Sort functions by creation date in descending order
GET /v1/functions?sort=createdAt&order=desc

# Sort functions by name in ascending order
GET /v1/functions?sort=name&order=asc

The API uses standard HTTP status codes and provides detailed error information in the response body:

In addition to the REST API, we provide SDKs for popular programming languages:

// JavaScript SDK example
const { NeoServiceLayer } = require('neo-service-layer-sdk');

const serviceLayer = new NeoServiceLayer({
  apiKey: 'your-api-key-here'
});

// Using the Functions API
async function listFunctions() {
  const functions = await serviceLayer.functions.list({
    limit: 10,
    offset: 0,
    sort: 'createdAt',
    order: 'desc'
  });
  
  console.log(functions);
}

listFunctions().catch(console.error);

The Neo Service Layer can notify your application about events using webhooks:

// Example webhook payload for a function execution event
{
  "event": "function.execution.completed",
  "data": {
    "functionId": "func_1234567890",
    "executionId": "exec_abcdefghij",
    "status": "success",
    "duration": 127,
    "timestamp": "2023-07-01T12:34:56Z"
  }
}

For detailed information about webhooks, see the Webhooks documentation.

The Neo Service Layer API is versioned to ensure backward compatibility. The current version is v1.

We may introduce new versions in the future to accommodate significant changes. When a new version is released, older versions will be supported for at least 12 months.

If you have questions or need assistance with the API, you can:

• View examples in the Examples section
• Check the FAQ for common questions
• Join our Discord community for real-time help
• Contact our support team through the Contact page