Blueprint Resources

Understanding the resources contained within a blueprint is essential for managing complex AI configurations. The resource list endpoint provides a comprehensive inventory of all components associated with a blueprint, making it easy to audit, manage, and understand the full scope of a blueprint's contents.

Listing Blueprint Resources

The resource list operation retrieves a complete manifest of all resources associated with a specific blueprint. This includes both basic resources (bots, datasets, skillsets, abilities, secrets, files, portals) and integration resources (all types of integrations like widget, Slack, Discord, email, etc.).

To retrieve all resources in a blueprint, make a GET request with the blueprint ID:

GET /api/v1/blueprint/{blueprintId}/resource/list

http

The response provides a structured view of all resources organized by type. Each resource includes its essential properties such as ID, name, description, and any relevant relationship IDs (like datasetId, botId, etc.) that show how resources connect to each other.

Response Structure

The response organizes resources into categories for easy navigation:

  • Basic Resources: bot, dataset, skillset, ability, secret, file, portal
  • Integration Resources: widgetIntegration, slackIntegration, discordIntegration, telegramIntegration, whatsappIntegration, messengerIntegration, twilioIntegration, emailIntegration, triggerIntegration, sitemapIntegration, notionIntegration, extractIntegration, supportIntegration, mcpserverIntegration

Each resource entry includes:

  • id: Unique identifier for the resource
  • name: Display name of the resource
  • description: Detailed description of the resource's purpose
  • Relationship IDs: References to related resources (e.g., a bot might have datasetId and skillsetId)
  • meta: Additional metadata and custom properties

Use Cases

Blueprint Auditing: Review all components to ensure your blueprint contains the expected resources and verify that everything is properly configured.

Pre-Clone Planning: Before cloning a blueprint, examine its resources to understand what will be duplicated and plan for any necessary post-clone configuration.

Dependency Mapping: Identify relationships between resources by examining the relationship IDs, helping you understand how components interact within the blueprint.

Resource Management: Use the resource list as a starting point for bulk operations or selective updates to specific resources within a blueprint.

Documentation: Generate documentation or diagrams showing the structure and composition of your blueprint configurations.

Important: The resource list only includes resources that are specifically associated with the blueprint through their blueprintId field. Resources in your account that are not linked to a blueprint will not appear in this list.

Exporting Blueprint Resources

The export endpoint allows you to download a complete blueprint including all its associated resources in different formats. This is useful for backup, version control, migration between environments, or infrastructure-as-code workflows.

JSON Export (Default)

By default, the export returns a JSON representation of the blueprint with all resources organized by category:

GET /api/v1/blueprint/{blueprintId}/resource/export

http

The JSON response includes the blueprint metadata (name, description, visibility, config, meta) along with all resources grouped into categories: basic resources (bot, dataset, skillset, ability, secret, file, portals), object resources (space), and integration resources (all integration types).

Terraform Export

To export the blueprint as Terraform HCL code, set the Accept header to application/terraform+hcl:

GET /api/v1/blueprint/{blueprintId}/resource/export
Accept: application/terraform+hcl

http

The Terraform export generates a complete .tf file with provider configuration and all resources defined as Terraform resources. Cross-resource references (such as a bot referencing a dataset) are automatically resolved into proper Terraform resource references.

The response includes a Content-Disposition header with a suggested filename based on the blueprint alias or ID.

Go to cbk.ai