Nexthink Handoff API API

openapi: 3.0.1
info:
  title: Campaigns Handoff API API
  version: 1.0.0
servers:
- url: https://{instance}.api.{region}.nexthink.cloud
  description: Nexthink Infinity instance API host
  variables:
    instance:
      default: instance
      description: Your Nexthink instance name
    region:
      default: us
      enum:
      - us
      - eu
      - pac
      - meta
      description: Nexthink cloud region
security:
- bearerAuth: []
tags:
- name: Handoff API
paths:
  /api/v1/spark/handoff:
    post:
      tags:
      - Handoff API
      summary: Hand off a conversation to Spark
      description: 'Handles user message requests for which responses will be redirected to Spark MS Teams.

        '
      operationId: handleHandoffRequest
      parameters:
      - name: Authorization
        in: header
        description: Authorization part for this request
        required: true
        schema:
          type: string
      - name: Timezone
        in: header
        description: Timezone to be used for this request
        required: false
        schema:
          type: string
      - name: User-Principal-Name
        in: header
        description: UPN to be used for this request
        required: true
        schema:
          type: string
      requestBody:
        description: Handoff conversation request containing user message
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoffConversationMessageRequest'
        required: true
      responses:
        '204':
          description: Request successful
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
        '502':
          description: Bad gateway
        '503':
          description: Service unavailable
components:
  schemas:
    FilePartByContent:
      required:
      - mimeType
      - fileContent
      type: object
      properties:
        fileContent:
          type: string
        mimeType:
          minLength: 1
          type: string
    MessageDTO:
      required:
      - parts
      type: object
      properties:
        parts:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/PartDTO'
    PartDTO:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/PartType'
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/TextPartDTO'
          FILE: '#/components/schemas/FilePartByContent'
      oneOf:
      - $ref: '#/components/schemas/TextPartDTO'
      - $ref: '#/components/schemas/FilePartByContent'
    HandoffConversationMessageRequest:
      required:
      - message
      type: object
      properties:
        metadata:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: Optional metadata that will be passed through the request flow
        message:
          $ref: '#/components/schemas/MessageDTO'
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
    TextPartDTO:
      required:
      - text
      type: object
      properties:
        text:
          minLength: 1
          type: string
    PartType:
      type: string
      enum:
      - TEXT
      - FILE
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: jwt
x-apievangelist-source: https://docs.nexthink.com/api/llms.txt
x-apievangelist-method: searched
x-apievangelist-generated: '2026-07-20'