POpoll-the-people
Agent Actions

Update a custom External API.

Changed on

Renames it, replaces its API key, or enables/disables it. At most 5 External APIs can be active at once.

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

Request

Path parameters

projectIdinteger required
Example:1

The unique agent identifier.

integrationIdinteger required
Example:1

The unique External API identifier.

Request body

namestring

Display name, up to 120 characters.

api_keystring

Replacement credential.

is_enabledboolean

Enable or disable the External API. At most 5 can be enabled at once.

Example request

{
  "name": "Orders API",
  "api_key": "sk_live_456",
  "is_enabled": true
}

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