> ## 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 preset crew

> Run a preset crew type, such as `ask` or `data_engineering`. inline.

The preset crew returns a `correlation_id` that you can also poll using `GET /api/events/{cid}`
for real-time progress or `GET /api/crews/results/{cid}` for the
final result.



## OpenAPI

````yaml post /api/crews/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/crews/run:
    post:
      tags:
        - Crews
      summary: Run preset crew
      description: >-
        Run a preset crew type, such as `ask` or `data_engineering`. inline.


        The preset crew returns a `correlation_id` that you can also poll using
        `GET /api/events/{cid}`

        for real-time progress or `GET /api/crews/results/{cid}` for the

        final result.
      operationId: run_preset_crew_api_crews_run_post
      parameters:
        - name: x-correlation-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Correlation-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrewRunRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrewRunResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    CrewRunRequest:
      properties:
        crew_type:
          $ref: '#/components/schemas/CrewType'
        task_input:
          additionalProperties: true
          type: object
          title: Task Input
          description: >-
            Key-value inputs passed to the crew. For example, `{'question':
            '...'}`.
      type: object
      required:
        - crew_type
      title: CrewRunRequest
      description: 'Simple mode: run a preset crew type with a task input.'
    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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CrewType:
      type: string
      enum:
        - ask
        - classification
        - data_engineering
        - data_suggestion
        - semantic_model
      title: CrewType
      description: Available preset crew types.
    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

````