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

# Create Sheet

> Create an unsolved sheet for any template. Set inputs with `PATCH /v1/sheets/{sheetId}` and solve with `POST /v1/sheets/{sheetId}/solve` — or use `POST /v1/templates/{code}/calculate` to create and solve in one call. The [Sheet Lifecycle guide](/templates/sheets-lifecycle) walks all four steps on one calculation.



## OpenAPI

````yaml api/openapi.json POST /v1/templates/{code}/sheets
openapi: 3.1.0
info:
  title: Connections Hub API
  version: 1.0.0
  description: >-
    Run HSS Connections Hub calculators programmatically: create projects,
    create and solve sheets from any calculator template, run batches, and
    export reports to PDF.


    All endpoints require API key authentication.
servers:
  - url: https://api.calcs.com
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Create and manage calculation projects. Each user can have multiple
      projects to organize their calculations.
  - name: Sheets
    description: >-
      Manage individual calculation sheets — read one back, update its inputs,
      solve or re-solve it, and delete single sheets or clean up many at once.
  - name: Templates
    description: >-
      Run calculations using any enabled template. Supports all calculator types
      without requiring endpoint-specific code.
paths:
  /v1/templates/{code}/sheets:
    post:
      tags:
        - Sheets
      summary: Create Sheet
      description: >-
        Create an unsolved sheet for any template. Set inputs with `PATCH
        /v1/sheets/{sheetId}` and solve with `POST /v1/sheets/{sheetId}/solve` —
        or use `POST /v1/templates/{code}/calculate` to create and solve in one
        call. The [Sheet Lifecycle guide](/templates/sheets-lifecycle) walks all
        four steps on one calculation.
      operationId: create-template-sheet
      parameters:
        - name: Authorization
          in: header
          required: true
          example: Bearer YOUR_KEY_HERE
          schema:
            type: string
          description: >-
            The `Authorization` header is used to authenticate with the API
            using your API key. Value is of the format `Bearer YOUR_KEY_HERE`.
        - name: code
          in: path
          required: true
          schema:
            type: string
          description: Template code (e.g., steelConnectionHssBeamToHssMomentAISC360-22)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - projectId
              properties:
                projectId:
                  type: string
                  description: >-
                    Project UUID to create the sheet in. Accepted in canonical,
                    uppercase, braced, or unhyphenated form, as on `POST
                    /v1/templates/{code}/calculate`; the response echoes the
                    canonical form.
                name:
                  type: string
                  description: Optional name for the created sheet
      responses:
        '201':
          description: The unsolved sheet was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SheetCreateResponse'
        '400':
          description: The request body is not valid JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                malformed_json:
                  summary: Request body is not valid JSON
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid JSON in request body.
        '401':
          description: Unauthorized — missing or invalid API key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: >-
            The template or the project does not exist, or is not accessible
            with this API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                template_not_found:
                  summary: >-
                    Template does not exist, or is not accessible with this API
                    key
                  value:
                    error:
                      code: NOT_FOUND
                      message: Template not found.
                project_not_found:
                  summary: >-
                    Project does not exist, or is not accessible with this API
                    key
                  value:
                    error:
                      code: NOT_FOUND
                      message: Project not found.
        '422':
          description: >-
            The request body is semantically invalid — an unrecognized top-level
            field, `projectId` missing or not a UUID, or `name` present but not
            a non-empty string. Also returned when the project is archived and
            cannot take a new sheet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                missing_project_id:
                  summary: projectId is missing
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: projectId is required.
                      details:
                        - field: projectId
                          message: projectId is required.
                unknown_field:
                  summary: An unrecognized top-level field
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: 'Unknown field: nmae. Allowed fields: projectId, name.'
                      details:
                        - field: nmae
                          message: nmae is not a recognized field.
      security:
        - api_key: []
components:
  schemas:
    SheetCreateResponse:
      type: object
      description: >-
        An unsolved sheet created from a template. Set inputs with `PATCH
        /v1/sheets/{sheetId}`, then solve with `POST
        /v1/sheets/{sheetId}/solve`.
      properties:
        sheetId:
          type: string
          format: uuid
          description: Unique identifier for the sheet.
        projectId:
          type: string
          format: uuid
          description: Project the sheet belongs to.
        name:
          type: string
          description: Sheet name.
        templateCode:
          type: string
          description: Template the sheet was created from.
        status:
          type: string
          enum:
            - unsolved
          description: A newly created sheet has no results yet.
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp.
        sheetUrl:
          type: string
          format: uri
          description: Link to the sheet in the Calcs.com app.
      required:
        - sheetId
        - projectId
        - templateCode
        - status
        - sheetUrl
    ValidationError:
      type: object
      description: Validation error response for invalid API inputs
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
              description: Error code for validation failures
            message:
              type: string
              description: Human-readable error summary
              example: Input validation failed
            details:
              type: array
              description: Array of specific validation errors
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: Path to the invalid field (e.g., 'L_X', 'supports.0.2')
                  message:
                    type: string
                    description: Description of what's wrong with the field
                required:
                  - field
                  - message
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: VALIDATION_ERROR
          message: Input validation failed
          details:
            - field: L_X
              message: Expected number, received string
            - field: supports
              message: At least 2 supports are required
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 (`application/problem+json`) error returned by the API gateway
        before a request reaches the handler — currently authentication failures
        (401). Note this differs from the `{ error: { code, message, details }
        }` envelope returned by the handler for validation and not-found errors.
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the problem type.
        title:
          type: string
          description: Short, human-readable summary of the problem type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
        instance:
          type: string
          description: The request path that produced the error.
        trace:
          type: object
          description: >-
            Gateway trace metadata for support (timestamp, requestId, buildId,
            rayId).
      required:
        - type
        - title
        - status
        - detail
    ErrorResponse:
      type: object
      description: >-
        Standard error envelope for handler errors. `code` is a stable
        machine-readable error code (e.g. NOT_FOUND, UPSTREAM_ERROR); `message`
        is human-readable and may change.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer
        YOUR_API_KEY`. Every endpoint requires one.
    api_key:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.