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

# Trigger a Tool

> Executes a provider-specific tool on a connected channel, for example searching Instagram audio for Reels, listing Discord channels, or fetching Reddit flairs. Discover available tools with the integration settings endpoint.

Some providers expose helper tools for fetching dynamic data needed when
constructing post settings — for example searching
[Instagram audio](/public-api/providers/instagram#audio) to attach to a Reel,
listing Discord channels, or fetching Reddit flairs.

Discover the tools available for a channel with the
[settings endpoint](/public-api/integrations/settings) — each tool entry
contains the `methodName` to pass here together with its parameter schema.


## OpenAPI

````yaml POST /integration-trigger/{id}
openapi: 3.1.0
info:
  title: Postiz Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Postiz.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:


    ```

    Authorization: your-api-key

    ```


    Get your API key from Postiz Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27)


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook,
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.postiz.com/public/v1
    description: Postiz Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Postiz instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
paths:
  /integration-trigger/{id}:
    post:
      tags:
        - Integrations
      summary: Trigger an integration tool
      description: >-
        Executes a provider-specific tool on a connected channel, for example
        searching Instagram audio for Reels, listing Discord channels, or
        fetching Reddit flairs. Discover available tools with the integration
        settings endpoint.
      operationId: triggerIntegrationTool
      parameters:
        - name: id
          in: path
          required: true
          description: The integration ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - methodName
              properties:
                methodName:
                  type: string
                  description: >-
                    The tool method name, as returned by the integration
                    settings endpoint
                data:
                  type: object
                  description: Key-value parameters for the tool
                  additionalProperties:
                    type: string
            example:
              methodName: audioSearch
              data:
                q: summer vibes
                type: music
      responses:
        '200':
          description: Tool executed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  output:
                    description: The tool result, shape depends on the tool
              example:
                output:
                  - id: '587784541076604'
                    title: Summer Vibes
                    artist: Some Artist
                    image: https://scontent.cdninstagram.com/cover.jpg
                    duration: 30000
                    previewUrl: https://scontent.cdninstagram.com/preview.mp4
        '401':
          description: Channel disconnected due to expired token
        '404':
          description: Integration or tool not found
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Postiz API key

````