Swiftask
  • Quick start
  • Key concepts
    • AI Tools Hub
    • Agents
    • Knowledge base
    • Skills
    • Projects
    • Automation
  • AI tools hub
    • Introduction
    • Chat interface
    • Tokens
    • List of AI features
    • AI suggestions
    • FAQ
  • Agents
    • Introduction
    • Create an agent step by step
    • How to evaluate your agent
    • Multi-agents
    • Widget
    • Share agent
    • FAQ
  • Knowledge base
    • Introduction
    • Data connectors
      • Rich text
      • PDF File
      • Azure Document Loader
      • YouTube
      • Apify Dataset
      • PowerPoint File
      • Excel File
      • DOCX File
      • SQL Database
      • REST API
      • JSON File
      • CSV File
      • SQL Database Query
      • Website
      • Webpage
      • Sitemap
      • Dropbox files
      • Google drive files
    • Create a knowledge base
    • Attach Knowledge base to your agent
    • Share knowledge base
    • FAQ
  • Skills
    • Introduction
    • Skills library
      • Webpage Content Parsing
      • GitLab File Creation
      • Browsing with Perplexity
      • Open API
      • Retriever data from external sources
      • GitHub pull request diff retriever
      • GitHub pull request comment
      • Export table to Excel
      • Export text to PDF
      • GitHub file content
      • GitHub pull request info
      • OpenDataSoft
      • Agent as Skill
      • Swiftask AI recommandation
      • LinkedIn Share
      • Prismic migration create
      • Github create file
    • Create a new skill
    • Attach skill to your agent
    • FAQ
  • Projects
    • Introduction
    • Create a project
    • Generate task
    • Task AI chat
    • Organize chat in project
    • Project agent
    • FAQ
  • Automation
    • Introduction
    • Create an automation
  • Workspace admin
    • Introduction
    • Invite collaborators to join your workspace
    • Referral
    • Subscription renewal and Credit explanation
    • Purchase credits
    • Share agent
    • Subscription Pro plan/Team plan & token distribution
    • Create a project
    • Cancel subscription /Manage payment method
    • Personnal data security
    • SSO For enterprise
  • Use cases & Tutorials
    • Chat with multi-AI
    • Chat with PDF file
    • Import data - Webpage
    • How to generate an image on Swiftask
    • Import data (Azure Document Loader) - PDF
    • How to generate videos on Swiftask
    • Transform your ideas into videos with LUMA AI
    • Upgrade subscription plan
    • How to create an agent? step by step
    • Create AI agents for your business
    • Integrate external API in your agent
    • Create a professional landing page in 5 minutes
    • How to automate your blog content creation with an AI agent
    • How to evaluate your AI agent
    • How to create a Community Manager agent
  • Developer
    • List of AI and agents accessible via API
    • Access AI and agent through API
    • OpenAI SDK
  • Support & Social network
  • Changelog
Powered by GitBook
On this page
  1. Skills
  2. Skills library

Open API

Provides an interface to interact with various open APIs and integrate their functionalities.

PreviousBrowsing with PerplexityNextRetriever data from external sources

Last updated 3 months ago

Detailed Explanation

  1. Name:

    • This field allows you to assign a specific name to your Open API skill, making it identifiable within your AI agent.

    • Example: You might name it "Weather API Skill" if the skill is designed to fetch weather data.

  2. Skill Function:

    • This field is for describing what the skill does. A clear description helps users understand the skill's functionality.

    • Example: You might write:

      CopySearch information about the weather.
  3. Authentication:

    • This section allows you to set up access to the API. You can choose between "None" or "API Key" as your authentication method.

    • Example: If your API requires a key, select "API Key" and input your token in the provided field.

  4. API Documentation:

    • Here, you provide the API documentation in an Open API format. This is essential for understanding how to use the API, including endpoints, parameters, and response formats.

    • Example: You might enter documentation like:

      Copyopenapi: 3.0.0
      info:
        title: Weather API
        version: 1.0.0
      paths:
        /weather:
          get:
            summary: Get current weather
            parameters:
              - name: city
                in: query
                required: true
                description: Name of the city
                schema:
                  type: string
            responses:
              '200':
                description: A successful response

Example Use Case

Suppose you want to create a skill that allows users to get real-time weather updates. Here’s how you could set it up:

  1. Name:

    • Set this to "Weather API Skill".

  2. Skill Function:

    • Describe it as:

      CopySearch information about the weather for a specified city.
  3. Authentication:

    • If your API requires an API key, select "API Key" and enter your access token:

      Copymy_api_key_123456
  4. API Documentation:

    • Provide the Open API documentation:

      Copyopenapi: 3.0.0
      info:
        title: Weather API
        version: 1.0.0
      paths:
        /weather:
          get:
            summary: Get current weather
            parameters:
              - name: city
                in: query
                required: true
                description: Name of the city
                schema:
                  type: string
            responses:
              '200':
                description: A successful response