Skip to content

Type to search titles, section headings and summaries across the Developer Portal.

↑ ↓ to move · Enter to open · Esc to close · searched locally in your browser

Proposed Interface

API Reference

Public API access is not currently available. The intended integration architecture, proposed API domains and an offline illustrative contract explorer.

Page type: A design proposal; not implemented or available.

Availability

ProposedAvailability

Public API access is not currently available.

This section outlines the intended integration architecture and will be expanded as interfaces are validated and released.

No public endpoint, base URL, authentication scheme or API key exists. Do not send data to any address claiming to be a Synthex API, and do not share credentials.

Before publishing this page, the website repository was checked for API definitions. It contains no product API, OpenAPI specification or API router. The only server endpoint belongs to the website's own enquiry form and is not an API for developers.

Proposed API domains

Design categories, not confirmed endpoints. No URLs, HTTP methods or required parameters are defined.
  • Scenario ManagementProposed

    Register, validate and version scenario configurations so other resources can reference them.

  • Dataset ManagementProposed

    Describe dataset versions through manifests, with quality-check status and provenance.

  • Annotation WorkflowsProposed

    Track annotation tasks, conventions and review status for dataset samples.

  • Evaluation RunsProposed

    Submit models for evaluation against a dataset version and protocol, asynchronously.

  • Experiment ReportsProposed

    Retrieve structured reports with per-condition metrics, failures and limitations.

  • Dataset ExportsProposed

    Package dataset versions into open annotation formats for use in your environment.

Resource lifecycle

How the proposed domains would relate in one workflow.
Proposed resource lifecycle
Conceptual workflow
  1. 01Scenario Management: register scenario
  2. 02Dataset Management: describe dataset version
  3. 03Annotation Workflows: prepare and review labels
  4. 04Dataset Exports: package for training
  5. 05Evaluation Runs: evaluate a model
  6. 06Experiment Reports: retrieve findings

Reports inform new scenarios

Illustrative API contract explorer

Static request and response shapes for three proposed domains. Nothing is sent over the network, and no credentials are requested.

Illustrative API Contract Explorer

Offline · not a live API
Proposed domain

Intent: Register a scenario configuration so datasets and evaluations can reference it by id and version.

Illustrative request bodyProposed
{
  "scenario": {
    "environment": "agricultural",
    "lighting": "overcast",
    "weather": "clear",
    "sensors": [
      "rgb_camera"
    ],
    "random_seed": 1234
  }
}
Illustrative response bodyProposed
{
  "scenario_id": "example-scenario-001",
  "version": "0.1.0",
  "status": "validated",
  "validation_messages": []
}
  • Validation would reject unknown fields and out-of-range values.
  • Scenario versions would be immutable once referenced.

No endpoint, method, host or authentication scheme is shown because none exists. These shapes may change before any release.

What released APIs will document

When an API is validated and approved for release, its reference will cover:
  • API version and versioning policy
  • Authentication requirements
  • Request parameters and request body schemas
  • Response schemas
  • Error codes and their meaning
  • Pagination, where relevant
  • Rate limits, once established
  • Example requests and responses tested against the released API
  • Links to the relevant guides