> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Create canvas

> Create a Canvas.



## OpenAPI

````yaml https://api.vantage.sh/v2/oas_v3.json post /canvases
openapi: 3.0.1
info:
  title: Vantage
  description: Vantage API
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    url: https://www.vantage.sh
    email: support@vantage.sh
  version: 2.0.0
servers:
  - url: https://api.vantage.sh/v2
security:
  - oauth2:
      - read
tags:
  - name: AccessGrants
    description: Operations about AccessGrants
  - name: AnomalyAlerts
    description: Operations about AnomalyAlerts
  - name: AnomalyNotifications
    description: Operations about AnomalyNotifications
  - name: AuditLogs
    description: Operations about AuditLogs
  - name: BillingProfiles
    description: Operations about BillingProfiles
  - name: BillingRules
    description: Operations about BillingRules
  - name: BudgetAlerts
    description: Operations about BudgetAlerts
  - name: Budgets
    description: Operations about Budgets
  - name: BusinessMetrics
    description: Operations about BusinessMetrics
  - name: Canvases
    description: Operations about Canvases
  - name: CostAlertEvents
    description: Operations about CostAlertEvents
  - name: CostAlerts
    description: Operations about CostAlerts
  - name: CostProvider
    description: Operations about CostProviders
  - name: CostProviderAccounts
    description: Operations about CostProviderAccounts
  - name: Costs
    description: Operations about Costs
  - name: CostService
    description: Operations about CostServices
  - name: Dashboards
    description: Operations about Dashboards
  - name: DataExports
    description: Operations about DataExports
  - name: ExchangeRates
    description: Operations about ExchangeRates
  - name: FinancialCommitmentReports
    description: Operations about FinancialCommitmentReports
  - name: FinancialCommitments
    description: Operations about FinancialCommitments
  - name: Folders
    description: Operations about Folders
  - name: Integrations
    description: Operations about Integrations
  - name: Invoices
    description: Operations about Invoices
  - name: KubernetesEfficiencyReports
    description: Operations about KubernetesEfficiencyReports
  - name: ManagedAccounts
    description: Operations about ManagedAccounts
  - name: Me
    description: Operations about Mes
  - name: NetworkFlowReports
    description: Operations about NetworkFlowReports
  - name: OpenAPISpecification
    description: Operations about OpenAPISpecifications
  - name: Ping
    description: Operations about Pings
  - name: Prices
    description: Operations about Prices
  - name: Recommendations
    description: Operations about Recommendations
  - name: RecommendationViews
    description: Operations about RecommendationViews
  - name: ReportNotifications
    description: Operations about ReportNotifications
  - name: ResourceReports
    description: Operations about ResourceReports
  - name: Resources
    description: Operations about Resources
  - name: SavedFilters
    description: Operations about SavedFilters
  - name: Segments
    description: Operations about Segments
  - name: Tags
    description: Operations about Tags
  - name: Teams
    description: Operations about Teams
  - name: UnitCosts
    description: Operations about UnitCosts
  - name: UserFeedback
    description: Operations about UserFeedbacks
  - name: Users
    description: Operations about Users
  - name: VirtualTags
    description: Operations about VirtualTags
  - name: Workspaces
    description: Operations about Workspaces
paths:
  /canvases:
    post:
      tags:
        - Canvases
      summary: Create canvas
      description: Create a Canvas.
      operationId: createCanvas
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCanvas'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Canvas'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
        - oauth2:
            - write
components:
  schemas:
    createCanvas:
      required:
        - prompt
        - title
      type: object
      properties:
        title:
          type: string
          description: The title of the Canvas.
        prompt:
          type: string
          description: The prompt used to generate the Canvas.
        workspace_token:
          type: string
          description: >-
            The token of the Workspace to add the Canvas to. Required if the API
            token is associated with multiple Workspaces.
      description: Create a Canvas.
    Canvas:
      required:
        - created_at
        - prompt
        - title
        - token
        - updated_at
        - workspace_token
      type: object
      properties:
        token:
          type: string
          nullable: false
          example: cnvs_abcd1234567890
        title:
          type: string
          description: The title of the Canvas.
          nullable: false
          example: Weekly Spend by Team
        prompt:
          type: string
          description: The prompt used to generate the Canvas.
          nullable: false
        data:
          $ref: '#/components/schemas/CanvasData'
        workspace_token:
          type: string
          description: The token for the Workspace the Canvas belongs to.
          nullable: false
          example: wrkspc_abcd1234567890
        created_at:
          type: string
          description: >-
            The date and time, in UTC, the Canvas was created. ISO 8601
            Formatted.
          nullable: false
          example: '2024-01-01T00:00:00Z'
        updated_at:
          type: string
          description: >-
            The date and time, in UTC, the Canvas was last updated. ISO 8601
            Formatted.
          nullable: false
          example: '2024-01-01T00:00:00Z'
      description: Canvas model
    Errors:
      required:
        - errors
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        errors:
          type: array
          nullable: false
          items:
            type: string
      description: Errors model
    CanvasData:
      type: object
      properties:
        table:
          $ref: '#/components/schemas/CanvasTable'
        error:
          type: string
          description: Error message if the refresh workflow failed. Read-only.
          nullable: true
    Links:
      type: object
      properties:
        self:
          type: string
          description: The URL of the current page of results.
          nullable: true
        first:
          type: string
          description: The URL of the first page of results.
          nullable: true
        next:
          type: string
          description: The URL of the next page of results, if one exists.
          nullable: true
        last:
          type: string
          description: The URL of the last page of results, if one exists.
          nullable: true
        prev:
          type: string
          description: The URL of the previous page of results, if one exists.
          nullable: true
    CanvasTable:
      type: object
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access

````