Login user
Authenticate user and return access token.
Parameters
username : str
User's username provided via form data
password : str
User's password provided via form data
Returns
TokenResponse
Response containing access_token, token_type, and username
Raises
HTTPException
401 if authentication fails due to incorrect username or password
Authorizations
Bearer token authentication. Use the access_token from login response.
Request Body
Responses
Successful Response
Register a new user (admin only)
Register a new user account (admin only).
Parameters
user_data : UserCreate
User registration data including username, password, and optional display_name
current_user : User
Current authenticated admin user
auth_service : AuthService
The auth service instance
Returns
UserWithToken
Newly created user information including access_token
Raises
HTTPException
403 if the current user is not an admin
400 if the username is already registered
Authorizations
Request Body
Responses
Successful Response
Get current user
Get current authenticated user information.
Parameters
current_user : User
Current authenticated user injected via dependency
Returns
User
Current user's profile information
Authorizations
Responses
Successful Response
Update current user profile
Update the current user's editable profile fields.
Authorizations
Request Body
Responses
Successful Response
Logout user
Change user password
Change the current user's password.
Parameters
password_data : PasswordChange
Contains current_password and new_password
current_user : User
Current authenticated user injected via dependency
auth_service : AuthService
The auth service instance
Returns
dict[str, str]
Success message confirming password change
Authorizations
Request Body
Responses
Successful Response
Reset user password (admin only)
Reset a user's password (admin only).
Parameters
password_data : PasswordReset
Contains the target username
admin : User
Current authenticated admin user
auth_service : AuthService
The auth service instance
Returns
PasswordResetResponse
Generated temporary password, returned only in this response
Authorizations
Request Body
Responses
Successful Response
admin
Operations
Reload configuration caches
List all users
List all users in the system (admin only).
Authorizations
Parameters
Query Parameters
0100Responses
Successful Response
Get user details
Get detailed information about a specific user (admin only).
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Update user settings
Update user settings (admin only).
Authorizations
Parameters
Path Parameters
Request Body
Responses
Successful Response
Delete user
Bulk import users from CSV
Create users from a CSV file and return generated temporary passwords.
Authorizations
Request Body
"binary"Responses
Successful Response
List all projects
List all projects in the system (admin only).
Authorizations
Parameters
Query Parameters
0100Responses
Successful Response
Delete project
List project members
List all members of a project (admin only).
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Add member to project
Add a member to a project (admin only).
Authorizations
Parameters
Path Parameters
Request Body
Responses
Successful Response
Remove member from project
Remove a member from a project (admin only).
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Create project for user
Create a default project for a user who doesn't have one (admin only).
Authorizations
Parameters
Path Parameters
Responses
Successful Response
projects
Operations
List user's projects
List all projects the user has access to.
Authorizations
Responses
Successful Response
Create a new project
Create a new project with the current user as owner.
Authorizations
Request Body
Responses
Successful Response
Get project details
Get details of a specific project.
Authorizations
Parameters
Path Parameters
Project identifier
Responses
Successful Response
Delete project
Update project
Update project settings. Owner only.
Authorizations
Parameters
Path Parameters
Project identifier
Request Body
Responses
Successful Response
List project members
List active members of a project.
Authorizations
Parameters
Path Parameters
Project identifier
Responses
Successful Response
Invite a member
Invite a user to the project. Owner only.
Authorizations
Parameters
Path Parameters
Project identifier
Request Body
Responses
Successful Response
Remove member
Update member role
Update a member's role. Owner only.
Authorizations
Parameters
Path Parameters
Project identifier
Request Body
Responses
Successful Response
Transfer project ownership
Transfer project ownership to another user. Admin only.
Authorizations
Parameters
Path Parameters
Request Body
Responses
Successful Response
Get a calibration figure by its path
Fetch a calibration figure by its file path.
Retrieves a PNG image file from the server's filesystem and returns it
as a streaming response.
Parameters
path : str
Absolute file path to the calibration figure image
Returns
FileResponse
PNG image data as a file response with media type "image/png"
Raises
HTTPException
404 if the file does not exist at the specified path
Authorizations
Bearer token authentication. Use the access_token from login response.
Parameters
Query Parameters
Responses
Successful Response
Download a calibration artifact by its path
Download calibration artifacts as a ZIP archive
Download multiple figure JSON and raw NetCDF artifacts as one ZIP file.
Authorizations
Bearer token authentication. Use the access_token from login response.
Parameters
Query Parameters
1100Responses
Successful Response
Preview a NetCDF calibration artifact
Return a size-limited table preview of a NetCDF calibration artifact.
Authorizations
Bearer token authentication. Use the access_token from login response.
Parameters
Query Parameters
Responses
Successful Response
Get the execution lock status
Fetch the current status of the execution lock.
The execution lock prevents concurrent calibration workflows from running
simultaneously. This endpoint checks whether a lock is currently held.
Parameters
ctx : ProjectContext
Project context with user and project information
execution_service : ExecutionService
Service for execution operations
Returns
ExecutionLockStatusResponse
Response containing lock status (True if locked, False if available)
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Check resource availability without starting an execution
Read project-scoped hardware conflicts; this does not reserve resources.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
List executions
List executions for a given chip with pagination, optionally for one calendar day.
Parameters
ctx : ProjectContext
Project context with user and project information
execution_service : ExecutionService
Service for execution operations
chip_id : str
ID of the chip to fetch executions for
skip : int
Number of items to skip (default: 0)
limit : int
Number of items to return (default: 20, max: 100)
Returns
ListExecutionsResponse
Wrapped list of executions for the chip
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID to filter executions
Number of items to skip
00Number of items to return
100120Only executions started on this day, YYYYMMDD
IANA time zone that defines the day for date
"UTC"Responses
Successful Response
Count executions per day or per 6-hour slot
Count executions per bucket, by status, over a trailing window.
With chip_id only that chip's executions count; without it, every execution in the
caller's current project counts. Executions of other projects are never included.
Every bucket of the window is returned, empty ones included, so a chart can draw a
continuous axis. Buckets follow wall-clock time in timezone so they match what the
user sees: one per calendar day ending today, or with granularity=6h four per day
(local 00:00, 06:00, 12:00, 18:00) ending with the slot that contains the current time.
Each bucket carries its start and exclusive end.
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID to count executions for; omit to count every chip in the project
Trailing window in calendar days
365130IANA time zone used to assign executions to buckets
"UTC"Bucket length: day (default) or 6h. 6h returns days x 4 buckets and accepts at most 31 days
"day""6h""day"Responses
Successful Response
Get an execution by its ID
Return the execution detail by its ID.
Parameters
execution_id : str
ID of the execution to fetch
ctx : ProjectContext
Project context with user and project information
execution_service : ExecutionService
Service for execution operations
Returns
ExecutionResponseDetail
Detailed execution information
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Cancel a running or scheduled execution
Cancel a running or scheduled execution via Prefect.
Sends a cancellation request to Prefect for the specified flow run.
The flow_run_id is the Prefect flow run UUID, which can be obtained from
the execution detail's note.flow_run_id field.
Only executions in SCHEDULED, PENDING, RUNNING, or PAUSED state can be cancelled.
Parameters
flow_run_id : str
Prefect flow run UUID
ctx : ProjectContext
Project context with user and project information
execution_service : ExecutionService
Service for execution operations
Returns
CancelExecutionResponse
Cancellation result with status
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Download file
Download a raw data file from the server.
Parameters
path : str
Absolute file path to the file to download
Returns
FileResponse
The file as a downloadable response
Authorizations
Parameters
Query Parameters
Responses
Successful Response
Download file or directory as zip
Download a file or directory as a ZIP archive.
Parameters
path : str
Absolute path to the file or directory to archive
Returns
FileResponse
ZIP archive as a downloadable response
Authorizations
Parameters
Query Parameters
Responses
Successful Response
Get file tree of the config directory
Get config file content for editing
Save config file content
Get an image from the config directory
Validate file content (YAML/JSON)
Get Git status of the config directory
Pull the latest config from its Git repository
Open a pull request with the config changes
agent-session
Operations
Create an agent session
Create a bounded authorization scope for a user-operated local agent.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get an agent session
Get authoritative state for an agent session.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Evaluate an agent candidate
Evaluate a numeric candidate against session-owned bounds without writing it.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List agent actions
List the ordered audit trail for an agent session.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Submit an agent action
Authorize and audit an action proposal without executing it.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List agent action candidates
Read candidates and provenance from an action's authoritative task result.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Commit an agent action candidate
Commit a revalidated task-result candidate into QDash calibration state.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Commit the final agent candidate set
Validate a final candidate set and persist it with one Qubit save.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Get an agent candidate set commit
Get one audited final candidate-set commit.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get an agent candidate commit
Get commit persistence and worker-side backend apply state.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Apply an agent candidate commit to the backend
Dispatch a committed, gated candidate to the worker-side backend.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Get an agent action
Get one action and its current dispatch status.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Execute an authorized agent action
Dispatch one authorized run-task action to the system workflow.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
calibration
Operations
Retry Calibration Github Sync
Publish current mapped YAML for a completed manual edit without changing DB values.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get the calibration note
Get the latest calibration note for the master task.
Retrieves the most recent calibration note from the database, sorted by timestamp
in descending order. The note contains metadata about calibration parameters
and configuration.
Parameters
ctx : ProjectContext
Project context with user and project information
calibration_service : CalibrationService
Service for calibration operations
Returns
CalibrationNoteResponse
The latest calibration note containing username, execution_id, task_id,
note content, and timestamp
Raises
HTTPException
404 if no calibration note is found
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Import seed parameters from qubex or manual input
Import initial calibration parameters from qubex params or manual input.
This endpoint allows importing seed parameters that are typically loaded
from qubex's params directory (e.g., qubit_frequency, readout_amplitude)
into QDash's calibration database for tracking and provenance.
Parameters
ctx : ProjectContext
Project context with user and project information
service : SeedImportService
Service for seed import operations
request : SeedImportRequest
Import request specifying source, chip_id, and parameters
Returns
SeedImportResponse
Results of the import operation including counts and individual results
Examples
Import from qubex params:
{
"chip_id": "64Qv3",
"source": "qubex_params",
"parameters": ["qubit_frequency", "readout_amplitude"]
}
Manual import:
{
"chip_id": "64Qv3",
"source": "manual",
"manual_data": {
"qubit_frequency": {"Q00": 7.9, "Q01": 8.6}
}
}
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get available seed parameters for a chip
Get list of available parameter files in qubex params directory.
Parameters
ctx : ProjectContext
Project context with user and project information
service : SeedImportService
Service for seed import operations
chip_id : str
Chip ID to check parameters for
Returns
list[str]
List of available parameter names (e.g., ["qubit_frequency", "readout_amplitude"])
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Compare YAML seed values with QDash values
Compare seed parameter values from YAML files with current QDash values.
This endpoint allows users to preview what will be imported and see
the difference between YAML source values and current QDash values.
Parameters
ctx : ProjectContext
Project context with user and project information
service : SeedImportService
Service for seed import operations
chip_id : str
Chip ID to compare parameters for
parameters : str | None
Comma-separated list of parameters to compare (None = all available)
Returns
dict
Comparison data with structure:
{
"chip_id": str,
"parameters": {
"param_name": {
"unit": str,
"qubits": {
"Q0": {
"yaml_value": float | None,
"qdash_value": float | None,
"status": "new" | "same" | "different"
}
}
}
}
}
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Responses
Successful Response
Manually update calibration parameters
Manually update calibration parameters for a qubit or coupling.
Updates the specified parameters in the database and records provenance.
The target type (qubit vs coupling) is determined by the qid format:
"0" for qubit, "0-1" for coupling.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Delete a current calibration parameter
Delete one current qubit or coupling value without deleting its history.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get manual edits for a qubit or coupling
Get the most recent manual edit for each parameter of a qid.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Step types, tasks, and spec schema for writing a calibration pipeline
Everything an agent needs to compose a spec: step types with their
dependencies and default tasks, the backend's tasks by type, and the JSON
schema of the spec.
Authorizations
Parameters
Header Parameters
Query Parameters
Responses
Successful Response
Check a calibration pipeline spec without running it
Dry run: reports every problem with a path into the spec, and the
resolved steps and tasks when it would run.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Validate and run a calibration pipeline spec
Runs the spec as one execution through the worker's calibration-pipeline
deployment. A spec with problems is rejected with 422 and the same problem
list that /validate returns.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
copilot
Operations
Get Copilot configuration
Get Copilot configuration for the metrics assistant.
Retrieves the Copilot configuration from YAML, including:
- enabled: Whether Copilot is enabled
- chat_models: The planner models the UI offers
- evaluation_models: The calibration evaluation model
Returns
dict[str, Any]
Copilot configuration dictionary
Authorizations
Responses
Successful Response
List the current user's chat sessions
Return all persisted chat sessions owned by the current user.
Authorizations
Responses
Successful Response
Create a new chat session
Create a new chat session owned by the current user.
Authorizations
Request Body
Responses
Successful Response
Get a chat session with messages
Return one chat session including the full message list.
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Delete a chat session
Update a chat session
Update title, context, or messages of an existing chat session.
Authorizations
Parameters
Path Parameters
Request Body
Responses
Successful Response
List the source trees the Copilot can read
QDash and allowlisted dependency source served read-only, with known revisions.
Authorizations
Responses
Successful Response
Search the source the Copilot can read
Literal search in file contents or file paths; read-only and size-limited.
Authorizations
Parameters
Query Parameters
1200"^(content|path)$""content"false200150Responses
Successful Response
Read a line range of a source file
Read up to 400 numbered lines; without root the path is matched as a traceback prints it.
Authorizations
Parameters
Query Parameters
150011Responses
Successful Response
Get the current user's Copilot preferences
Update the current user's Copilot preferences
Show what QDash tells the chat model
Get settings
Get settings from the server
Authorizations
Responses
Successful Response
chip
Operations
List all chips
List all chips with summary information.
Returns chip metadata (id, size, topology, qubit/coupling counts).
For detailed qubit/coupling data, use the dedicated endpoints.
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Create a new chip
Create a new chip in the current project.
Besides the database records, this creates <chip_id>/ in the Qubex
configuration tree (system_id == chip_id) unless config.create is
false or the directory already exists. Wiring and hardware files are copied
from config.source_system_id when given; parameter files always start
from QDash's templates. config.preset writes a complete virtual
configuration instead; the fake preset is accepted only when the
deployment backend is fake and the chip uses the preset's topology.
Parameters
request : CreateChipRequest
Chip creation request containing chip_id, size and configuration options
ctx : ProjectContext
Project context with editor permission
scaffolder : ChipConfigScaffolder
Writer of the chip's configuration directory
Returns
CreateChipResponse
Created chip information and the configuration outcome
Raises
HTTPException
If chip_id already exists, size is invalid, or the configuration
source cannot be used
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
List systems a new chip can copy wiring from
List the systems in the Qubex configuration tree that have a wiring file.
QDash runs every chip with system_id == chip_id, so each entry is also a
chip directory of the tree.
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Get chip details
Get chip details including metadata and counts.
Returns chip metadata (size, topology, qubit/coupling counts).
For detailed qubit/coupling data, use the dedicated endpoints.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
ChipResponse
Chip details
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Delete a chip (refuses if related data exists unless force=true)
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
If true, also delete the chip's qubits and couplings (history retained for audit).
falseResponses
Successful Response
Update chip metadata (topology_id, note)
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Preview what would be affected by deleting this chip
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get available dates for a chip
Fetch available dates for a chip from execution counter.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
ChipDatesResponse
List of available dates
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get multiplexer details
Get the multiplexer details.
Parameters
chip_id : str
ID of the chip
mux_id : int
ID of the multiplexer
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
MuxDetailResponse
Multiplexer details
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
List all multiplexers for a chip
List all multiplexers for a chip.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
ListMuxResponse
List of multiplexer details
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get chip note
Upsert chip note
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Request Body
Responses
Successful Response
Clear chip note
List qubits for a chip
List qubits for a chip with pagination.
Retrieves qubit data from the separate QubitDocument collection.
Supports filtering by specific qubit IDs.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
limit : int
Maximum number of qubits to return (default 50, max 256)
offset : int
Number of qubits to skip for pagination
qids : list[str] | None
Optional list of specific qubit IDs to fetch
Returns
ListQubitsResponse
List of qubits with pagination info
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
25615000Responses
Successful Response
Get a single qubit
Get a single qubit by ID.
This is 10-18x faster than fetching the full chip and extracting one qubit.
Parameters
chip_id : str
ID of the chip
qid : str
ID of the qubit
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
QubitResponse
Qubit data
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Re-run resonator spectroscopy analysis on a stored task result (preview)
Re-run the resonator-spectroscopy analysis on a previously stored figure.
Returns the marked figure and the re-estimated readout_frequency for
the requested qubit. The DB is not mutated; this is a preview only.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Re-run qubit spectroscopy analysis on a stored task result (preview)
Re-run the qubit-spectroscopy analysis on a previously stored figure.
Returns the marked figure and the re-estimated qubit_frequency,
f01_repr_db, f01_quality_level, and qubit_anharmonicity for the requested
qubit. The DB is not mutated; this is a preview only.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List couplings for a chip
List couplings for a chip with pagination.
Retrieves coupling data from the separate CouplingDocument collection.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
limit : int
Maximum number of couplings to return (default 100, max 512)
offset : int
Number of couplings to skip for pagination
Returns
ListCouplingsResponse
List of couplings with pagination info
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
512110000Responses
Successful Response
Get a single coupling
Get a single coupling by ID.
Parameters
chip_id : str
ID of the chip
coupling_id : str
ID of the coupling (e.g., "0-1")
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
CouplingResponse
Coupling data
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get aggregated metrics summary
Get aggregated metrics summary for a chip.
Computes statistics (averages, counts) on the database side.
Returns ~0.1KB of data, ideal for dashboard overview.
Parameters
chip_id : str
ID of the chip
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
MetricsSummaryResponse
Aggregated metrics summary
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get heatmap data for a single metric
Get heatmap data for a single metric.
Returns only the values needed for heatmap visualization (~5KB).
Much more efficient than fetching full chip data (~300KB+).
Supported metrics:
- Qubit: t1, t2_echo, t2_star, qubit_frequency, qubit_anharmonicity,
average_readout_fidelity, x90_gate_fidelity, x180_gate_fidelity - Coupling: zx90_gate_fidelity, bell_state_fidelity, static_zz_interaction,
qubit_qubit_coupling_strength
Coupling strength is stored, returned, and displayed in MHz.
Parameters
chip_id : str
ID of the chip
metric : str
Name of the metric to retrieve
ctx : ProjectContext
Project context with user and project information
chip_service : ChipService
Service for chip operations
Returns
MetricHeatmapResponse
Metric values keyed by qubit/coupling ID
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
List all tasks
List all tasks.
Parameters
ctx : ProjectContext
The project context with user and project information.
service : TaskService
The task service instance.
backend : str | None
Optional backend name to filter tasks by.
Returns
ListTaskResponse
The list of tasks.
Authorizations
Parameters
Header Parameters
Query Parameters
Optional backend name to filter tasks by
Responses
Successful Response
Execute a single task from the task catalog
Execute one task without requiring a previous execution snapshot.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Get task result by task ID
Get task result by task_id.
Parameters
task_id : str
The task ID to search for.
ctx : ProjectContext
The project context with user and project information.
service : TaskService
The task service instance.
Returns
TaskResultResponse
The task result information including figure paths.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
List all task knowledge entries
List all available task knowledge entries with summary info.
Authorizations
Responses
Successful Response
Get raw markdown for a task knowledge entry
Get raw markdown content for a task knowledge entry.
Returns the task.md content with image references replaced
by inline base64 data URIs for self-contained rendering.
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Download a task's knowledge directory as a zip
The task's task.md, examples and figures, zipped under <task_name>/.
The zip is the starting point of a knowledge draft: edit it locally and
upload it from the evaluation dialog. Raises 404 when the task has no
knowledge directory.
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Preview the prompts an AI evaluation of a task would send
The prompts the evaluation model would receive for a task.
The Agent Runtime builds them the way a direct evaluation does, from the
task's reference in Knowledge, or from an uploaded draft, and its labeled
examples when asked, as the requesting user, without a figure or a model
call.
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Lay out the task's labeled examples, as an in-context evaluation
falseBuild the prompts from this uploaded knowledge draft
Responses
Successful Response
Get task knowledge for LLM analysis
Get structured domain knowledge for a calibration task.
Returns LLM-oriented knowledge including physical principles,
expected behavior, evaluation criteria, and failure modes.
Parameters
task_name : str
The task name (e.g. "CheckT1", "CheckRabi").
service : TaskService
The task service instance.
backend : str
The backend name (default "qubex").
Returns
TaskKnowledgeResponse
Structured task knowledge.
Authorizations
Parameters
Path Parameters
Query Parameters
Backend name
"qubex"Responses
Successful Response
Get task file settings
Get task file settings from config/app/settings.yaml.
Returns
Task file settings including default backend
Authorizations
Responses
Successful Response
List available task file backends
Get backend configuration
Get backend configuration from config/app/backend.yaml.
Returns
Backend configuration
Authorizations
Responses
Successful Response
List all tasks in a backend
List all task definitions found in a backend directory.
Args:
backend: Backend name (e.g., "qubex", "fake")
sort_order: Sort order for tasks
enabled_only: If True, only return tasks that are enabled
Returns:
List of task information
Authorizations
Parameters
Query Parameters
falseResponses
Successful Response
task-result
Operations
List task results
List task results for cross-task investigation.
Authorizations
Parameters
Header Parameters
Query Parameters
Task status filter
Chip ID filter
Task name filter
Qubit or coupling ID filter
Execution ID filter
Username filter
Inclusive start time lower bound
Inclusive start time upper bound
Case-insensitive message search
Number of rows to skip
00Maximum rows to return
100150Responses
Successful Response
Get latest qubit task results
Get the latest qubit task results for all qubits on a chip.
Retrieves the most recent task result for each qubit on the specified chip.
Results include fidelity threshold status based on x90 gate fidelity.
Parameters
chip_id : str
ID of the chip to fetch results for
task : str
Name of the task to fetch results for
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
LatestTaskResultResponse
Task results for all qubits, keyed by qubit ID
Raises
ValueError
If the chip is not found for the current project
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID
Task name
Responses
Successful Response
Get historical qubit task results
Get historical qubit task results for a specific date.
Retrieves task results from a specific historical date using chip history
snapshots. Results are filtered to tasks executed within the specified
day in JST timezone.
Parameters
chip_id : str
ID of the chip to fetch results for
task : str
Name of the task to fetch results for
date : str
Date in YYYYMMDD format (JST timezone)
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
LatestTaskResultResponse
Historical task results for all qubits, keyed by qubit ID
Raises
ValueError
If the chip history is not found for the specified date
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID
Task name
Date in YYYYMMDD format
Inclusive start time lower bound
Exclusive end time upper bound
Responses
Successful Response
Get qubit task history
Get complete task history for a specific qubit.
Retrieves all historical task results for a specific qubit, sorted by
end time in descending order. Useful for tracking calibration trends
over time.
Parameters
qid : str
Qubit ID to fetch history for
chip_id : str
ID of the chip containing the qubit
task : str
Name of the task to fetch history for
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
TaskHistoryResponse
All historical task results, keyed by task_id
Raises
ValueError
If the chip is not found for the current project
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Chip ID
Task name
Responses
Successful Response
Get latest coupling task results
Get the latest coupling task results for all couplings on a chip.
Retrieves the most recent task result for each coupling (qubit pair) on
the specified chip. Results include fidelity threshold status based on
Bell state fidelity.
Parameters
chip_id : str
ID of the chip to fetch results for
task : str
Name of the task to fetch results for
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
LatestTaskResultResponse
Task results for all couplings, keyed by coupling ID (e.g., "0-1")
Raises
ValueError
If the chip is not found for the current project
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID
Task name
Responses
Successful Response
Get historical coupling task results
Get historical coupling task results for a specific date.
Retrieves task results from a specific historical date using chip history
snapshots. Results are filtered to tasks executed within the specified
day in JST timezone.
Parameters
chip_id : str
ID of the chip to fetch results for
task : str
Name of the task to fetch results for
date : str
Date in YYYYMMDD format (JST timezone)
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
LatestTaskResultResponse
Historical task results for all couplings, keyed by coupling ID
Raises
ValueError
If the chip history is not found for the specified date
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID
Task name
Date in YYYYMMDD format
Inclusive start time lower bound
Exclusive end time upper bound
Responses
Successful Response
Get coupling task history
Get complete task history for a specific coupling.
Retrieves all historical task results for a specific coupling (qubit pair),
sorted by end time in descending order. Useful for tracking two-qubit
calibration trends over time.
Parameters
coupling_id : str
Coupling ID to fetch history for (e.g., "0-1")
chip_id : str
ID of the chip containing the coupling
task : str
Name of the task to fetch history for
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
Returns
TaskHistoryResponse
All historical task results, keyed by task_id
Raises
ValueError
If the chip is not found for the current project
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Chip ID
Task name
Responses
Successful Response
Get timeseries task results by tag and parameter
Get timeseries task results filtered by tag and parameter.
Retrieves time series data for calibration parameters, optionally filtered
to a specific qubit. Useful for plotting parameter trends over time.
Parameters
chip_id : str
ID of the chip to fetch results for
tag : str
Tag to filter tasks by (e.g., calibration category)
parameter : str
Name of the output parameter to retrieve
start_at : str
Start time in ISO format for the time range
end_at : str
End time in ISO format for the time range
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
qid : str | None
Optional qubit ID to filter results to a specific qubit
Returns
TimeSeriesData
Time series data keyed by qubit ID, each containing a list of
parameter values with timestamps
Authorizations
Parameters
Header Parameters
Query Parameters
Chip ID
Parameter name
Start time in ISO format
End time in ISO format
Tag to filter by
Optional qubit ID to filter by
Responses
Successful Response
Re-execute a single task from its task result
Re-execute a single task using the system single-task-executor deployment.
Looks up the TaskResultHistoryDocument to extract task_name, qid, chip_id,
execution_id, and tags, then delegates to FlowService to create a Prefect
flow run via the system deployment.
Parameters
task_id : str
The task result ID to re-execute
ctx : ProjectContext
Project context with user and project information
service : TaskResultService
Injected task result service
flow_service : FlowService
Injected flow service
Returns
ExecuteFlowResponse
Execution result with IDs and URLs
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Toggle exclusion of a task result from metrics aggregations
Toggle the excluded flag on a task result.
Excluded measurements are skipped when aggregating metrics for the
dashboard / metrics screens. Raw data is preserved.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Download multiple figures as a ZIP file
Download multiple calibration figures as a ZIP file.
Creates a ZIP archive on temporary storage and serves it without retaining
the completed archive in API worker memory.
Parameters
body.paths : list[str]
List of absolute file paths to the calibration figures
body.filename : str
Filename for the ZIP archive (default: "figures.zip")
Returns
FileResponse
ZIP archive streamed from a temporary file
Raises
HTTPException
400 if no paths are provided or if any path does not exist
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
evaluation
Operations
List calibration evaluation runs
List runs of the project, newest first.
Authorizations
Parameters
Header Parameters
Query Parameters
Only runs on this chip
Only runs of this task
Newest runs to return
200120Responses
Successful Response
Start a bulk calibration evaluation run
Queue the latest evaluable result of a task for every entity on a chip.
The evaluations run in the background as the requesting user; poll the run
for progress. Entities without an evaluable result are reported as skipped.
With knowledge_draft_id the run reads that uploaded draft instead of the
task's shared knowledge.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get a calibration evaluation run
One run with every evaluation, including what the model saw and answered.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Retry unfinished calibration evaluations
Reset failed, interrupted or cancelled items and execute them again.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Cancel a calibration evaluation run
Cancel evaluations in this run that have not completed.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
List evaluations of a task result
Every evaluation of one task result across runs, newest first.
Authorizations
Parameters
Header Parameters
Query Parameters
Task result ID
Responses
Successful Response
Judge a calibration evaluation
Record whether a person agrees with an evaluation; null agree and no note clears it.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Get a snapshotted evaluation figure
Upload a task-knowledge draft to evaluate against
Store one task's knowledge directory, zipped, as a draft of the project.
The draft is parsed by the knowledge repository's own generator and is
read only by the evaluation runs and prompt previews that name it; the
shared knowledge does not change. Uploading the same zip again returns
the stored draft.
Authorizations
Parameters
Header Parameters
Request Body
"binary"Responses
Successful Response
Get a task-knowledge draft
The draft's task, uploader, generator warnings and derived reference.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Get a task-knowledge draft as task knowledge
The draft in the shape of GET /tasks/{name}/knowledge, for the Agent Runtime.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Download the zip a task-knowledge draft was uploaded as
forum
Operations
List forum categories
List forum categories for the active project.
Authorizations
Parameters
Header Parameters
Query Parameters
Include archived categories
falseResponses
Successful Response
Create a forum category
Create a forum category. Only project owners can manage categories.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Archive a forum category
Archive a forum category. Existing threads keep their category key.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Update a forum category
Update a forum category. Only project owners can manage categories.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List forum labels
Create a forum label
Create a forum label. Only project owners and editors can manage labels; the key is server-generated.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Delete a forum label
Delete a forum label. Only project owners and editors can manage labels.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Update a forum label
Update a forum label. Only project owners and editors can manage labels.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List forum threads
List root forum threads for the active project.
Authorizations
Parameters
Header Parameters
Query Parameters
Number of items to skip
00Max items to return
200150Filter by category key
Filter by thread label
Filter by linked chip ID
Filter by linked target type
Filter by linked target ID
Filter by linked cool-down ID
Only threads about this task result
Filter by project-scoped forum thread number
Filter by workflow status. Default open; 'all' lists every status.
"open"Search title, content, number, target, assignee, or status
Responses
Successful Response
Create a forum thread or reply
Create a new project forum thread or reply.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get a forum post
Get a forum post by ID.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Delete a forum post
Update a forum post
Update a forum post, or update root-thread metadata as a project editor.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List forum replies
List replies for a forum thread.
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Number of replies to skip
00Max replies to return
2001100Responses
Successful Response
Upload an image for a forum post
Close a forum thread
Reopen a forum thread
List all tags
List all tags for the current project.
Retrieves all tags associated with the current project's calibration data.
Tags are used to categorize and filter task results.
Parameters
ctx : ProjectContext
Project context with user and project information
tag_repo : MongoTagRepository
Repository for tag operations
Returns
ListTagResponse
Wrapped list of tag names
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Get the device topology
Get the device topology.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get the device topology plot
Get the device topology as a PNG image.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
flow
Operations
List all flows
List all Flows for the current project.
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Save a flow
Save a Flow to file system and MongoDB.
By default the save creates the flow or overwrites an existing one. With
create_only it only creates a new flow, and an existing name returns 409
without changing the stored flow.
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
List all flow templates
List the flow templates, optionally filtered to one backend.
Authorizations
Parameters
Query Parameters
Only templates written for this backend, e.g. qubex or fake
Responses
Successful Response
Get a flow template
Get flow template details including code content.
Authorizations
Parameters
Path Parameters
Responses
Successful Response
List flow helper files
Get flow helper file content
List all flow schedules for current project
List all Flow schedules (cron and one-time) for the current project.
Authorizations
Parameters
Header Parameters
Query Parameters
500Responses
Successful Response
Delete a flow schedule
Delete a Flow schedule (cron or one-time).
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Update a flow schedule
Update a Flow schedule (cron schedules only).
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Get flow details
Get Flow details including code content.
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Delete a flow
Execute a flow
Execute a Flow via Prefect deployment.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Move a flow to another folder
Change the folder a Flow is filed under; its code and deployment are untouched.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Schedule a flow execution (cron or one-time)
Schedule a Flow execution with cron or one-time schedule.
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List schedules for a specific flow
List all schedules (cron and one-time) for a specific Flow.
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
500Responses
Successful Response
Get metrics configuration
Get metrics metadata configuration for visualization.
Retrieves the metrics configuration loaded from YAML, including display
metadata for all qubit and coupling metrics used in the dashboard.
Returns
dict[str, Any]
Dictionary with metrics configuration including:
- qubit_metrics: Metadata for single-qubit metrics (frequency, T1, T2, fidelities)
- coupling_metrics: Metadata for two-qubit coupling metrics (ZX90, Bell state)
- color_scale: Color scale configuration for heatmap visualization
Authorizations
Responses
Successful Response
Get Chip Metrics
Get chip calibration metrics for visualization.
This endpoint returns calibration metrics for a specific chip from the database, including:
- Qubit frequency, qubit anharmonicity, T1, T2 echo times
- Gate fidelities (single-qubit and two-qubit)
- Readout fidelities
Args:
chip_id: The chip identifier
ctx: Project context with user and project information
metrics_service: Injected metrics service
within_hours: Optional filter to only include data from last N hours (e.g., 24)
selection_mode: "latest" to get most recent values, "best" to get optimal values
start_at: Optional absolute lower bound (ISO8601 or date)
end_at: Optional absolute upper bound (ISO8601 or date)
Returns:
ChipMetricsResponse with all metrics data
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Filter to data within N hours (e.g., 24)
Selection mode: 'latest' for most recent, 'best' for optimal, 'average' for mean values
"latest""best""average""latest"Inclusive absolute lower bound on task start time (ISO8601 or date). Takes precedence over within_hours for the lower bound.
Inclusive absolute upper bound on task start time (ISO8601 or date).
Responses
Successful Response
Get Qubit Metric History
Get historical metric data for a specific qubit with task_id for figure display.
This endpoint queries TaskResultHistoryDocument to retrieve calibration
history for a specific metric, including multiple executions on the same day.
Each history item includes task_id for displaying calibration figures.
Args:
chip_id: The chip identifier
qid: The qubit identifier (e.g., "0", "Q00")
ctx: Project context with user and project information
metrics_service: Injected metrics service
metric: Metric name to retrieve history for
limit: Maximum number of history items (None for unlimited within time range)
within_days: Optional filter to only include data from last N days
Returns:
QubitMetricHistoryResponse with historical metric data and task_ids
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Metric name (e.g., t1, qubit_frequency)
Max number of history items (None for unlimited)
Filter to last N days
30Responses
Successful Response
Get Coupling Metric History
Get historical metric data for a specific coupling with task_id for figure display.
This endpoint queries TaskResultHistoryDocument to retrieve calibration
history for a specific coupling metric, including multiple executions on the same day.
Each history item includes task_id for displaying calibration figures.
Args:
chip_id: The chip identifier
coupling_id: The coupling identifier (e.g., "0-1", "2-3")
ctx: Project context with user and project information
metrics_service: Injected metrics service
metric: Metric name to retrieve history for
limit: Maximum number of history items (None for unlimited within time range)
within_days: Optional filter to only include data from last N days
Returns:
QubitMetricHistoryResponse with historical metric data and task_ids
(Note: qid field contains coupling_id for coupling metrics)
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Metric name (e.g., zx90_gate_fidelity, bell_state_fidelity)
Max number of history items (None for unlimited)
Filter to last N days
30Responses
Successful Response
Download metrics as PDF report
Download chip metrics as a PDF report.
Generates a comprehensive PDF report containing:
- Cover page with chip information and report metadata
- Heatmap visualizations for each metric
- Statistics for each metric (coverage, average, min, max, std dev)
The report includes all qubit metrics (8 types) and coupling metrics (3 types)
that have data available.
Args:
chip_id: Chip identifier
within_hours: Optional time filter in hours
selection_mode: "latest" for most recent values, "best" for optimal values
start_at: Optional absolute lower bound (ISO8601 or date)
end_at: Optional absolute upper bound (ISO8601 or date)
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Filter to data within N hours
Selection mode: 'latest', 'best', or 'average'
"latest""best""average""latest"Inclusive absolute lower bound on task start time (ISO8601 or date).
Inclusive absolute upper bound on task start time (ISO8601 or date).
Responses
PDF report file
note
Operations
Upsert the general note for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Clear the general note for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Create a target summary note entry for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Update a target summary note entry for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Delete a target summary note entry for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Upsert a per-metric note for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Delete a per-metric note for a qubit
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Upsert the general note for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Clear the general note for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Create a target summary note entry for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Update a target summary note entry for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Delete a target summary note entry for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Upsert a per-metric note for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Request Body
Responses
Successful Response
Delete a per-metric note for a coupling
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Get the user note for a task result
Upsert the user note for a task result
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Clear the user note for a task result
List all notes (qubit / coupling / task-result) on a chip
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
Optional explicit cool-down scope identifier
Optional time-range scope start
Optional time-range scope end
Responses
Successful Response
Chip-scoped note edit timeline
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
00200150Responses
Successful Response
Per-target note edit timeline
Authorizations
Parameters
Header Parameters
Query Parameters
Note scope
"^(qubit|qubit_metric|coupling|coupling_metric|task_result)$"qid / coupling_id / task_id
00200150Responses
Successful Response
Full-text search across note contents
Authorizations
Parameters
Header Parameters
Query Parameters
Free-text search query
100200150Responses
Successful Response
List current user's notifications
List notifications addressed to the current user.
Authorizations
Parameters
Header Parameters
Query Parameters
Only return unread notifications
false00200150Responses
Successful Response
Get unread notification count
Mark a notification as read
Mark one notification as read.
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Mark all notifications as read
List all cryostats
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Create a cryostat
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get a cryostat by id
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Delete a cryostat
Update a cryostat
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List cool-downs (optionally filter by cryostat or chip)
Authorizations
Parameters
Header Parameters
Query Parameters
Filter by cryostat
Filter by chip membership
Responses
Successful Response
Create a cool-down
Authorizations
Parameters
Header Parameters
Request Body
Responses
Successful Response
Get a cool-down by id
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Delete a cool-down
Update a cool-down
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
Assign a chip to a cool-down
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
Unassign a chip from a cool-down
Authorizations
Parameters
Header Parameters
Path Parameters
Responses
Successful Response
cooldown-wiring
Record a wiring change checkpoint within a cool-down
Authorizations
Parameters
Header Parameters
Path Parameters
Request Body
Responses
Successful Response
List wiring change history for a cool-down
Authorizations
Parameters
Header Parameters
Path Parameters
Query Parameters
500110000Responses
Successful Response
List available topologies
List all available topology definitions.
Args:
size: Optional filter by number of qubits
Returns:
dict: List of topology summaries with id, name, and num_qubits
Authorizations
Parameters
Query Parameters
Responses
Successful Response
Get topology by ID
Get a specific topology definition.
Args:
topology_id: Topology identifier (e.g., "square-lattice-mux-64")
Returns:
dict: Complete topology definition with qubits and couplings
Authorizations
Parameters
Path Parameters
Responses
Successful Response
Get all configuration
Fetch all application configuration in a single request
Authorizations
Responses
Successful Response
Get a parameter version by entity ID
Get a specific parameter version by entity ID.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
entity_id : str
Entity identifier (format: parameter_name:qid:execution_id:task_id)
Returns
ParameterVersionResponse
Parameter version details
Raises
HTTPException
404 if entity not found
Authorizations
Parameters
Header Parameters
Path Parameters
Entity identifier
Responses
Successful Response
Get lineage (ancestors) of a parameter version
Get the lineage (ancestors) of a parameter version.
Traverses wasDerivedFrom and wasGeneratedBy relations backward
to find all entities and activities that contributed to this entity.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
entity_id : str
Entity identifier to trace lineage from
max_depth : int
Maximum traversal depth (1-20)
Returns
LineageResponse
Lineage graph with nodes and edges
Authorizations
Parameters
Header Parameters
Path Parameters
Entity identifier
Query Parameters
Maximum traversal depth
2015Responses
Successful Response
Get impact (descendants) of a parameter version
Get the impact (descendants) of a parameter version.
Traverses wasDerivedFrom relations forward to find all entities
that were derived from this entity.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
entity_id : str
Entity identifier to trace impact from
max_depth : int
Maximum traversal depth (1-20)
Returns
ImpactResponse
Impact graph with affected nodes and edges
Authorizations
Parameters
Header Parameters
Path Parameters
Entity identifier
Query Parameters
Maximum traversal depth
2015Responses
Successful Response
Compare parameter values between two executions
Compare parameter values between two executions.
Shows which parameters were added, removed, or changed between
two calibration executions.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
execution_id_before : str
First execution ID (before state)
execution_id_after : str
Second execution ID (after state)
Returns
ExecutionComparisonResponse
Comparison of parameter values
Authorizations
Parameters
Header Parameters
Query Parameters
First execution ID (before)
Second execution ID (after)
Responses
Successful Response
Get version history for a parameter
Get version history for a parameter.
Returns all versions of a parameter for a specific qubit,
sorted by version number (newest first).
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
parameter_name : str
Name of the parameter (e.g., "qubit_frequency")
qid : str
Qubit or coupling identifier (e.g., "Q0", "Q0-Q1")
limit : int
Maximum number of versions to return
Returns
ParameterHistoryResponse
List of parameter versions
Authorizations
Parameters
Header Parameters
Query Parameters
Name of the parameter
Qubit or coupling identifier
Maximum number of versions
100150Responses
Successful Response
Get provenance statistics
Get provenance statistics for a project.
Returns counts and recent entities for provenance tracking.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
Returns
ProvenanceStatsResponse
Provenance statistics
Authorizations
Parameters
Header Parameters
Responses
Successful Response
Get recent execution IDs
Get recent unique execution IDs.
Returns unique execution IDs sorted by most recent first.
Uses MongoDB aggregation for efficient retrieval.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
limit : int
Maximum number of execution IDs to return (1-50)
Returns
RecentExecutionsResponse
List of recent execution IDs
Authorizations
Parameters
Header Parameters
Query Parameters
Maximum number of execution IDs to return
50120Responses
Successful Response
Get recent parameter changes with delta
Get recent parameter changes with delta from previous versions.
Returns parameter changes that have a previous version, showing
the delta (difference) from the previous value.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
limit : int
Maximum number of changes to return (1-50)
within_hours : int
Time window in hours (1-168, default: 24)
parameter_names : list[str] | None
Filter by parameter names (e.g., from metrics.yaml config)
Returns
RecentChangesResponse
List of recent parameter changes with delta information
Authorizations
Parameters
Header Parameters
Query Parameters
Maximum number of changes to return
50120Time window in hours
168124Filter by parameter names (from metrics config)
Responses
Successful Response
Get degradation trends (consecutive worsening)
Get parameters with consecutive degradation across calibration versions.
Detects parameters where the value has been consistently worsening
(based on evaluation mode: maximize/minimize) over multiple versions.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
min_streak : int
Minimum consecutive worsening steps (3-20, default: 3)
limit : int
Maximum number of trends to return (1-100, default: 50)
parameter_names : list[str] | None
Filter by parameter names
Returns
DegradationTrendsResponse
Detected degradation trends sorted by severity
Authorizations
Parameters
Header Parameters
Query Parameters
Minimum consecutive worsening steps
2033Maximum number of trends to return
100150Filter by parameter names
Responses
Successful Response
Get recalibration task recommendations
Get recommended recalibration tasks based on parameter change impact.
When a calibration parameter changes (either through recalibration or
manual adjustment), this endpoint analyzes the provenance graph to
identify which downstream parameters are affected and recommends
which calibration tasks should be re-run.
The recommendations are prioritized based on dependency proximity:
tasks producing directly dependent parameters are ranked higher than
those producing transitively dependent parameters.
Parameters
ctx : ProjectContext
Project context with user and project information
service : ProvenanceService
Provenance service instance
entity_id : str
Entity identifier of the changed parameter
max_depth : int
Maximum traversal depth for impact analysis (1-20)
Returns
RecalibrationRecommendationResponse
Prioritized list of recommended recalibration tasks
Example
If qubit_frequency for Q0 changes:
- Priority 1: CheckRabiOscillation (direct dependency)
- Priority 2: CheckT1, CheckT2 (use frequency-dependent pulses)
- Priority 3: CheckCrossResonance (uses derived gate parameters)
Authorizations
Parameters
Header Parameters
Path Parameters
Entity identifier of changed parameter
Query Parameters
Maximum impact traversal depth
20110Responses
Successful Response