WSO2 API Chat API

openapi: 3.0.1
info:
  title: WSO2 API Manager - Admin Advanced Policy (Collection) Advanced Policy (Collection) API Chat API
  description: "This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**.\nPlease see [full OpenAPI Specification](https://raw.githubusercontent.com/wso2/carbon-apimgt/master/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml) of the API which is written using [OAS 3.0](http://swagger.io/) specification.\n\n# Authentication\nThe Admin REST API is protected using OAuth2 and access control is achieved through scopes. Before you start invoking\nthe the API you need to obtain an access token with the required scopes. This guide will walk you through the steps\nthat you will need to follow to obtain an access token.\nFirst you need to obtain the consumer key/secret key pair by calling the dynamic client registration (DCR) endpoint. You can add your preferred grant types\nin the payload. A sample payload is shown below.\n```\n  {\n  \"callbackUrl\":\"www.example.com\",\n  \"clientName\":\"rest_api_admin\",\n  \"owner\":\"admin\",\n  \"grantType\":\"client_credentials password refresh_token\",\n  \"saasApp\":true\n  }\n```\nCreate a file (payload.json) with the above sample payload, and use the cURL shown bellow to invoke the DCR endpoint. Authorization header of this should contain the\nbase64 encoded admin username and password.\n**Format of the request**\n```\n  curl -X POST -H \"Authorization: Basic Base64(admin_username:admin_password)\" -H \"Content-Type: application/json\"\n  \\ -d @payload.json https://<host>:<servlet_port>/client-registration/v0.17/register\n```\n**Sample request**\n```\n  curl -X POST -H \"Authorization: Basic YWRtaW46YWRtaW4=\" -H \"Content-Type: application/json\"\n  \\ -d @payload.json https://localhost:9443/client-registration/v0.17/register\n```\nFollowing is a sample response after invoking the above curl.\n```\n{\n\"clientId\": \"fOCi4vNJ59PpHucC2CAYfYuADdMa\",\n\"clientName\": \"rest_api_admin\",\n\"callBackURL\": \"www.example.com\",\n\"clientSecret\": \"a4FwHlq0iCIKVs2MPIIDnepZnYMa\",\n\"isSaasApplication\": true,\n\"appOwner\": \"admin\",\n\"jsonString\": \"{\\\"grant_types\\\":\\\"client_credentials password refresh_token\\\",\\\"redirect_uris\\\":\\\"www.example.com\\\",\\\"client_name\\\":\\\"rest_api_admin\\\"}\",\n\"jsonAppAttribute\": \"{}\",\n\"tokenType\": null\n}\n```\nNote that in a distributed deployment or IS as KM separated environment to invoke RESTful APIs (product APIs), users must generate tokens through API-M Control Plane's token endpoint.\nThe tokens generated using third party key managers, are to manage end-user authentication when accessing APIs.\n\nNext you must use the above client id and secret to obtain the access token.\nWe will be using the password grant type for this, you can use any grant type you desire.\nYou also need to add the proper **scope** when getting the access token. All possible scopes for Admin REST API can be viewed in **OAuth2 Security** section\nof this document and scope for each resource is given in **authorizations** section of resource documentation.\nFollowing is the format of the request if you are using the password grant type.\n```\ncurl -k -d \"grant_type=password&username=<admin_username>&password=<admin_passowrd>&scope=<scopes seperated by space>\"\n\\ -H \"Authorization: Basic base64(cliet_id:client_secret)\"\n\\ https://<host>:<server_port>/oauth2/token\n```\n**Sample request**\n```\ncurl https://localhost:9443/oauth2/token -k \\\n-H \"Authorization: Basic Zk9DaTR2Tko1OVBwSHVjQzJDQVlmWXVBRGRNYTphNEZ3SGxxMGlDSUtWczJNUElJRG5lcFpuWU1h\" \\\n-d \"grant_type=password&username=admin&password=admin&scope=apim:admin apim:tier_view\"\n```\nShown below is a sample response to the above request.\n```\n{\n\"access_token\": \"e79bda48-3406-3178-acce-f6e4dbdcbb12\",\n\"refresh_token\": \"a757795d-e69f-38b8-bd85-9aded677a97c\",\n\"scope\": \"apim:admin apim:tier_view\",\n\"token_type\": \"Bearer\",\n\"expires_in\": 3600\n}\n```\nNow you have a valid access token, which you can use to invoke an API.\nNavigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header.\nIf you use a different authentication mechanism, this process may change.\n\n# Try out in Postman\nIf you want to try-out the embedded postman collection with \"Run in Postman\" option, please follow the guidelines listed below.\n* All of the OAuth2 secured endpoints have been configured with an Authorization Bearer header with a parameterized access token. Before invoking any REST API resource make sure you run the `Register DCR Application` and `Generate Access Token` requests to fetch an access token with all required scopes.\n* Make sure you have an API Manager instance up and running.\n* Update the `basepath` parameter to match the hostname and port of the APIM instance.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/32294946-71bea2bc-f808-4208-a4f6-861ede6f0434)\n"
  contact:
    name: WSO2
    url: https://wso2.com/api-manager/
    email: architecture@wso2.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: v4
servers:
- url: https://apis.wso2.com/api/am/admin/v4
tags:
- name: API Chat
paths:
  /apis/{apiId}/api-chat:
    post:
      security:
      - OAuth2Security:
        - apim:subscribe
      summary: Test API using a natural language query
      description: 'Executes a test scenario against an API; which iteratively provide resources that need to be

        invoked alongside the inputs such as parameters, payloads, etc. while caching the progress.

        '
      operationId: apiChatPost
      parameters:
      - $ref: '#/components/parameters/apiId'
      - $ref: '#/components/parameters/action'
      requestBody:
        description: 'API Chat request body

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiChatRequest'
      tags:
      - API Chat
      responses:
        201:
          description: 'Created.

            API Chat action completed.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiChatResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        500:
          description: 'Internal Server Error.

            An error occurred while invoking the API Chat service.

            '
      x-code-samples:
      - lang: Curl
        source: 'curl -k -X POST -H "Content-Type: application/json" -d @request.json "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/api-chat?apiChatAction=EXECUTE"'
components:
  parameters:
    action:
      name: apiChatAction
      in: query
      description: 'Action to be performed on API Chat AI Agent. Specifies whether ''prepare'' or ''execute''

        '
      schema:
        type: string
        enum:
        - PREPARE
        - EXECUTE
    apiId:
      name: apiId
      in: path
      description: '**API ID** consisting of the **UUID** of the API.

        '
      required: true
      schema:
        type: string
  schemas:
    ApiChatResponse:
      title: API Chat response
      properties:
        apiSpec:
          type: object
          title: Enriched API spec
          required:
          - tools
          properties:
            serviceUrl:
              type: string
              description: Extracted service URL from the OpenAPI specification if there is any
              example: https://localhost:8243/pizzashack/1.0.0
            tools:
              type: array
              description: Extracted Http tools from the OpenAPI specification
              items:
                type: object
                example:
                  name: GET-order_orderId
                  description: Get details of an Order by providing Order Id. This tool invokes a HTTP GET resource
                  method: GET
                  path: /order/{orderId}
                  parameters:
                    orderId:
                      location: path
                      description: Order Id
                      required: true
                      style: simple
                      explode: false
                      schema:
                        type: string
                        format: string
        taskStatus:
          type: string
          description: Task status (IN_PROGRESS, TERMINATED or COMPLETED)
          enum:
          - IN_PROGRESS
          - TERMINATED
          - COMPLETED
          example: COMPLETED
        resource:
          type: object
          properties:
            method:
              type: string
              description: HTTP method of the resource
              example: GET
            path:
              type: string
              description: Path of the resource
              example: /order/{orderId}
            inputs:
              type: object
              description: Input parameters for the resource
              example:
                parameters:
                  orderId: '123'
        result:
          type: string
          description: completion result
          example: 'The pet with ID 123 is available. Here are the details: - ID: 123 - Name: asd - Status: available'
        queries:
          type: array
          description: list of sample queries
          items:
            $ref: '#/components/schemas/SampleQuery'
    ErrorListItem:
      title: Description of individual errors that may have occurred during a request.
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          description: 'Description about individual errors occurred

            '
    Error:
      title: Error object returned with 4XX HTTP status
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          format: int64
        message:
          type: string
          description: Error message.
        description:
          type: string
          description: 'A detail description about the error message.

            '
        moreInfo:
          type: string
          description: 'Preferably an url with more details about the error.

            '
        error:
          type: array
          description: 'If there are more than one error list them out.

            For example, list out validation errors by each field.

            '
          items:
            $ref: '#/components/schemas/ErrorListItem'
    SampleQuery:
      title: API Chat sample query record
      required:
      - scenario
      - query
      properties:
        scenario:
          type: string
          description: scenario
        query:
          type: string
          description: generated query
    ApiChatRequest:
      title: API Chat request
      properties:
        apiChatRequestId:
          type: string
          description: 'Request UUID

            '
          example: faae5fcc-cbae-40c4-bf43-89931630d313
        command:
          type: string
          description: 'User specified testcase to be tested against the API

            '
          example: Get pet with id 123
        apiSpec:
          type: object
          properties:
            serviceUrl:
              type: string
              description: Service URL of API if any
              example: https://localhost:8243/pizzashack/1.0.0
            tools:
              type: array
              description: Extracted Http tools from the OpenAPI specification
              items:
                type: object
                example:
                  name: GET-order_orderId
                  description: Get details of an Order by providing Order Id. This tool invokes a HTTP GET resource
                  method: GET
                  path: /order/{orderId}
                  parameters:
                    orderId:
                      location: path
                      description: Order Id
                      required: true
                      style: simple
                      explode: false
                      schema:
                        type: string
                        format: string
        response:
          type: object
          properties:
            code:
              type: integer
              description: HTTP status code of the response
              example: 201
            path:
              type: string
              description: HTTP path url with encoded parameters
              example: /order/123
            headers:
              type: object
              description: Response headers
              example:
                contentType: application/json
            body:
              type: object
              description: Response payload
              example:
                orderId: 300ada62-81bd-4c89-bdfa-983de3cadd77
                pizzaType: Pepperoni
                quantity: 2
                customerName: John Doe
                creditCardNumber: '1234567890123456'
                address: 123 Main St
                delivered: false
  responses:
    Unauthorized:
      description: Unauthorized. The user is not authorized.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 401
            message: Unauthorized
            description: The user is not authorized
            moreInfo: ''
            error: []
    BadRequest:
      description: Bad Request. Invalid request or validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 400
            message: Bad Request
            description: Invalid request or validation error
            moreInfo: ''
            error: []
  securitySchemes:
    OAuth2Security:
      type: oauth2
      flows:
        password:
          tokenUrl: https://localhost:9443/oauth2/token
          scopes:
            openid: Authorize access to user details
            apim:policies_import_export: Export and import policies related operations
            apim:admin: Manage all admin operations
            apim:tier_view: View throttling policies
            apim:tier_manage: Update and delete throttling policies
            apim:admin_tier_view: View throttling policies
            apim:admin_tier_manage: Update and delete throttling policies
            apim:bl_view: View deny policies
            apim:bl_manage: Update and delete deny policies
            apim:mediation_policy_view: View mediation policies
            apim:mediation_policy_create: Create and update mediation policies
            apim:app_owner_change: Retrieve and manage applications
            apim:app_settings_change: Change Application Settings
            apim:app_import_export: Import and export applications related operations
            apim:api_import_export: Import and export APIs related operations
            apim:api_product_import_export: Import and export API Products related operations
            apim:environment_manage: Manage gateway environments
            apim:environment_read: Retrieve gateway environments
            apim:monetization_usage_publish: Retrieve and publish Monetization related usage records
            apim:api_workflow_approve: Manage workflows
            apim:bot_data: Retrieve bot detection data
            apim:tenantInfo: Retrieve tenant related information
            apim:tenant_theme_manage: Manage tenant themes
            apim:admin_operations: Manage API categories and Key Managers related operations
            apim:api_category: Manage API categories
            apim:admin_settings: Retrieve admin settings
            apim:admin_alert_manage: Manage admin alerts
            apim:api_workflow_view: Retrive workflow requests
            apim:scope_manage: Manage system scopes
            apim:role_manage: Manage system roles
            apim:admin_application_view: View Applications
            apim:keymanagers_manage: Manage Key Managers
            apim:api_provider_change: Retrieve and manage applications
            apim:llm_provider_manage: Manage LLM Providers
            apim:gov_policy_read: Retrieve governance policies
            apim:gov_policy_manage: Manage governance policies
            apim:gov_result_read: Retrieve governance results
            apim:gov_rule_read: Retrieve governance rules
            apim:gov_rule_manage: Manage governance rules
            apim:organization_manage: Manage Organizations
            apim:organization_read: Read Organizations