SDK reference

SDK version: 0.5.0

ActiveLearningCollection

• ActiveLearningCollection.count — Number of items in the collection (fetches all pages).
• ActiveLearningCollection.create — Create a new resource in this collection.
• ActiveLearningCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• ActiveLearningCollection.first — Return the first item in the collection, or None if empty.
• ActiveLearningCollection.list — List inbox items, optionally filtered by status.
• ActiveLearningCollection.refresh — Rebuild the active-learning inbox (admin).

ActiveLearningItem

• ActiveLearningItem.id — Stable UUID of this resource.
• ActiveLearningItem.kind — harmonization_proposal, dut_resolution, qc_violation, or completeness.
• ActiveLearningItem.name — Display label: kind:ref_id.
• ActiveLearningItem.priority — Queue priority (API may serialize Decimal as string).
• ActiveLearningItem.ref_id — Referenced row UUID for this inbox item.
• ActiveLearningItem.skip — Skip this queued item (admin).
• ActiveLearningItem.status — queued, skipped, or done.
• ActiveLearningItem.team_id — Owning team UUID.

AnalysisClient

• AnalysisClient.backfill_proposals — Propose mappings for unmapped traces (admin).

CanonicalSignal

• CanonicalSignal.axis_id — Axis UUID.
• CanonicalSignal.harmonization_status — pending, mapped, needs_review, or manual.
• CanonicalSignal.id — Stable UUID of this resource.
• CanonicalSignal.mapped_by — Mapper: parser, rule, llm, or human.
• CanonicalSignal.mapping_confidence — Optional mapping confidence (API may serialize Decimal as string).
• CanonicalSignal.name — Display label — trace id when set, else id.
• CanonicalSignal.quantity_id — Mapped Quantity UUID.
• CanonicalSignal.role — independent, dependent, or derived.
• CanonicalSignal.scale_as_stored — Scale as stored: linear or dB.
• CanonicalSignal.trace_id — Underlying Trace UUID.
• CanonicalSignal.unit_as_stored — Unit string as stored on the signal.

Client

• Client.close — Shut down the param thread pool, close the transport, mark closed.
• Client.cloudscript — Enable CloudScript lineage tracking and SDK run reporting on this client.
• Client.cloudscripts — CloudScripts in the default project (beta; requires set_project).
• Client.connect — Authenticate with the CloudSprite API.
• Client.datasets — Datasets in the default project (requires set_project).
• Client.derived_quantities — Foundry derived quantities for the default team.
• Client.dut_instance — Fetch a DUT instance by id.
• Client.dut_resolutions — DUT fuzzy-resolution proposals for the default team.
• Client.dut_types — Foundry DUT type catalog for the default team.
• Client.duts — Foundry DUTs for the default team.
• Client.figures — Publish and manage figures on explicit dataset or notebook targets.
• Client.harmonization_proposals — Column→Quantity mapper proposals.
• Client.instruments — Instruments in the default team (requires set_team).
• Client.is_connected — True when authenticated and not closed.
• Client.manufacturers — List all instrument manufacturers in the catalog.
• Client.orbs — Orbs in the default team (requires set_team).
• Client.org_slug — Default org (tenant) slug for scoped requests, or None if unset.
• Client.parameter_keys — Parameter key definitions for the default team.
• Client.parameter_templates — Parameter templates for the default team.
• Client.project_slug — Default project slug for scoped requests, or None if unset.
• Client.projects — Projects in the default team (requires set_team).
• Client.publish — Publish computed traces as a new dataset.
• Client.quantities — Foundry quantity catalog for the default team.
• Client.relationship_types — Foundry relationship type catalog for the default team.
• Client.relationships — Foundry relationships for the default team.
• Client.report_run — Post the active cloudscript() run report immediately.
• Client.reports — Reports in the default project (requires set_team; set_project for listing).
• Client.search — Search resources globally (projects, datasets, notebooks, …).
• Client.search_traces — Search traces with filters; returns raw result dicts.
• Client.set_org — Set the default org (tenant) for subsequent queries and WebSockets.
• Client.set_project — Set the default project for subsequent queries.
• Client.set_team — Set the default team for subsequent queries.
• Client.supported_models — List all supported instrument models in the catalog.
• Client.team_slug — Default team slug for scoped requests, or None if unset.
• Client.teams — Collection of teams visible to the authenticated user.
• Client.workflow_run — Fetch a workflow run by id (beta).
• Client.workflows — Workflows in the default project (beta; requires set_project).

CloudScript

• CloudScript.archive — Soft-archive this CloudScript.
• CloudScript.id — Stable UUID of this resource.
• CloudScript.is_archived — True when the CloudScript has been soft-archived.
• CloudScript.name — Display name (title if present, else name).
• CloudScript.project_id — Owning project UUID.
• CloudScript.run — Queue a server-side run (HTTP 202).
• CloudScript.upload_version — Upload a new version from a local file (multipart).
• CloudScript.versions — Versions on this CloudScript (fetched from detail).

CloudScriptCollection

• CloudScriptCollection.count — Number of items in the collection (fetches all pages).
• CloudScriptCollection.create — Create a CloudScript + version 1 from a local file.
• CloudScriptCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• CloudScriptCollection.first — Return the first item in the collection, or None if empty.

CloudScriptVersion

• CloudScriptVersion.content_hash — Content hash of the stored file.
• CloudScriptVersion.content_url — Presigned GET URL for this version's source.
• CloudScriptVersion.id — Stable UUID of this resource.
• CloudScriptVersion.name — Display name (title if present, else name).
• CloudScriptVersion.version — Monotonic version number (1-based).

DUT

• DUT.attributes — DUT attribute map.
• DUT.delete — Delete this DUT.
• DUT.dut_type_id — Linked DUT type UUID.
• DUT.id — Stable UUID of this resource.
• DUT.identifier — Customer-supplied DUT identifier.
• DUT.instances — Physical instances of this DUT.
• DUT.name — Display name — identifier when set, else id.
• DUT.revision — Revision string, or empty if unset.
• DUT.team_id — Owning team UUID.
• DUT.update — Update DUT fields.

DUTInstance

• DUTInstance.attributes — Instance-level attribute map.
• DUTInstance.delete — Delete this DUT instance.
• DUTInstance.dut_id — Parent DUT UUID.
• DUTInstance.id — Stable UUID of this resource.
• DUTInstance.name — Display name — serial when set, else id.
• DUTInstance.serial — Hardware serial / unit identity string.
• DUTInstance.update — Update DUT instance fields.

DUTResolution

• DUTResolution.accept — Explicitly accept this proposal.
• DUTResolution.algorithm — Matcher algorithm (default trigram).
• DUTResolution.candidate_dut_id — Matched candidate DUT UUID.
• DUTResolution.candidate_identifier — Candidate DUT identifier (denormalized for display when present).
• DUTResolution.candidate_instance_id — Matched DUT instance UUID, or None when match is DUT-level.
• DUTResolution.id — Stable UUID of this resource.
• DUTResolution.name — Display label: query identifier → candidate.
• DUTResolution.query_identifier — Identifier string that was proposed for matching.
• DUTResolution.query_revision — Optional revision string supplied with the query.
• DUTResolution.query_serial — Optional serial string supplied with the query.
• DUTResolution.reject — Explicitly reject this proposal.
• DUTResolution.score — Match score in [0, 1] (API may serialize Decimal as string).
• DUTResolution.status — Proposal status: proposed, accepted, or rejected.
• DUTResolution.team_id — Owning team UUID.

DUTResolutionCollection

• DUTResolutionCollection.count — Number of items in the collection (fetches all pages).
• DUTResolutionCollection.create — Create a new resource in this collection.
• DUTResolutionCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• DUTResolutionCollection.first — Return the first item in the collection, or None if empty.
• DUTResolutionCollection.list — List resolution proposals, optionally filtered by status.
• DUTResolutionCollection.propose — Run the fuzzy matcher and upsert proposed rows.

DUTType

• DUTType.attributes_schema — JSON schema describing DUT attribute keys for this type.
• DUTType.code — Stable DUT type code.
• DUTType.description — Free-text description, or empty if unset.
• DUTType.id — Stable UUID of this resource.
• DUTType.name — Display name (title if present, else name).
• DUTType.status — Governance status: active or deprecated.
• DUTType.team_id — Owning team UUID, or None for a global catalog row.

Dataset

• Dataset.add_note — Add a text note to this dataset.
• Dataset.add_tag — Attach an existing tag to this dataset.
• Dataset.analysis_notes — Foundry analysis notes for this dataset.
• Dataset.clear_preferred_figure — Clear the preferred figure to restore the normal graph (dataset:update).
• Dataset.completeness — Provisional context-completeness report.
• Dataset.delete — Permanently delete dataset. This cannot be undone.
• Dataset.delete_param — Delete a parameter value by its ID.
• Dataset.description — Free-text description, or empty string if unset.
• Dataset.dut_links — Foundry DUT instance links for this dataset.
• Dataset.id — Stable UUID of this resource.
• Dataset.name — Display name (title if present, else name).
• Dataset.params — Parameter values as a {key: value} dict.
• Dataset.remove_tag — Remove a tag from this dataset.
• Dataset.restore — Restore dataset from trash.
• Dataset.set_param — Set a parameter value on this dataset.
• Dataset.set_preferred_figure — Select an attached valid figure as this dataset's view (dataset:update).
• Dataset.signals — CanonicalSignals for traces on this dataset.
• Dataset.slug — URL-safe identifier, unique within the parent project.
• Dataset.tensor — Team-scoped CanonicalSignal tensor catalog.
• Dataset.traces — Access traces (datafiles) in this dataset.
• Dataset.trash — Move dataset to trash (soft delete). Can be restored later.
• Dataset.update — Update dataset fields.
• Dataset.upload — Upload a file from disk to this dataset.
• Dataset.upload_bytes — Upload file content from memory.
• Dataset.upload_large — Upload a large file using chunked multipart upload.
• Dataset.upload_screenshot — Upload an image as the dataset's screenshot/thumbnail.

DatasetAnalysisNote

• DatasetAnalysisNote.body — Note text body.
• DatasetAnalysisNote.dataset_id — Dataset UUID this note summarizes.
• DatasetAnalysisNote.id — Stable UUID of this resource.
• DatasetAnalysisNote.name — Display label: dataset:via.
• DatasetAnalysisNote.status — Proposal status (typically proposed).
• DatasetAnalysisNote.team_id — Owning team UUID.
• DatasetAnalysisNote.via — template or llm.

DatasetDUTLink

• DatasetDUTLink.dataset_id — Linked dataset UUID.
• DatasetDUTLink.delete — Remove this dataset↔DUT link.
• DatasetDUTLink.dut_instance_id — Linked DUT instance UUID.
• DatasetDUTLink.id — Stable UUID of this resource.
• DatasetDUTLink.name — Display label for the link (dataset:instance ids).

DerivedQuantity

• DerivedQuantity.canonical_signal_id — Optional CanonicalSignal UUID when the result is a trace.
• DerivedQuantity.delete — Delete this derived quantity.
• DerivedQuantity.equation_id — Optional Equation UUID.
• DerivedQuantity.equation_version — Equation version string, or empty.
• DerivedQuantity.id — Stable UUID of this resource.
• DerivedQuantity.inputs — Input refs that produced this row.
• DerivedQuantity.name — Display label — quantity code when present, else id.
• DerivedQuantity.producing_script_run_id — Optional ScriptRun UUID that produced this row.
• DerivedQuantity.provenance — Provenance map from the server.
• DerivedQuantity.quantity_id — Linked Quantity UUID.
• DerivedQuantity.team_id — Owning team UUID.
• DerivedQuantity.update — Update derived-quantity fields.
• DerivedQuantity.value_bool — Optional boolean scalar.
• DerivedQuantity.value_number — Optional numeric scalar (API may serialize Decimal as string).
• DerivedQuantity.value_text — Optional text scalar.

EmbeddingsClient

• EmbeddingsClient.refresh — Upsert embeddings for the team's signals (optionally one dataset).
• EmbeddingsClient.search — Cosine-rank the team's embeddings against q (top 20).

FieldProxy

• FieldProxy.matches — Match field against a regex/glob-style pattern.

Figure

• Figure.id — Stable UUID of this resource.
• Figure.name — Display name (title if present, else name).
• Figure.payload — Complete response with wire fields generated from development OpenAPI.
• Figure.revision — Current monotonic revision number.
• Figure.support_report — Verbatim server support report; unsupported traces are not filtered out.
• Figure.validation_reasons — Verbatim server validation reasons.
• Figure.validation_status — Server status, including valid, unsupported or rejected.

FigureCollection

• FigureCollection.clear_preferred — Clear the selected figure, restoring the target's normal graph view.
• FigureCollection.create — Create through createFigure with the same safety checks as publish.
• FigureCollection.delete — Soft-delete a figure and clear its preferred-view pointers.
• FigureCollection.download_original — Download original stored figure content as JSON, optionally writing to path.
• FigureCollection.get — Fetch a saved figure including its JSON and validation report.
• FigureCollection.get_revision — Fetch one immutable revision including its original content.
• FigureCollection.list — List all figures attached to a target, following offset pagination.
• FigureCollection.list_revisions — List immutable revision summaries for a figure.
• FigureCollection.publish — Publish a figure after local safety and live-limit preflight.
• FigureCollection.replace — Replace content after preflight, returning the new immutable revision.
• FigureCollection.set_preferred — Select an attached valid figure; requires dataset:update or notebook:update.
• FigureCollection.support_matrix — Fetch the current renderer support matrix and preflight limits.
• FigureCollection.update — Update the title in place; use replace for content changes.

HarmonizationProposal

• HarmonizationProposal.accept — Explicitly accept this proposal.
• HarmonizationProposal.format — File format hint (e.g. touchstone, csv).
• HarmonizationProposal.id — Stable UUID of this resource.
• HarmonizationProposal.name — Display label: trace → quantity code/id.
• HarmonizationProposal.quantity_code — Candidate Quantity code (denormalized when present).
• HarmonizationProposal.quantity_id — Candidate Quantity UUID.
• HarmonizationProposal.reject — Explicitly reject this proposal.
• HarmonizationProposal.score — Match score in [0, 1] (API may serialize Decimal as string).
• HarmonizationProposal.status — Proposal status: proposed, accepted, or rejected.
• HarmonizationProposal.team_id — Owning team UUID.
• HarmonizationProposal.trace_name — Column / trace name that was proposed for mapping.
• HarmonizationProposal.via — Matcher path: rule, synonym, trigram, or llm.

HarmonizationProposalCollection

• HarmonizationProposalCollection.count — Number of items in the collection (fetches all pages).
• HarmonizationProposalCollection.create — Create a new resource in this collection.
• HarmonizationProposalCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• HarmonizationProposalCollection.first — Return the first item in the collection, or None if empty.
• HarmonizationProposalCollection.list — List mapper proposals, optionally filtered by status.
• HarmonizationProposalCollection.propose — Persist top Quantity candidates for a column name.

Instrument

• Instrument.capture — Trigger a capture on this instrument and wait for completion.
• Instrument.control — Invoke a driver control method via WebSocket.
• Instrument.delete — Delete this instrument registration.
• Instrument.id — Stable UUID of this resource.
• Instrument.mode — Operating mode: 'auto', 'real', or 'simulated'.
• Instrument.model_number — Instrument model number (e.g. 'MSOX3104G', 'N9042B').
• Instrument.name — Display name (title if present, else name).
• Instrument.orb_id — UUID of the orb this instrument is associated with, or None.
• Instrument.serial_number — Hardware serial number.
• Instrument.state — Fetch live instrument state via WebSocket.
• Instrument.status — Connection status: 'connected', 'disconnected', or 'unknown'.
• Instrument.update — Update instrument fields (name, visa_address, mode, etc.).
• Instrument.visa_address — VISA address string (e.g. 'TCPIP::192.168.1.100::INSTR').

Notebook

• Notebook.add_equation — Add an equation to this notebook.
• Notebook.add_measurement — Add a measurement annotation to this notebook.
• Notebook.add_note — Add a note to this notebook.
• Notebook.add_traces — Add dataset traces to this notebook.
• Notebook.clear_preferred_figure — Clear the preferred figure to restore the normal graph (notebook:update).
• Notebook.datasets — Datasets linked to this notebook.
• Notebook.delete — Permanently delete a trashed notebook.
• Notebook.export — Export this notebook.
• Notebook.id — Stable UUID of this resource.
• Notebook.name — Display name (title if present, else name).
• Notebook.restore — Restore notebook from trash.
• Notebook.set_preferred_figure — Select an attached valid figure as this notebook's view (notebook:update).
• Notebook.snapshot — Save a point-in-time snapshot of this notebook.
• Notebook.traces — Fan-out: all traces across all datasets referenced by this notebook.
• Notebook.trash — Move notebook to trash (soft delete). Can be restored later.
• Notebook.update — Update notebook fields (title, description).

Orb

• Orb.connected_instruments — List of instrument connection status dicts.
• Orb.id — Stable UUID of this resource.
• Orb.instruments — Instruments associated with this orb.
• Orb.last_heartbeat — ISO timestamp of the last heartbeat, or None if never seen.
• Orb.name — Display name (title if present, else name).
• Orb.reload_instruments — Ask this orb to reload its instrument list from the backend.
• Orb.serial_number — Hardware serial number.
• Orb.status — Online status: 'online', 'offline', or 'unknown'.

Package

• aperture_gain — Return antenna gain in dBi from area: G = 4 pi efficiency A / wavelength².
• beamwidth_gain — Estimate gain in dBi using beam solid angle ≈ HPBW_E * HPBW_H (radians²).
• cascade_networks — Chain at least two two-port networks in order, returning a new Network.
• cascaded_noise_figure — Return cascaded noise figure in dB using the classical Friis equation.
• cloudscript — Enable CloudScript lineage tracking and SDK run reporting on the default client.
• connect — Connect the process-default client to CloudSprite.
• deembed_network — Remove known two-port fixtures using scikit-rf inverse cascading.
• effective_aperture — Return effective receiving aperture in square metres, G wavelength² / (4 pi).
• free_space_path_loss — Return Friis free-space path loss in dB: 20 log10(4 pi distance / wavelength).
• l_network_match — Synthesize every realizable ideal L-network conjugate match.
• link_budget — Calculate EIRP, received power and fade margin for a free-space link.
• lowpass_filter — Synthesize and scale an ideal passive lowpass circuit from a SciPy prototype.
• monte_carlo_yield — Sample a caller-supplied response and summarize its tolerance/yield distribution.
• params — Proxy for building parameter filter expressions — not a normal value type.
• polarization_mismatch_loss — Return loss in dB between linear polarizations separated by angle_deg.
• publish — Publish computed traces as a new dataset.
• regex — Create a regex pattern for use in bracket notation.
• renormalize_network — Return a copy renormalized to the same real reference impedance at all ports.
• report_run — Post the active cloudscript() run report immediately.
• search — Search across all CloudSprite resources (projects, datasets, notebooks).
• search_traces — Search for traces across all datasets.
• set_org — Set the default org (tenant) for subsequent queries and WebSockets.
• set_project — Set the default project for subsequent queries.
• set_team — Set the default team for subsequent queries.
• single_stub_match — Find single-stub conjugate matches using closed-form transmission-line equations.
• sparameter_metrics — Compute metrics from a Network or local Touchstone path without mutation.
• tdr_step — PNA-style low-pass step TDR of S11 or SDD11.

Parameter

• Parameter.id — Stable UUID of this parameter value, if present.
• Parameter.key — Parameter key title (human-readable name).
• Parameter.value — Parameter value as a string.

ParameterKey

• ParameterKey.delete — Delete this parameter key.
• ParameterKey.id — Stable UUID of this resource.
• ParameterKey.name — Display name (title if present, else name).
• ParameterKey.unit — Unit string for values of this key, or empty if unitless.
• ParameterKey.update — Update parameter key fields.

ParameterTemplate

• ParameterTemplate.delete — Delete this template.
• ParameterTemplate.id — Stable UUID of this resource.
• ParameterTemplate.keys — Key definitions included in this template.
• ParameterTemplate.name — Display name (title if present, else name).
• ParameterTemplate.update — Update template fields.

Project

• Project.add_tag — Attach an existing tag to this project.
• Project.cloudscripts — CloudScripts belonging to this project (beta).
• Project.create_dataset — Create a dataset in this project.
• Project.create_notebook — Create a notebook in this project.
• Project.datasets — Datasets belonging to this project.
• Project.delete — Permanently delete a trashed project.
• Project.id — Stable UUID of this resource.
• Project.name — Display name (title if present, else name).
• Project.notebooks — Notebooks belonging to this project.
• Project.remove_tag — Detach a tag from this project.
• Project.reports — Reports belonging to this project.
• Project.restore — Restore project from trash, including cascade-trashed datasets.
• Project.slug — URL-safe project identifier within its team.
• Project.trash — Move project to trash (soft delete). Cascades to datasets.
• Project.update — Update project fields (title, description, etc.).
• Project.workflows — Workflows belonging to this project (beta).

QCClient

• QCClient.run — Run structural QC for the team (optionally one dataset).
• QCClient.violations — Relationship-violation findings for the default team.

Quantity

• Quantity.canonical_unit — Canonical unit string, or empty if unset.
• Quantity.code — Stable quantity code (e.g. sparam.s21.mag_db).
• Quantity.default_scale — Default scale: linear or dB.
• Quantity.deprecate — Mark this quantity deprecated (staff-only on the server).
• Quantity.id — Stable UUID of this resource.
• Quantity.is_complex — Whether values of this quantity are complex.
• Quantity.name — Display name (title if present, else name).
• Quantity.physical_kind — Physical kind enum value (frequency, voltage, …).
• Quantity.status — Governance status: active or deprecated.
• Quantity.synonyms — Alternate names for this quantity.
• Quantity.team_id — Owning team UUID, or None for a global catalog row.
• Quantity.update — Update team-owned quantity fields.

QuantityStat

• QuantityStat.id — Stable UUID of this resource.
• QuantityStat.mean — Mean of value_number (API may serialize Decimal as string).
• QuantityStat.n — Sample count for value_number rows.
• QuantityStat.name — Display label — quantity code when present, else id.
• QuantityStat.quantity_code — Quantity code (denormalized when present).
• QuantityStat.quantity_id — Linked Quantity UUID.
• QuantityStat.std — Population/sample std of value_number (Decimal may be a string).
• QuantityStat.team_id — Owning team UUID.

QuantityStatCollection

• QuantityStatCollection.count — Number of items in the collection (fetches all pages).
• QuantityStatCollection.create — Create a new resource in this collection.
• QuantityStatCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• QuantityStatCollection.first — Return the first item in the collection, or None if empty.
• QuantityStatCollection.list — List quantity stats for the default team.
• QuantityStatCollection.refresh — Recompute quantity stats for the default team (admin).

Relationship

• Relationship.basis — asserted, modeled, measured, or computed.
• Relationship.confidence — Optional confidence in [0, 1] (API may serialize Decimal as string).
• Relationship.delete — Delete this relationship.
• Relationship.equation_id — Optional linked Equation UUID.
• Relationship.id — Stable UUID of this resource.
• Relationship.name — Display label: subject -[type]-> object.
• Relationship.object_id — Object endpoint UUID.
• Relationship.object_kind — Object endpoint kind: quantity|canonical_signal|derived_quantity|dut.
• Relationship.params — Optional numeric/structured params for quantifiable types.
• Relationship.provenance — Provenance map from the server.
• Relationship.relationship_type_id — RelationshipType UUID.
• Relationship.scope — type or instance.
• Relationship.sealed — When True, server rejects further PATCH/DELETE (HTTP 409).
• Relationship.subject_id — Subject endpoint UUID.
• Relationship.subject_kind — Subject endpoint kind: quantity|canonical_signal|derived_quantity|dut.
• Relationship.team_id — Owning team UUID.
• Relationship.update — Update relationship fields.

RelationshipCollection

• RelationshipCollection.count — Number of items in the collection (fetches all pages).
• RelationshipCollection.create — Create a new resource in this collection.
• RelationshipCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• RelationshipCollection.first — Return the first item in the collection, or None if empty.
• RelationshipCollection.graph — Fetch the team-scoped relationship graph for agents.

RelationshipType

• RelationshipType.category — Optional category label.
• RelationshipType.code — Stable relationship type code (e.g. tracks, derived_from).
• RelationshipType.id — Stable UUID of this resource.
• RelationshipType.is_quantifiable — Whether edges of this type can carry numeric params.
• RelationshipType.name — Display name (title if present, else name).
• RelationshipType.physical — True when the type encodes a physical law/claim.
• RelationshipType.status — Governance status: active or deprecated.
• RelationshipType.symmetry — symmetric, directed, or empty if unset.
• RelationshipType.team_id — Owning team UUID, or None for a global catalog row.

RelationshipViolation

• RelationshipViolation.acknowledge — Acknowledge this open violation (admin).
• RelationshipViolation.dataset_id — Dataset UUID that failed the structural check.
• RelationshipViolation.detail — Server detail map for the finding.
• RelationshipViolation.id — Stable UUID of this resource.
• RelationshipViolation.missing_kind — Which endpoint is missing: subject or object.
• RelationshipViolation.missing_quantity_id — Quantity UUID that was expected but absent.
• RelationshipViolation.name — Display label: dataset + missing kind/quantity.
• RelationshipViolation.relationship_id — Linked Relationship UUID.
• RelationshipViolation.status — open, acknowledged, or resolved.
• RelationshipViolation.team_id — Owning team UUID.

RelationshipViolationCollection

• RelationshipViolationCollection.count — Number of items in the collection (fetches all pages).
• RelationshipViolationCollection.create — Create a new resource in this collection.
• RelationshipViolationCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• RelationshipViolationCollection.first — Return the first item in the collection, or None if empty.
• RelationshipViolationCollection.list — List violations, optionally filtered by status.

Report

• Report.attachments — Files attached to this report.
• Report.body_md — Markdown body. Empty on list rows that omit it.
• Report.id — Stable UUID of this resource.
• Report.latest_version — Latest snapshot number when the API provides one.
• Report.name — Display name (title if present, else name).
• Report.permanent_delete — Permanently delete a trashed report.
• Report.project_id — Owning project UUID.
• Report.publish — Publish this report. Requires report:publish.
• Report.published_at — When the report was published, or None.
• Report.references — Citations on this report.
• Report.restore — Restore this report from trash.
• Report.slug — URL-safe identifier ({prefix}-RPT-{n}) when assigned.
• Report.status — draft or published.
• Report.trash — Move this report to trash (soft delete).
• Report.unpublish — Revert this report to draft.
• Report.update — Patch this report. Stale expected_updated_at yields HTTP 409.
• Report.updated_at — Last-updated timestamp; pass to update as expected_updated_at.
• Report.versions — Version snapshots for this report.

ReportAttachment

• ReportAttachment.content_type — Stored MIME type.
• ReportAttachment.file_url — Presigned download URL when the API provides one.
• ReportAttachment.id — Stable UUID of this resource.
• ReportAttachment.name — Display name (title if present, else name).
• ReportAttachment.report_id — Owning report UUID.
• ReportAttachment.size — File size in bytes.

ReportAttachmentCollection

• ReportAttachmentCollection.delete — Delete an attachment.
• ReportAttachmentCollection.list — List attachments on this report.
• ReportAttachmentCollection.upload — Upload an attachment (multipart/form-data).

ReportBacklink

• ReportBacklink.id — Stable UUID of this resource.
• ReportBacklink.name — Display name (title if present, else name).
• ReportBacklink.project_id — Owning project UUID.
• ReportBacklink.project_title — Owning project title.
• ReportBacklink.slug — Report slug when assigned, else empty.
• ReportBacklink.status — Report status (draft or published).
• ReportBacklink.updated_at — Last-updated timestamp from the API.

ReportCollection

• ReportCollection.backlinks — List reports that cite a dataset or a notebook. Pass exactly one.
• ReportCollection.backlinks_for_dataset — List reports that cite a dataset.
• ReportCollection.backlinks_for_notebook — List reports that cite a notebook.
• ReportCollection.count — Number of items in the collection (fetches all pages).
• ReportCollection.create — Create a report.
• ReportCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• ReportCollection.first — Return the first item in the collection, or None if empty.
• ReportCollection.get — Fetch a report by id or slug.
• ReportCollection.list — List reports in a project.
• ReportCollection.list_team — List published reports the caller can read in a team.
• ReportCollection.list_trashed — List trashed reports for the current team.

ReportReference

• ReportReference.id — Stable UUID of this resource.
• ReportReference.label — Display label for the citation.
• ReportReference.name — Display name (title if present, else name).
• ReportReference.order — Display order within the report.
• ReportReference.slug — Cited resource slug when present.
• ReportReference.source — How the reference was created (extracted or manual).
• ReportReference.target_id — UUID of the cited resource.
• ReportReference.type — Referenced resource kind (dataset, notebook, script, workflow).

ReportReferenceCollection

• ReportReferenceCollection.add — Add a manual reference.
• ReportReferenceCollection.delete — Remove a manual reference.
• ReportReferenceCollection.list — List references on this report.

ReportVersion

• ReportVersion.content_hash — Content hash of the snapshot payload.
• ReportVersion.id — Stable UUID of this resource.
• ReportVersion.message — Optional snapshot message.
• ReportVersion.name — Display name (title if present, else name).
• ReportVersion.payload — Full snapshot body when fetched via ReportVersionCollection.get.
• ReportVersion.report_id — Owning report UUID.
• ReportVersion.version — Monotonic version number (1-based).

ReportVersionCollection

• ReportVersionCollection.create — Commit a new snapshot of the current report body.
• ReportVersionCollection.get — Fetch one snapshot, including payload.
• ReportVersionCollection.list — List snapshots of this report.
• ReportVersionCollection.restore — Restore a snapshot (append-only; does not rewrite history).

Resource

• Resource.id — Stable UUID of this resource.
• Resource.name — Display name (title if present, else name).

ResourceCollection

• ResourceCollection.count — Number of items in the collection (fetches all pages).
• ResourceCollection.create — Create a new resource in this collection.
• ResourceCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• ResourceCollection.first — Return the first item in the collection, or None if empty.

ResultSet

• ResultSet.count — Number of items in this result set.
• ResultSet.filter — Further filter the ResultSet by a parameter expression.
• ResultSet.first — Return the first item, or None if empty.
• ResultSet.to_dataframe — Convert ResultSet to a pandas DataFrame.

SearchResult

• SearchResult.data — Raw response data for this result.
• SearchResult.id — Unique identifier of the matched resource.
• SearchResult.name — Display name/title of the matched resource.
• SearchResult.project_id — Parent project id when provided by the API.
• SearchResult.project_slug — Parent project slug when provided by the API.
• SearchResult.score — Relevance score when returned; None if the API omitted it.
• SearchResult.slug — Resource slug when provided by the API.
• SearchResult.subtitle — API subtitle when provided.
• SearchResult.title — API title; same value as name.
• SearchResult.type — Resource type: 'project', 'dataset', 'notebook', etc.

Tag

• Tag.color — Color hex/name for UI display, or empty if unset.
• Tag.delete — Delete this tag.
• Tag.id — Stable UUID of this resource.
• Tag.name — Display name (title if present, else name).
• Tag.update — Update tag fields (name, color).

TdrStep

• TdrStep.to_traces — Impedance and rho as Trace objects, ready for cs.publish.

Team

• Team.id — Stable UUID of this resource.
• Team.instruments — List instruments associated with this team.
• Team.invite — Invite a user to this team.
• Team.members — List team members.
• Team.name — Display name (title if present, else name).
• Team.orbs — List orbs associated with this team.
• Team.projects — Projects belonging to this team.
• Team.slug — URL-safe team identifier.
• Team.update — Update team fields (name, etc.).

Trace

• Trace.to_network — Convert trace to a scikit-rf Network object.

TraceRef

• TraceRef.dataset — Parent dataset when attached during traversal, else None.
• TraceRef.id — Stable UUID of this resource.
• TraceRef.name — Trace name or source file name.
• TraceRef.to_trace — Materialize this TraceRef into a concrete Trace object.
• TraceRef.x — Independent-axis samples (loads remote data on first access).
• TraceRef.x_unit — Unit of the independent (x) axis.
• TraceRef.y — Dependent-axis samples (loads remote data on first access).
• TraceRef.y_unit — Unit of the dependent (y) axis.

TrashedReport

• TrashedReport.days_remaining — Days until purge, when the API reports it.
• TrashedReport.id — Stable UUID of this resource.
• TrashedReport.name — Display name (title if present, else name).
• TrashedReport.permanent_delete — Permanently delete this trashed report.
• TrashedReport.project_id — Owning project UUID.
• TrashedReport.restore — Restore this report from trash.
• TrashedReport.trashed_at — When the report was moved to trash.

UseCase

• UseCase.code — Stable use-case code (e.g. sparam_s21_qc).
• UseCase.description — Free-text description, or empty if unset.
• UseCase.fit — Check whether a dataset fits this use-case.
• UseCase.id — Stable UUID of this resource.
• UseCase.min_completeness — Minimum dataset completeness in [0, 1] (Decimal may be a string).
• UseCase.name — Display name (title if present, else name).
• UseCase.required_quantity_codes — Quantity codes this use-case expects on a fitting dataset.
• UseCase.required_relationship_type_codes — Relationship type codes this use-case expects.
• UseCase.team_id — Owning team UUID, or None for a global catalog row.

WeakLabel

• WeakLabel.confidence — Optional confidence in [0, 1] (API may serialize Decimal as string).
• WeakLabel.dataset_id — Labeled dataset UUID.
• WeakLabel.id — Stable UUID of this resource.
• WeakLabel.label — pass, fail, or unknown.
• WeakLabel.name — Display label: dataset → pass/fail/unknown.
• WeakLabel.source — relationship_violation or completeness.
• WeakLabel.source_id — Optional source row UUID (e.g. RelationshipViolation id).
• WeakLabel.team_id — Owning team UUID.

WeakLabelCollection

• WeakLabelCollection.count — Number of items in the collection (fetches all pages).
• WeakLabelCollection.create — Create a new resource in this collection.
• WeakLabelCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• WeakLabelCollection.first — Return the first item in the collection, or None if empty.
• WeakLabelCollection.list — List weak labels for the default team.
• WeakLabelCollection.refresh — Rebuild weak labels from QC / completeness (admin).

Workflow

• Workflow.id — Stable UUID of this resource.
• Workflow.is_enabled — True when triggers may fire.
• Workflow.name — Display name (title if present, else name).
• Workflow.project_id — Owning project UUID.
• Workflow.runs — Runs of this workflow.

WorkflowRun

• WorkflowRun.id — Stable UUID of this resource.
• WorkflowRun.name — Display name (title if present, else name).
• WorkflowRun.status — Run status (queued, running, succeeded, failed, …).
• WorkflowRun.workflow_id — Owning workflow UUID.

cloudsprite

• cloudsprite.active_learning — Active-learning inbox for the default team.
• cloudsprite.analysis — Foundry analysis namespace.
• cloudsprite.datasets — Datasets in the default project (requires set_project).
• cloudsprite.derived_quantities — Foundry derived quantities for the default team.
• cloudsprite.dut_resolutions — DUT fuzzy-resolution proposals for the default team.
• cloudsprite.dut_types — Foundry DUT type catalog for the default team.
• cloudsprite.duts — Foundry DUTs for the default team.
• cloudsprite.embeddings — Per-tenant CanonicalSignal embeddings.
• cloudsprite.figures — Publish and manage figures on explicit dataset or notebook targets.
• cloudsprite.harmonization_proposals — Column→Quantity mapper proposals.
• cloudsprite.instruments — Instruments in the default team (requires set_team).
• cloudsprite.manufacturers — List all instrument manufacturers in the catalog.
• cloudsprite.orbs — Orbs in the default team (requires set_team).
• cloudsprite.parameter_keys — Parameter key definitions for the default team.
• cloudsprite.parameter_templates — Parameter templates for the default team.
• cloudsprite.projects — Projects in the default team (requires set_team).
• cloudsprite.qc — Relationship-violation QC namespace.
• cloudsprite.quantities — Foundry quantity catalog for the default team.
• cloudsprite.quantity_stats — Per-tenant DerivedQuantity classical stats.
• cloudsprite.relationship_types — Foundry relationship type catalog for the default team.
• cloudsprite.relationships — Foundry relationships for the default team.
• cloudsprite.reports — Reports in the default project (requires set_team; set_project for listing).
• cloudsprite.supported_models — List all supported instrument models in the catalog.
• cloudsprite.teams — Collection of teams visible to the authenticated user.
• cloudsprite.use_cases — Use-Case Factory catalog for the default team.
• cloudsprite.weak_labels — Weak-supervision labels for the default team.