{"openapi":"3.1.0","info":{"title":"ServingStudio public API","version":"0.1.0"},"paths":{"/api/public/v1/health":{"get":{"summary":"Health","operationId":"health_api_public_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Api Public V1 Health Get"}}}}}}},"/api/public/v1/models":{"get":{"summary":"Models","description":"Every checkpoint with its public presets, their axes and members.","operationId":"models_api_public_v1_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Models Api Public V1 Models Get"}}}}}}},"/api/public/v1/models/{checkpoint}/{arch}/tree":{"get":{"summary":"Tree","description":"One member's kernels, by section and slot; the query names each axis.","operationId":"tree_api_public_v1_models__checkpoint___arch__tree_get","parameters":[{"name":"checkpoint","in":"path","required":true,"schema":{"type":"string","title":"Checkpoint"}},{"name":"arch","in":"path","required":true,"schema":{"type":"string","title":"Arch"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Tree Api Public V1 Models  Checkpoint   Arch  Tree Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/predict":{"post":{"summary":"Predict","description":"Each case's time on one member, per section and per tree node.","operationId":"predict_api_public_v1_predict_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Predict Api Public V1 Predict Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/kernels":{"get":{"summary":"Catalog","operationId":"catalog_api_public_v1_kernels_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Catalog Api Public V1 Kernels Get"}}}}}}},"/api/public/v1/kernels/{kind}":{"get":{"summary":"Kernel","operationId":"kernel_api_public_v1_kernels__kind__get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","title":"Kind"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Kernel Api Public V1 Kernels  Kind  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/kernels/{kind}/rows":{"get":{"summary":"Rows","description":"Measured rows. Every query parameter except ``format`` filters a column\nby equality: ``gpu``, ``backend`` or any argument of the kind.","operationId":"rows_api_public_v1_kernels__kind__rows_get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","title":"Kind"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/kernels/{kind}/configs":{"get":{"summary":"Configs","operationId":"configs_api_public_v1_kernels__kind__configs_get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","title":"Kind"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Configs Api Public V1 Kernels  Kind  Configs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/kernels/{kind}/configs/{config_id}":{"get":{"summary":"Config","operationId":"config_api_public_v1_kernels__kind__configs__config_id__get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","title":"Kind"}},{"name":"config_id","in":"path","required":true,"schema":{"type":"string","title":"Config Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Config Api Public V1 Kernels  Kind  Configs  Config Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/simulations/presets":{"get":{"summary":"Simulation Presets","description":"Every sim preset: its deployment, pools, axes, the captures its\nmembers replay, and per member what it runs and why it cannot.","operationId":"simulation_presets_api_public_v1_simulations_presets_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Simulation Presets Api Public V1 Simulations Presets Get"}}}}}}},"/api/public/v1/simulate":{"post":{"summary":"Start Simulation","description":"Queue one simulation; read it with ``GET /simulations/{id}``.","operationId":"start_simulation_api_public_v1_simulate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Start Simulation Api Public V1 Simulate Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/workloads":{"get":{"summary":"Workload Sources","description":"Where a simulation's requests can come from: a capture, a generator\n(its arguments) or an upload (the formats it may declare).","operationId":"workload_sources_api_public_v1_workloads_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Workload Sources Api Public V1 Workloads Get"}}}}}},"post":{"summary":"Upload Workload","description":"Keep an uploaded trace (the request body, a CSV) for a day; the\nanswer's ``workload_id`` is a simulation's ``workload.upload``. With no\n``format``, its format and tags are the ones its header fits.","operationId":"upload_workload_api_public_v1_workloads_post","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Upload Workload Api Public V1 Workloads Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/simulations/{simulation_id}":{"get":{"summary":"Simulation","description":"Its status; once done, its summary and the Analyzer's run id.","operationId":"simulation_api_public_v1_simulations__simulation_id__get","parameters":[{"name":"simulation_id","in":"path","required":true,"schema":{"type":"string","title":"Simulation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Simulation Api Public V1 Simulations  Simulation Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Simulation","description":"Cancel it if it has not finished, and remove it.","operationId":"delete_simulation_api_public_v1_simulations__simulation_id__delete","parameters":[{"name":"simulation_id","in":"path","required":true,"schema":{"type":"string","title":"Simulation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Simulation Api Public V1 Simulations  Simulation Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/analyzer/predictions/{prediction_id}/{subject}":{"get":{"summary":"Prediction Subject","description":"The Analyzer's routes for one prediction (``/api/analyzer/v1/predictions/\n{id}/...``): its descriptor, reports and payloads, read only. No catalog:\na reader opens the prediction they made.","operationId":"prediction_subject_api_public_v1_analyzer_predictions__prediction_id___subject__get","parameters":[{"name":"prediction_id","in":"path","required":true,"schema":{"type":"string","title":"Prediction Id"}},{"name":"subject","in":"path","required":true,"schema":{"type":"string","title":"Subject"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/analyzer/runs/{run_id}/{subject}":{"get":{"summary":"Run Subject","description":"The Analyzer's routes for one simulation's run (``/api/analyzer/v1/runs/\n{id}/...``: descriptor, summary, reports, payloads), read only. The run\nid is the ``run_id`` of ``GET /simulations/{id}``. No catalog.","operationId":"run_subject_api_public_v1_analyzer_runs__run_id___subject__get","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"subject","in":"path","required":true,"schema":{"type":"string","title":"Subject"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/analyzer/kernel-kinds":{"get":{"summary":"Kernel Kinds","description":"The Analyzer's ``/api/analyzer/v1/kernel-kinds``, read here from the\nsame DOCs: each kernel kind's title and category, by which a result\nnames and groups its kernels.","operationId":"kernel_kinds_api_public_v1_analyzer_kernel_kinds_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Kernel Kinds Api Public V1 Analyzer Kernel Kinds Get"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Load":{"properties":{"rate":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Rate"},"concurrency":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Concurrency"}},"additionalProperties":false,"type":"object","title":"Load","description":"How hard a simulation drives its requests: ``rate``, the requests (a\nsession trace's sessions) per second they arrive at, the trace's own spacing\nscaled to that mean; or ``concurrency``, every request ready at once and at\nmost this many in flight. A workload with no load replays the trace's own\narrival times."},"PredictRequest":{"properties":{"preset":{"type":"string","title":"Preset"},"params":{"additionalProperties":true,"type":"object","title":"Params"},"cases":{"items":{},"type":"array","title":"Cases"},"analyze":{"type":"boolean","title":"Analyze","default":false}},"type":"object","required":["preset","params","cases"],"title":"PredictRequest","description":"One member of a preset, named by its axis values, and the cases to cost\non it (``/models``' ``case_fields`` give their shape)."},"SimulateRequest":{"properties":{"preset":{"type":"string","title":"Preset"},"params":{"additionalProperties":true,"type":"object","title":"Params"},"workload":{"$ref":"#/components/schemas/Workload"}},"type":"object","required":["preset","params"],"title":"SimulateRequest","description":"One member of a sim preset, named by its axis values\n(``/simulations/presets``), and the workload to run on it."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Workload":{"properties":{"source":{"type":"string","enum":["capture","generated","upload"],"title":"Source","default":"capture"},"capture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capture"},"generator":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Generator"},"upload":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upload"},"load":{"anyOf":[{"$ref":"#/components/schemas/Load"},{"type":"null"}]},"duration_ms":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Duration Ms"},"run_to_end":{"type":"boolean","title":"Run To End","default":true},"accept_rate":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Accept Rate"}},"additionalProperties":false,"type":"object","title":"Workload","description":"What a simulation replays. ``source`` says where its requests come from:\na capture the member offers, a trace ``generator`` draws, or an ``upload``\n(``GET /workloads`` describes both). Every request of the source runs."}}}}