Skip to main content
POST
/
api-keys
Create a new API key
curl --request POST \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/api-keys \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Body

application/json

API key details

​
name
string
required
​
scopes
string[]
required
Minimum array length: 1
​
description
string
​
expires_in_days
integer
​
integration_type
string

whatsapp, smart_pay, vult, agent_app

​
ip_whitelist
string[]
​
rate_limit
integer

Response

API key created

The response is of type object.