API Overview
The Neuramancer API is a RESTful API for AI-powered image analysis and deepfake detection.
Base URLs
Section titled “Base URLs”The API is available at multiple environments:
| Environment | Base URL | Description |
|---|---|---|
| Production | https://api.neuramancer.de | Production environment |
| Development | https://api.neuramancer.dev | Development environment |
API Version
Section titled “API Version”The current version is v1.
All endpoints are prefixed with /v1/.
Authentication
Section titled “Authentication”See Authentication Guide for detailed instructions.
Endpoints
Section titled “Endpoints”See API Reference for a complete list of endpoints.
Data Models
Section titled “Data Models”See Data Model - Entity relationships and field definitions
Request Format
Section titled “Request Format”Content Type
Section titled “Content Type”All POST/PUT requests must use JSON:
Content-Type: application/jsonAccept Header
Section titled “Accept Header”Specify the expected response format:
Accept: application/jsonResponse Format
Section titled “Response Format”All API responses are JSON objects.
Generic Success Response Schema
Section titled “Generic Success Response Schema”{ "success": true, "data": { ... }}Generic Error Response Schema
Section titled “Generic Error Response Schema”{ "success": false, "message": "Error description here"}Generic HTTP Status Codes
Section titled “Generic HTTP Status Codes”| Status Code | Meaning | Description |
|---|---|---|
| 200 | OK | Request successful |
| 400 | Bad Request | Invalid request parameters or body |
| 401 | Unauthorized | Missing or invalid authentication credentials (API key expired or invalid, JWT token invalid) |
| 403 | Forbidden | No authentication provided for protected endpoint |
| 404 | Not Found | Resource not found (tenant, analysis, etc.) |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error occurred |
Rate Limiting
Section titled “Rate Limiting”Common Parameters
Section titled “Common Parameters”Tenant Name
Section titled “Tenant Name”All authenticated requests require a tenantName parameter to scope the operation:
?tenantName=your_tenant_name