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

# Create lightweight assistant response.

> Create a fast UI-scoped assistant response using the agent runtime without adding the backing thread to normal assistant history by default.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/assistant/responses
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.3.0
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revisions, activation, reveal, disable, and
      destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/assistant/responses:
    post:
      tags:
        - Assistant
      summary: Create lightweight assistant response.
      description: >-
        Create a fast UI-scoped assistant response using the agent runtime
        without adding the backing thread to normal assistant history by
        default.
      operationId: AssistantController_createThreadlessResponse
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateThreadlessResponseDto'
      responses:
        '201':
          description: Lightweight assistant response created.
        '403':
          description: Forbidden.
      security:
        - bearer: []
components:
  schemas:
    CreateThreadlessResponseDto:
      type: object
      properties:
        content:
          type: string
          description: Content of the message, validated up to 100000 tokens.
          minLength: 1
        preflightMessageId:
          type: string
          description: >-
            Optional hidden draft user message id created before attachment
            uploads. When provided, the send operation finalizes that draft
            instead of creating a new user message.
          format: uuid
        model:
          type: string
          description: Optional execution model identifier enabled for this instance.
        reasoningEffort:
          type: string
          description: >-
            Optional assistant reasoning effort override: low, medium, high, or
            xhigh. Defaults to low.
          enum:
            - low
            - medium
            - high
            - xhigh
        reasoning:
          type: string
          description: >-
            Alias for reasoningEffort used by assistant preferences. Prefer
            reasoningEffort for new clients.
          enum:
            - low
            - medium
            - high
            - xhigh
        backgroundProcessing:
          type: boolean
          description: >-
            Allow the Assistant turn to continue after the client disconnects.
            Defaults to false unless the operation states otherwise.
          default: false
        interruptActive:
          type: boolean
          description: >-
            Optional flag for send-message endpoints. When true, an active
            streamed assistant turn for the thread is interrupted before
            appending this message.
          default: false
        goal:
          type: string
          description: >-
            Optional durable turn goal for non-plan execution. Agent runtime
            carries this goal across tool loops, compaction, and follow-up turns
            without forcing visible plan review.
          minLength: 1
        executionMode:
          type: string
          description: >-
            Execution mode for the turn. Interactive may pause for approval or
            clarification. Background and automation should avoid user-blocking
            pauses.
          enum:
            - interactive
            - execute
            - background
            - automation
          default: interactive
        planningPolicy:
          type: string
          description: >-
            Planning policy for the turn. standard can create and show progress;
            review_required creates a user-reviewed plan before execution.
          enum:
            - standard
            - review_required
          default: standard
        permissions:
          type: string
          description: >-
            Per-turn approval policy. default requires approval for
            side-effecting tool calls, auto_review uses conditional safe
            auto-review, and full skips normal approval gates.
          enum:
            - default
            - auto_review
            - full
          default: default
        toolPermissions:
          type: object
          description: >-
            Optional per-tool approval policy overrides. Runtime sanitizes keys
            and enum values before persisting them.
          additionalProperties:
            enum:
              - default
              - auto_review
              - full
        toolNames:
          description: >-
            Optional allowlist of operational tool names for this turn. Omit to
            allow the gateway default surface; pass an empty array to admit no
            tools for direct-answer turns.
          type: array
          items:
            type: string
        pluginIds:
          description: Optional registry plugin ids attached to this assistant turn.
          type: array
          items:
            type: string
            format: uuid
        version:
          type: string
          description: >-
            Optional assistant runtime selector. v2 routes the request through
            agent-gateway. v1 is expired and rejected.
          enum:
            - v1
            - v2
          default: v2
        context:
          description: >-
            Structured UI context for lightweight, threadless assistant
            responses.
          allOf:
            - $ref: '#/components/schemas/AssistantThreadlessResponseContextDto'
        persistThread:
          type: boolean
          description: >-
            Keep the backing lightweight thread visible for debugging. Defaults
            to false.
          default: false
      required:
        - content
    AssistantThreadlessResponseContextDto:
      type: object
      properties:
        componentContext:
          type: string
          description: >-
            Current Revo UI component context, used by the backend to preload
            deterministic skills without an extra preprocessing call.
          enum:
            - PREFERENCES
            - USERS
            - SERVICE_ACCOUNTS
            - GROUPS
            - ROLE_GROUPS
            - SECRETS
            - REVISIONS
            - DATABASES
            - DATA
            - DATA_ITEMS
            - ENDPOINTS
            - TEMPLATES
            - SCHEDULE
            - EVENTS
            - JOBS
            - AGENTS
            - AGENT_RUNS
            - AGENT_PLUGINS
            - WEBHOOKS
            - COMPONENTS
            - COMPONENT_ELEMENTS
            - EVENTS_HISTORY
            - USER_KEYS
            - FILES
            - STORAGE
            - REALTIME
            - LOGS
            - MONITORING
            - THREAD
            - SECURITY_SETTINGS
            - ME_SETTINGS
            - ME_KEYS
            - USER_DETAILS
            - PLAYGROUND
            - WEB_IDE
        kind:
          type: string
          description: UI-level intent hint for the lightweight response.
          enum:
            - suggestion
            - code_refactor
            - code_explain
            - completion
            - generic
        instruction:
          type: string
          description: Additional UI instruction for this lightweight response.
        language:
          type: string
          description: Programming or content language hint, for example typescript.
        filePath:
          type: string
          description: Optional file/component path currently shown in the UI.
        selectedText:
          type: string
          description: Current selected text/code from the UI.
        surroundingText:
          type: string
          description: Nearby text/code around the current selection.
        resourceRefs:
          description: Optional exact platform refs already known by the UI.
          type: array
          items:
            type: string
        requestContext:
          description: >-
            Additional deterministic backend routing/context tags supplied by
            the UI.
          type: array
          items:
            type: string
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````