> ## Documentation Index
> Fetch the complete documentation index at: https://dust-docs-add-servicenow-tool-page.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Invoke an active Frames v2 function

> Resolves a bare function name from the Frame's active immutable publication, checks Frame use rights, and starts an invocation pinned to that publication.



## OpenAPI

````yaml https://raw.githubusercontent.com/dust-tt/dust/refs/heads/main/front-api/public/swagger.json post /api/w/{wId}/frames/{frameId}/functions/{name}/invocations
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/w/{wId}/frames/{frameId}/functions/{name}/invocations:
    post:
      tags:
        - Private Frames
      summary: Invoke an active Frames v2 function
      description: >-
        Resolves a bare function name from the Frame's active immutable
        publication, checks Frame use rights, and starts an invocation pinned to
        that publication.
      parameters:
        - name: wId
          in: path
          required: true
          schema:
            type: string
        - in: path
          name: frameId
          required: true
          schema:
            type: string
        - in: path
          name: name
          required: true
          description: Bare function name declared by the active Frame publication.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivateFrameFunctionInvocationRequest'
      responses:
        '201':
          description: >-
            Invocation created. Fast invocations may also include their terminal
            outcome.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateFrameFunctionInvocationResponse'
        '401':
          description: >-
            The function requires a workspace member or a stricter caller
            identity.
        '404':
          description: Frame, active publication, function, or Frame use right not found.
        '500':
          description: Invocation failed before it could be created.
      security:
        - BearerAuth: []
components:
  schemas:
    PrivateFrameFunctionInvocationRequest:
      type: object
      additionalProperties: false
      properties:
        input:
          description: Input validated against the published function contract.
        context:
          type: object
          additionalProperties: false
          properties:
            timezone:
              type: string
    PrivateFrameFunctionInvocationResponse:
      type: object
      required:
        - invocation
      properties:
        invocation:
          $ref: '#/components/schemas/PrivateSandboxFunctionInvocation'
        outcome:
          oneOf:
            - type: object
              required:
                - status
                - result
              properties:
                status:
                  type: string
                  enum:
                    - succeeded
                result:
                  description: Parsed result validated against the function output schema.
            - type: object
              required:
                - status
                - error
              properties:
                status:
                  type: string
                  enum:
                    - errored
                error:
                  $ref: '#/components/schemas/PrivateSandboxFunctionCallError'
    PrivateSandboxFunctionInvocation:
      type: object
      required:
        - sId
        - functionId
        - status
        - createdAt
      properties:
        sId:
          type: string
        functionId:
          type: string
        status:
          type: string
          enum:
            - created
            - errored
            - succeeded
        createdAt:
          type: string
          format: date-time
    PrivateSandboxFunctionCallError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Classification forwarded from the runner, API, or invocation layer.
        message:
          type: string
        status:
          type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.

````