BCINexus · Working together

API & integrations

The public API contract is developed in the open so integrators can build against it before it is generally available.

Status: draft

The public contract is at 0.1.0-draft. BCINexus runs a live cloud service, but this specific developer-facing contract has not reached preview or stable, and public developer access is launching soon. Build against it, expect it to move, and watch the changelog in the repository.

Base URL and versioning

https://api.bcinexus.xyz/v1
  • Every public route carries an explicit version prefix.
  • Breaking changes are documented in the repository changelog and reflected in the OpenAPI file.
  • Stability labels are draft, preview, and stable; only stable is a supported contract.

Authentication

Bearer tokens or scoped API keys, sent as a standard authorization header.

curl "https://api.bcinexus.xyz/v1/projects" \
  -H "Authorization: Bearer $BCINEXUS_API_KEY" \
  -H "Accept: application/json"

Scopes

ScopeGrants
projects:readRead project metadata
projects:writeCreate or update project metadata
pipelines:readRead pipeline metadata
pipelines:writePublish or update pipeline artifacts
plugins:readDiscover public plugins

Credential handling

Keep keys in environment variables or a managed secret store, never in Git. Use the narrowest scope that works, keep development and production credentials separate, and rotate on a schedule.

What the API covers

  • Projects and their metadata.
  • Pipelines, including artifact import and export.
  • Authentication and token exchange.
  • Plugin discovery.
  • Research workflow metadata.

Schemas

JSON Schema definitions for the interchange formats are published alongside the contract, so you can validate a payload before sending it: the project schema, the pipeline schema, and the plugin manifest schema.

The open repository

The OpenAPI specification, example requests and responses, runnable examples in Python, JavaScript, and plain REST, plus the plugin and hardware integration guides all live in the public repository.

BCINexus public repo on GitHub

OpenAPI spec, schemas, examples, and integration guides.

Driver API for hardware partners

Integrating a device so it streams into BCILattice.

Hardware partners

The partner programme and supported devices.

Responsible disclosure

Reporting a security issue in the API.

Terms

API use is governed by the API terms. Rate limits apply per credential, and abusive or scraping traffic is throttled rather than silently served.

Something missing or out of date? Email support or request a doc page. Include the page name and what you expected to find.