PUT
/
backend
/
actions
/
bot
/
:id
/
import-from-swagger
curl --location --request PUT 'https://api-v2.opencopilot.so/backend/actions/bot/:id/import-from-swagger' \
--header 'Accept: application/json' \
--header 'Authorization : Bearer YOUR_TOKEN' \
--form 'file=@"/Users/gharbat/Desktop/swagger.json"'
{
    "message": "Successfully imported actions from swagger.json"
}

This endpoint points to the (v2) version of the API. The (v2) version of the API is the latest version and is recommended for all new development. Please update your code to use the (v2) version of the API.

OpenAPI Specification (Swagger)

This endpoint supports the OpenAPI V3 Specification (Swagger). We have introduced some new fields to the OpenAPI specification that are custom to Open. These fields are:

  • x-open-execute-after: string[]
    This field is useful when you want to execute other operation(s) before the current operation/action. it takes an array of operation IDs. The AI will execute the operations in the order they are listed in the array.

Example:

Suppose you have an action with the operation ID deleteUserCourses. Before performing this action, you want to force the AI to list all the courses the user has and then delete them.

You can achieve this by adding ['listUserCourses'] to the x-open-execute-after field. The AI will first execute the listUserCourses operation and then proceed to execute the deleteUserCourses operation.

Body

id
string

The uuid of the copilot

Headers

header
string

application/json

header
string

Bearer YOUR_TOKEN

Response

message
string

Indicates whether the call was successful.

curl --location --request PUT 'https://api-v2.opencopilot.so/backend/actions/bot/:id/import-from-swagger' \
--header 'Accept: application/json' \
--header 'Authorization : Bearer YOUR_TOKEN' \
--form 'file=@"/Users/gharbat/Desktop/swagger.json"'
{
    "message": "Successfully imported actions from swagger.json"
}