Open API

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

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

Last updated