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

# Run template

> Run a saved crew template with values for its declared variables.

Validates the supplied ``values`` against the template's declared
``variables``, such as required-ness, types, choices, and length or range bounds.
Defaults fill in for omitted optional variables. On success, returns
the inline-crew correlation ID for the portal to poll.



## OpenAPI

````yaml post /api/crew-templates/{template_id}/run
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/crew-templates/{template_id}/run:
    post:
      tags:
        - Crew templates
      summary: Run template
      description: >-
        Run a saved crew template with values for its declared variables.


        Validates the supplied ``values`` against the template's declared

        ``variables``, such as required-ness, types, choices, and length or
        range bounds.

        Defaults fill in for omitted optional variables. On success, returns

        the inline-crew correlation ID for the portal to poll.
      operationId: run_template_api_crew_templates__template_id__run_post
      parameters:
        - name: template_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Template Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunTemplateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrewRunResponse'
        '400':
          description: Inputs failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Template not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    RunTemplateRequest:
      properties:
        values:
          additionalProperties: true
          type: object
          title: Values
          description: >-
            Map of ``variable.name`` → user-supplied value. Validated against
            the template's declared variables, such as required-ness, type, and
            choices before the crew runs.
      type: object
      title: RunTemplateRequest
      description: Run a saved crew template with concrete values for its variables.
    CrewRunResponse:
      properties:
        correlation_id:
          type: string
          title: Correlation Id
        status:
          $ref: '#/components/schemas/CrewRunStatusEnum'
          default: pending
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
      type: object
      required:
        - correlation_id
      title: CrewRunResponse
      description: Response returned after a crew run starts.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CrewRunStatusEnum:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
      title: CrewRunStatusEnum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````