Enterprise APIs
Simulate.Farm provides structured APIs that allow organizations to integrate simulation capabilities into their own software systems. All API interactions are designed with strong security and authentication mechanisms to protect sensitive data and simulation workflows.
API Capabilities
Programmatic access to the full simulation platform enables automated workflows and integration with existing systems.
Simulation Execution API
Trigger RuFaS simulations programmatically with full control over parameters. Submit jobs, monitor progress, and receive completion notifications through webhooks or polling.
Secure Data Transfer
Submit datasets and simulation parameters through authenticated requests. All API traffic is encrypted, and access tokens are scoped to specific resources and operations.
Result Retrieval
Access structured simulation outputs for further analysis. Results are available in multiple formats (JSON, CSV, XML) with full metadata and provenance information.
Enterprise Integration
Connect simulation workflows with enterprise platforms while maintaining strict security controls. Supports batch processing, scheduled runs, and event-driven triggers.
API Endpoints
RESTful endpoints provide comprehensive access to simulation operations. All endpoints require authentication and support JSON request/response formats.
| Method | Endpoint |
|---|---|
| POST | /api/v1/simulations |
| GET | /api/v1/simulations/{id} |
| GET | /api/v1/simulations/{id}/results |
| POST | /api/v1/simulations/{id}/compare |
| GET | /api/v1/scenarios |
| POST | /api/v1/webhooks |
Example Usage
The following example demonstrates creating a simulation and retrieving results using the JavaScript SDK.
// Example: Create and monitor a simulation
const response = await fetch('https://api.simulate.farm/v1/simulations', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
scenario: 'dairy_farm_baseline',
parameters: {
herd_size: 500,
breed: 'holstein',
lactation_days: 305,
region: 'wisconsin'
}
})
});
const { simulation_id, status } = await response.json();
// Poll for completion or use webhooks
const results = await fetch(
`https://api.simulate.farm/v1/simulations/${simulation_id}/results`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);Developer Features
Tools and resources to help you build reliable integrations with the Simulate.Farm API.
API Key Management
Generate and rotate API keys with configurable scopes and expiration policies.
Rate Limiting
Fair usage limits with burst allowances. Enterprise plans include higher quotas.
OpenAPI Specification
Full API documentation with interactive exploration and client generation.
SDK Support
Official client libraries for Python, JavaScript, and R with typed interfaces.
Authentication
All API requests require authentication using Bearer tokens. Tokens are scoped to specific projects and can be configured with fine-grained permissions for read, write, and execute operations.
- OAuth 2.0 client credentials flow for server-to-server
- API keys for simpler integrations with limited scope
- Token refresh without re-authentication
- Audit logging for all API access
Authorization Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Ready to integrate?
Explore the full API documentation or contact us to discuss enterprise integration requirements.