AgentShopGPT

AgentShopGPT · GPT アクション

AgentQuery API

API for querying OpenAI GPTs and Agents with various search parameters.

  • POST /agentquerySubmit a query

    Allows submitting a query with various search options.

元の API スキーマ
{
  "openapi": "3.0.0",
  "info": {
    "title": "AgentQuery API",
    "description": "API for querying OpenAI GPTs and Agents with various search parameters.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.agentshop.ai"
    }
  ],
  "paths": {
    "/agentquery": {
      "post": {
        "summary": "Submit a query",
        "description": "Allows submitting a query with various search options.",
        "operationId": "submitQuery",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "queryType": {
                    "type": "string",
                    "enum": [
                      "query"
                    ],
                    "description": "Type of the query, always 'query'."
                  },
                  "queryString": {
                    "type": "string",
                    "description": "Textual content of the query, like 'sports teams'."
                  },
                  "categorySearch": {
                    "type": "string",
                    "description": "Category for the search, like 'gpts'."
                  },
                  "topicSearch": {
                    "type": "boolean",
                    "description": "Flag to enable or disable topic-based search."
                  },
                  "pageNumber": {
                    "type": "integer",
                    "description": "Page number for result pagination."
                  }
                },
                "required": [
                  "topicSearch",
                  true
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Query processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "pageNumber": {
                      "type": "integer",
                      "description": "The page number of the results."
                    },
                    "results": {
                      "type": "array",
                      "description": "List of search results.",
                      "items": {
                        "$ref": "#/components/schemas/ResultItem"
                      }
                    },
                    "status": {
                      "type": "string",
                      "description": "Status of the response."
                    },
                    "totalCount": {
                      "type": "integer",
                      "description": "Total number of items found."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ResultItem": {
        "type": "object",
        "properties": {
          "URI": {
            "type": "string",
            "format": "uri",
            "description": "The URI of the KGAgent."
          },
          "hasKGAgentAvatarImageURL": {
            "type": "string",
            "format": "uri",
            "description": "URL of the KGAgent's avatar image."
          },
          "hasKGAgentAvatarLargeImageURL": {
            "type": "string",
            "format": "uri",
            "description": "URL of the KGAgent's large avatar image."
          },
          "hasKGAgentDeploymentURL": {
            "type": "string",
            "format": "uri",
            "description": "Deployment URL of the KGAgent."
          },
          "hasKGAgentDescription": {
            "type": "string",
            "description": "Description of the KGAgent."
          },
          "hasKGAgentIdentifier": {
            "type": "string",
            "description": "Identifier of the KGAgent."
          },
          "hasKGAgentModificationDateTime": {
            "type": "integer",
            "description": "Modification date and time of the KGAgent."
          },
          "hasKGAgentName": {
            "type": "string",
            "description": "Name of the KGAgent."
          },
          "hasKGAgentNameSlug": {
            "type": "string",
            "description": "Slug name of the KGAgent."
          },
          "hasKGAgentPublisherName": {
            "type": "string",
            "description": "Publisher name of the KGAgent."
          },
          "hasKGGraphAssertionDateTime": {
            "type": "integer",
            "description": "Date and time of the graph assertion of the KGAgent."
          },
          "hasReferenceIdentifier": {
            "type": "string",
            "description": "Reference identifier."
          },
          "hasName": {
            "type": "string",
            "description": "Name of the item."
          },
          "type": {
            "type": "string",
            "description": "Type of the item."
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of types for the item."
          }
        }
      }
    }
  }
}