Docs

SysModeler — User Manual

16. Model Search, API Keys & External Integrations

Model Search searches across the raw content of all files in a SysModeler project:

  • Plain-text or regular-expression (regex) searches.
  • Options for case-sensitive and whole-word matching.
  • Results grouped by file, with inline previews for immediate context.
  • Navigate directly from a result to the exact matched location in the editor.

This makes it easy to locate, inspect, and modify specific model content within large SysML projects.

16.2 API keys & the SysML v2 REST API

SysModeler.ai API keys provide secure, programmatic access to SysML v2 projects and their associated REST APIs from outside the application — no web UI required.

Where you can call it from:

  • Google Colab notebooks
  • Google Sheets
  • Python scripts
  • CI/CD pipelines and other external tools

What the REST API exposes: programmatic access to projects, model elements, queries, and other model operations — for automation, integrations, data synchronization, and custom workflows.

Configurable scopes (set per key; grant the least privilege necessary):

ScopeGrants
ReadRetrieve and query project/model information, requirements, and metadata
WriteCreate, modify, or update project/model data

Setting up programmatic access:

  1. Go to Settings → API Keys.
  2. Create a new key and assign the appropriate Read and/or Write scope.
  3. Copy the key immediately and store it in your secret manager or environment variables.
  4. Use it as a bearer credential from your external environment (Colab, Sheets, Python, CI/CD) to call the SysML v2 REST APIs.

Caution: A Write-scoped key can change model data programmatically. Rotate keys periodically, scope them narrowly, and revoke any key that may have leaked.