Agent Plugins

Create a plugin.

Create a new plugin for a specific agent (formerly known as project) identified by its unique projectId. This endpoint enables you to create a custom plugin for the project. Which allows you to share the custom agent as openai plugin to be shared globally.

post/api/v1/projects/{projectId}/plugins

Path parameters

projectIdinteger required

The id of an agent (formerly known as project) in which plugin will be stored.

Request body

model_namestring

Model Name

human_namestring

Name For Human

keywordsstring

Keywords For Model

descriptionstring

Description For Human

is_activeboolean

Whether the agent plugin is active or not

Example request

{
  "model_name": "IndoorPlants",
  "human_name": "The Indoor Plants Channel",
  "keywords": "Indoor plants, Gardening, Trusted information.",
  "description": "Trusted information about indoor plants and gardening.",
  "is_active": true
}

Response

Agent plugin has been created

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "model_name": "IndoorPlants",
    "human_name": "The Indoor Plants Channel",
    "keywords": "Indoor plants, Gardening, Trusted information.",
    "description": "Trusted information about indoor plants and gardening.",
    "logo": "https://app.customgpt.ai/logo.svg",
    "is_active": true
  }
}

Changes

Changed in 5 of the 9 revisions of this API.227

  • b80e6dfcf78d24See the full diff
    • added the new Agent id is required enum value to the data/message response property for the response status 404

      response-property-enum-value-added

    • added the new Agent with id {projectId} not found enum value to the data/message response property for the response status 404

      response-property-enum-value-added

    • api tag Agent Plugins added

      api-tag-added

    • api tag Project Plugins removed

      api-tag-removed

    • removed the Project id is required enum value from the data/message response property for the response status 404

      response-property-enum-value-removed

    • removed the Project with id {projectId} not found enum value from the data/message response property for the response status 404

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the non-success response with the status 400

      response-non-success-status-added

  • 1675fc6aa16a11See the full diff
    • removed the success response with the status 200

      response-success-status-removed

    • added the success response with the status 201

      response-success-status-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog