Qlik Sense · OpenAPI Overlay 1.0.0

API Evangelist enhancements — Qlik assistants

3 actions 3 updates documentation extends ./qliksense-assistants.json
Generated by API Evangelist Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

descriptioncontacttermsOfServicex-api-evangelistx-api-evangelist-gapsx-api-evangelist-unnamed-operations

Targets 2

$.info
$

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements — Qlik assistants
  version: 1.0.0
extends: ./qliksense-assistants.json
x-generated: '2026-08-29'
x-method: generated
x-source: Generated by the API Evangelist enrichment pipeline. Captures OUR additions to Qlik's published spec (https://qlik.dev/specs/rest/assistants.json).
  The original document is never mutated.
actions:
- target: $.info
  update:
    description: Qlik Cloud assistants API. Part of a 78-document OpenAPI surface published by Qlik at https://qlik.dev/specs/rest/.
      Cross-cutting behaviour (auth, pagination, filtering, error envelope, rate limits, reversibility) is documented
      once in conventions/qliksense-conventions.yml.
    contact:
      name: Qlik Developer Portal
      url: https://qlik.dev/
    termsOfService: https://qlik.dev/apis/api-policy/
    x-api-evangelist:
      provider: qliksense
      docs: https://qlik.dev/apis/rest/assistants/
      markdown_twin: https://qlik.dev/apis/rest/assistants.md
      conventions: conventions/qliksense-conventions.yml
      errors: errors/qliksense-problem-types.yml
      authentication: authentication/qliksense-authentication.yml
      scopes: scopes/qliksense-scopes.yml
      rate_limits: rate-limits/qliksense-rate-limits.yml
      lifecycle: lifecycle/qliksense-lifecycle.yml
- target: $
  update:
    x-api-evangelist-gaps:
      security_schemes_declared: false
      security_schemes_note: 'This document declares no components.securitySchemes and no security requirement,
        yet every operation requires an Authorization: Bearer credential (API key, OAuth 2.0 token, or JWT). A client
        generated from this document alone will send unauthenticated requests.'
      operations_total: 29
      operations_without_operation_id: 28
      operations_deprecated: 0
      rate_limit_tiers:
        '1': 9
        '2': 20
      error_format: json-api-style errors[] envelope; not RFC 9457 problem+json
      idempotency: not supported
- target: $
  update:
    x-api-evangelist-unnamed-operations:
    - method: GET
      path: /api/v1/assistants
    - method: POST
      path: /api/v1/assistants
    - method: GET
      path: /api/v1/assistants/{assistantId}/feedback
    - method: POST
      path: /api/v1/assistants/{assistantId}/sources/plaintexts
    - method: GET
      path: /api/v1/assistants/{assistantId}/starters
    - method: POST
      path: /api/v1/assistants/{assistantId}/starters
    - method: GET
      path: /api/v1/assistants/{assistantId}/starters/{starterId}
    - method: PUT
      path: /api/v1/assistants/{assistantId}/starters/{starterId}
    - method: DELETE
      path: /api/v1/assistants/{assistantId}/starters/{starterId}
    - method: PUT
      path: /api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}
    - method: DELETE
      path: /api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}
    - method: GET
      path: /api/v1/assistants/{assistantId}/threads
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads
    - method: GET
      path: /api/v1/assistants/{assistantid}/threads/{threadid}
    - method: PATCH
      path: /api/v1/assistants/{assistantid}/threads/{threadid}
    - method: DELETE
      path: /api/v1/assistants/{assistantid}/threads/{threadid}
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream
    - method: GET
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions
    - method: GET
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}
    - method: DELETE
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback
    - method: PATCH
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}
    - method: POST
      path: /api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews
    - method: GET
      path: /api/v1/assistants/{id}
    - method: PATCH
      path: /api/v1/assistants/{id}
    - method: DELETE
      path: /api/v1/assistants/{id}