Overview
/
Developer Tools
/
API Reference
/
Projects
/
Get metadata and files for a single saved project version.

Get metadata and files for a single saved project version

Billing: No usage charge

Path parameters

  • /{id}

    stringUUID
    //
  • /{version_id}

    stringUUID
    //

Response

  • 200 OK
    • //
      • created_at:

        stringISO-8601,
        //
      • description:

        string,
        //
      • entrypoint_path:

        string,
        //
      • id:

        stringUUID,
        //
      • is_current:

        boolean,
        //
      • parent_version_id:

        stringUUID,
        //
      • preview_url:

        string,
        //
      • project_toml_path:

        string,
        //
      • title:

        string,
        //
      • ancestry_status:

        "root"+2â–¾
        • //The first version of a new project, with no parent.
          "root"
        • //The version has a recorded parent relationship.
          "recorded"
        • //The version's parent was not recorded.
          "legacy_unknown"
        ,
        //
      • :

        [[ ... ],
        //
        • //
          • byte_size:

            numberint64,
            //
          • content_type:

            string,
            //
          • created_at:

            stringISO-8601,
            //
          • id:

            stringUUID,
            //
          • relative_path:

            string,
            //
          • sha256:

            string,
            //
          • sort_order:

            numberint64,
            //
          • updated_at:

            stringISO-8601,
            //
          • file_role:

            "project_toml"+2â–¾
            • //The root `project.toml` manifest.
              "project_toml"
            • //A project source file such as `.kcl`.
              "project_file"
            • //A preview image generated or uploaded for the gallery.
              "preview_image"
            //
          }
        ]
      • preview_status:

        "pending"+2â–¾
        • //A preview has not been generated yet.
          "pending"
        • //The preview is available for display.
          "ready"
        • //Preview generation failed and needs attention.
          "failed"
        //
      }

Examples

get
/user/projects/{id}/versions/{version_id}
200 OK
Response