For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
OverviewCodaControlAPI ReferenceChangelog
OverviewCodaControlAPI ReferenceChangelog
  • Coda API
  • Control API
      • GETList Agents
      • POSTRun Agent
  • Stanza API
    • stanza
    • cli
    • context
    • device
    • exceptions
    • models
    • pyvisa
    • registry
    • timing
    • utils
LogoLogo
Control APIAgents

Run Agent

POST
https://api.conductorquantum.com/v0/agents/:agent_id
POST
/v0/agents/:agent_id
1import base64
2from conductorquantum import ConductorQuantum
3
4client = ConductorQuantum(
5    token="YOUR_TOKEN",
6)
7
8with open("calibration_plot.png", "rb") as f:
9    image_b64 = base64.b64encode(f.read()).decode()
10
11result = client.control.agents.run(
12    "ising-calibration-v1",
13    body={
14        "image_base64": image_b64,
15        "prompt": "Analyse this Rabi oscillation plot.",
16        "max_tokens": 256,
17    },
18)
19print(result)
1{}
Run an agent by its string ID. The request body depends on the agent. For `ising-calibration-v1`, send a JSON body with: - `image_base64` (required): base64-encoded PNG or JPEG image of a calibration plot (must be RGB / 3-channel). - `prompt` (optional): custom prompt to guide the analysis. - `max_tokens` (optional): maximum tokens in the response. The agent returns a structured assessment including what the experiment shows, whether it succeeded, extracted parameters, and recommended next steps. See the [Ising Calibration guide](/control/agents) for details.
Was this page helpful?
Built with

Run an agent by its string ID. The request body depends on the agent.

For ising-calibration-v1, send a JSON body with:

  • image_base64 (required): base64-encoded PNG or JPEG image of a calibration plot (must be RGB / 3-channel).
  • prompt (optional): custom prompt to guide the analysis.
  • max_tokens (optional): maximum tokens in the response.

The agent returns a structured assessment including what the experiment shows, whether it succeeded, extracted parameters, and recommended next steps. See the Ising Calibration guide for details.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agent_idstringRequired
The string ID of the agent to run.

Request

This endpoint expects a map from strings to any.

Response

Agent execution result (shape depends on the agent)

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
502
Bad Gateway Error
503
Service Unavailable Error