Spaces:
Sleeping
Sleeping
File size: 20,127 Bytes
4f4d659 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 | {
"openapi": "3.1.0",
"info": {
"title": "OpenEnv Environment HTTP API",
"description": "\n# OpenEnv Environment HTTP API\n\nHTTP API for interacting with OpenEnv environments through a standardized interface.\n\n## Features\n\n* **Environment Reset**: Initialize or restart episodes\n* **Action Execution**: Send actions and receive observations\n* **State Inspection**: Query current environment state\n* **Schema Access**: Retrieve JSON schemas for actions and observations\n\n## Workflow\n\n1. Call `/reset` to start a new episode and get initial observation\n2. Call `/step` repeatedly with actions to interact with environment\n3. Episode ends when observation returns `done: true`\n4. Call `/state` anytime to inspect current environment state\n\n## Documentation\n\n* **Swagger UI**: Available at `/docs`\n* **ReDoc**: Available at `/redoc`\n* **OpenAPI Schema**: Available at `/openapi.json`\n ",
"contact": {
"name": "OpenEnv Team",
"url": "https://github.com/meta-pytorch/OpenEnv"
},
"license": {
"name": "BSD-3-Clause",
"url": "https://github.com/meta-pytorch/OpenEnv/blob/main/LICENSE"
},
"version": "1.0.0"
},
"paths": {
"/reset": {
"post": {
"tags": [
"Environment Control"
],
"summary": "Reset the environment",
"description": "Reset the environment to its initial state and return the first observation.\n\nYou can optionally provide a seed for reproducibility and an episode_id for tracking.",
"operationId": "reset_reset_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetRequest"
}
}
}
},
"responses": {
"200": {
"description": "Environment reset successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetResponse"
},
"example": {
"observation": {
"status": "ready",
"data": {}
},
"done": false
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/step": {
"post": {
"tags": [
"Environment Control"
],
"summary": "Execute an action in the environment",
"description": "Execute an action in the environment and receive the resulting observation.\n\nThe action must conform to the environment's action schema, which can be\nretrieved from the `/schema` endpoint. If the action is invalid,\nthe endpoint will return HTTP 422 with detailed validation errors.\n\nThe response includes:\n- **observation**: The environment's response to the action\n- **reward**: Optional reward signal (float or None)\n- **done**: Boolean indicating if the episode has terminated",
"operationId": "step_step_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StepRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Action executed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StepResponse"
},
"example": {
"observation": {
"status": "success",
"data": {}
},
"reward": 1.0,
"done": false
}
}
}
},
"422": {
"description": "Validation error - invalid action format or values",
"content": {
"application/json": {
"example": {
"detail": [
{
"type": "string_too_short",
"loc": [
"body",
"action",
"message"
],
"msg": "String should have at least 1 character",
"input": ""
}
]
}
}
}
},
"500": {
"description": "Internal server error during action execution"
}
}
}
},
"/state": {
"get": {
"tags": [
"State Management"
],
"summary": "Get current environment state",
"description": "Retrieve the current internal state of the environment.\n\nThe structure of the state object is defined by the environment's State model.",
"operationId": "endpoint_state_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/State"
}
}
}
}
}
}
},
"/metadata": {
"get": {
"tags": [
"Environment Info"
],
"summary": "Get environment metadata",
"description": "Get metadata about this environment.\n\nReturns information about the environment including name, description,\nversion, author, and documentation links.",
"operationId": "endpoint_metadata_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMetadata"
}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Health"
],
"summary": "Health check",
"description": "Check if the environment server is running and healthy.",
"operationId": "endpoint_health_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
}
}
}
}
}
}
},
"/schema": {
"get": {
"tags": [
"Schema"
],
"summary": "Get all JSON schemas",
"description": "Get JSON schemas for actions, observations, and state in a single response.\n\nReturns a combined schema object containing:\n- **action**: JSON schema for actions accepted by this environment\n- **observation**: JSON schema for observations returned by this environment\n- **state**: JSON schema for environment state objects\n\nThis is more efficient than calling individual schema endpoints and provides\nall schema information needed to interact with the environment.",
"operationId": "get_schemas_schema_get",
"responses": {
"200": {
"description": "Combined schemas retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaResponse"
},
"example": {
"action": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"observation": {
"type": "object",
"properties": {
"response": {
"type": "string"
}
}
},
"state": {
"type": "object",
"properties": {
"step_count": {
"type": "integer"
}
}
}
}
}
}
}
}
}
},
"/mcp": {
"post": {
"summary": "Mcp Endpoint",
"description": "MCP JSON-RPC endpoint for production mode.\n\nBypasses step() overhead and provides direct access to MCP tools.\nSupports tools/list and tools/call methods.",
"operationId": "mcp_endpoint_mcp_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"type": "object",
"title": "Response Mcp Endpoint Mcp Post"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"EnvironmentMetadata": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the environment"
},
"description": {
"type": "string",
"title": "Description",
"description": "Description of what the environment does"
},
"readme_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Readme Content",
"description": "Content of the README file for the environment"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version",
"description": "Version of the environment"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Author",
"description": "Author of the environment"
},
"documentation_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Documentation Url",
"description": "URL to the environment's documentation"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description"
],
"title": "EnvironmentMetadata",
"description": "Metadata about an environment for documentation and UI purposes."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HealthResponse": {
"properties": {
"status": {
"$ref": "#/components/schemas/HealthStatus",
"description": "Health status of the environment server",
"default": "healthy"
}
},
"additionalProperties": false,
"type": "object",
"title": "HealthResponse",
"description": "Response model for health check endpoint."
},
"HealthStatus": {
"type": "string",
"enum": [
"healthy",
"unhealthy",
"degraded"
],
"title": "HealthStatus",
"description": "Server health status values."
},
"ResetRequest": {
"properties": {
"seed": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Seed",
"description": "Random seed for reproducible episodes"
},
"episode_id": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Episode Id",
"description": "Custom episode identifier"
}
},
"additionalProperties": true,
"type": "object",
"title": "ResetRequest",
"description": "Request model for environment reset.",
"examples": [
{
"episode_id": "episode-001",
"seed": 42
},
{}
]
},
"ResetResponse": {
"properties": {
"observation": {
"additionalProperties": true,
"type": "object",
"title": "Observation",
"description": "Initial observation from the environment"
},
"reward": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reward",
"description": "Initial reward (typically None at reset)"
},
"done": {
"type": "boolean",
"title": "Done",
"description": "Whether episode is already done (typically False)",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"observation"
],
"title": "ResetResponse",
"description": "Response model for environment reset."
},
"SchemaResponse": {
"properties": {
"action": {
"additionalProperties": true,
"type": "object",
"title": "Action",
"description": "JSON schema for actions accepted by this environment"
},
"observation": {
"additionalProperties": true,
"type": "object",
"title": "Observation",
"description": "JSON schema for observations returned by this environment"
},
"state": {
"additionalProperties": true,
"type": "object",
"title": "State",
"description": "JSON schema for environment state objects"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"action",
"observation",
"state"
],
"title": "SchemaResponse",
"description": "Response model for the combined schema endpoint."
},
"State": {
"properties": {
"episode_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Episode Id",
"description": "Unique identifier for the current episode"
},
"step_count": {
"type": "integer",
"minimum": 0.0,
"title": "Step Count",
"description": "Number of steps taken in the current episode",
"default": 0
}
},
"additionalProperties": true,
"type": "object",
"title": "State",
"description": "Base class for environment state.\n\nRepresents internal environment state, separate from observations."
},
"StepRequest": {
"properties": {
"action": {
"additionalProperties": true,
"type": "object",
"title": "Action",
"description": "Action to execute, must conform to environment's action schema"
},
"timeout_s": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Timeout S",
"description": "Optional timeout in seconds for action execution"
},
"request_id": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Request Id",
"description": "Optional request identifier for tracking"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"action"
],
"title": "StepRequest",
"description": "Request model for environment step.",
"examples": [
{
"action": {
"value": 1
},
"timeout_s": 30.0
},
{
"action": {
"value": 1
},
"render": true,
"verbose": false
}
]
},
"StepResponse": {
"properties": {
"observation": {
"additionalProperties": true,
"type": "object",
"title": "Observation",
"description": "Observation resulting from the action"
},
"reward": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reward",
"description": "Reward signal from the action"
},
"done": {
"type": "boolean",
"title": "Done",
"description": "Whether the episode has terminated",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"observation"
],
"title": "StepResponse",
"description": "Response model for environment step."
},
"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"
}
}
},
"tags": [
{
"name": "Environment Control",
"description": "Core operations for environment interaction (reset, step)"
},
{
"name": "State Management",
"description": "Operations for inspecting environment state"
},
{
"name": "Environment Info",
"description": "Information about the environment"
},
{
"name": "Schema",
"description": "JSON Schema endpoints for actions, observations, and state"
},
{
"name": "Health",
"description": "Service health and status checks"
}
]
} |