FastSim
◎ 中文
← Server REST API  /  discovery
HTTPv1

Discovery & run information

Current Server Discovery & run information surface; paths, methods, status codes and handler signatures come directly from 0.8.4 source.

Source packages/fastsim-plugin-server/src/fastsim_plugin_server/application.py
capabilitieslaunch_statusserver_logsprocess_metricsplugin_eventsplugin_statusplugin_instance_statusscenario_summaryscenario_behaviorscenario_evaluationscenario_scenescenario_sourcestate

Endpoints 13

GET/api/v1/capabilitiescapabilities
200dict[str, object]

Capabilities

Handlercapabilities
Signatureasync capabilities() -> JSONResponse
SourceL2190
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/capabilities
GET/api/v1/launchlaunch_status
200dict[str, object]

Launch status

Handlerlaunch_status
Signatureasync launch_status() -> JSONResponse
SourceL2252
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/launch
GET/api/v1/logsserver_logs
200dict[str, object]

Return bounded, redacted operator events without opening a cold Run.

Handlerserver_logs
Signatureasync server_logs(after_sequence: int=Query(default=0, ge=0, le=2 ** 63 - 1), limit: int=Query(default=200, ge=1, le=500), wait_s: float=Query(default=0.0, ge=0.0, le=30.0)) -> JSONResponse
SourceL2501
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/logs
GET/api/v1/metrics/processprocess_metrics
200dict[str, object]

Process metrics

Handlerprocess_metrics
Signatureasync process_metrics() -> JSONResponse
SourceL2197
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/metrics/process
GET/api/v1/plugins/eventsplugin_events
200dict[str, object]

Plugin events

Handlerplugin_events
Signatureasync plugin_events(after_sequence: int=Query(default=0, ge=0, le=2 ** 63 - 1), limit: int=Query(default=100, ge=1, le=200), instance: str | None=Query(default=None, min_length=1, max_length=128, pattern=_ENTITY_PATTERN), topic: str | None=Query(default=None, min_length=1, max_length=128, pattern='^[A-Za-z0-9_.:-]+$')) -> JSONResponse
SourceL2467
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/plugins/events
GET/api/v1/plugins/statusplugin_status
200dict[str, object]

Plugin status

Handlerplugin_status
Signatureasync plugin_status() -> JSONResponse
SourceL2435
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/plugins/status
GET/api/v1/plugins/{instance}/statusplugin_instance_status
200dict[str, object]

Plugin instance status

Handlerplugin_instance_status
Signatureasync plugin_instance_status(instance: str=Path(min_length=1, max_length=128, pattern=_ENTITY_PATTERN)) -> JSONResponse
SourceL2444
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/plugins/{instance}/status
GET/api/v1/scenarioscenario_summary
200dict[str, object]

Scenario summary

Handlerscenario_summary
Signatureasync scenario_summary() -> JSONResponse
SourceL2388
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scenario
GET/api/v1/scenario/behaviorscenario_behavior
200dict[str, object]

Scenario behavior

Handlerscenario_behavior
Signatureasync scenario_behavior() -> JSONResponse
SourceL2420
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scenario/behavior
GET/api/v1/scenario/evaluationscenario_evaluation
200dict[str, object]

Scenario evaluation

Handlerscenario_evaluation
Signatureasync scenario_evaluation() -> JSONResponse
SourceL2427
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scenario/evaluation
GET/api/v1/scenario/scenescenario_scene
200dict[str, object]

Scenario scene

Handlerscenario_scene
Signatureasync scenario_scene() -> JSONResponse
SourceL2413
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scenario/scene
GET/api/v1/scenario/sourcescenario_source
200dict[str, object]

Scenario source

Handlerscenario_source
Signatureasync scenario_source() -> JSONResponse
SourceL2406
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scenario/source
GET/api/v1/statestate
200dict[str, object]

State

Handlerstate
Signatureasync state() -> JSONResponse
SourceL2638
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/state