POpoll-the-people
Agent Actions

Replace a custom External API's OpenAPI schema.

Changed on

Takes the same openapi_url (JSON) or openapi_file (multipart/form-data) field as create; exactly one of them is required.

post/api/v1/projects/{projectId}/actions/external-apis/{integrationId}/openapi

Request

Path parameters

projectIdinteger required
Example:1

The unique agent identifier.

integrationIdinteger required
Example:1

The unique External API identifier.

Request body

openapi_urlstring required

Public HTTPS URL of the OpenAPI (JSON or YAML) schema.

Example request

{
  "openapi_url": "https://api.example.com/openapi.json"
}

Response

The External API.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "external_api": {
      "id": 1,
      "name": "Orders API",
      "is_enabled": true,
      "host": "api.example.com",
      "base_url": "https://api.example.com/v1",
      "auth_type": "bearer",
      "auth_key_name": "Authorization",
      "has_openapi": true,
      "openapi_metadata": {
        "title": "Orders API",
        "version": "1.0.0",
        "endpoint_count": 12
      }
    }
  }
}

Changes