Blueprint
Blueprint-Lifecycle

Get a Blueprint.

Changed on

Get the details of a previously created Blueprint including the build status.

get/v1/blueprints/{id}

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/blueprints/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the Blueprint

Response

OK

idstring required

The id of the Blueprint.

namestring required

The name of the Blueprint.

status'queued' | 'provisioning' | 'building' | 'awaiting_upload' | 'failed' | 'build_complete' required

The status of the Blueprint build.

queued: Blueprint is queued waiting for build capacity to become available. provisioning: Allocating and booting the necessary infrastructure resources to create the Blueprint image. building: Building the Blueprint image. awaiting_upload: Blueprint is created and awaiting its image to be pushed out-of-band via docker push. failed: Blueprint image failed to build. See the logs on the dashboard. build_complete: Blueprint image completed build. You can now use the ID to create Devboxes.

state'created' | 'deleted' required
create_time_msinteger required

Creation time of the Blueprint (Unix timestamp milliseconds).

build_finish_time_msinteger nullable

Build completion time of the Blueprint (Unix timestamp milliseconds).

failure_reason'out_of_memory' | 'out_of_disk' | 'build_failed'

The cause of the failure of the Blueprint build.

out_of_memory: The build has run out of memory. Contact support if this is unexpected. out_of_disk: The build has run out of disk. Contact support if this is unexpected. build_failed: The build has failed. Use the dashboard to look at Blueprint build logs for more info.

base_blueprint_idstring nullable

The ID of the base Blueprint.

is_publicboolean

Whether this Blueprint is publicly accessible to all users.

metadataobject nullable

User defined metadata associated with the blueprint.

devbox_capabilitiesDevboxCapabilities[] nullable

Capabilities that will be available on Devbox.

Changes

  • e9dc776053e4Revision changes
    • warning

      added the new awaiting_upload enum value to the response property for the response status

  • b4ffb9a8aff3Revision changes
    • info

      added the optional property ////// to the response with the status