curl --request POST \
--url https://operator.opus.com/api/v1/integration/provider \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"name": "Acme Corp"
}'
import requests
url = "https://operator.opus.com/api/v1/integration/provider"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {"name": "Acme Corp"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/integration/provider",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({ name: "Acme Corp" }),
}
);
const data = await response.json();
console.log(data);
{
"id": "{PROVIDER_ID}",
"name": "Acme Corp",
"email": "org-provider@opus.ai",
"status": "active",
"icon": "",
"createdAt": "2026-08-13T10:24:11.000Z"
}
Integrations
Create a Provider
Register the vendor or system an integration is authored under
POST
/
api
/
v1
/
integration
/
provider
curl --request POST \
--url https://operator.opus.com/api/v1/integration/provider \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"name": "Acme Corp"
}'
import requests
url = "https://operator.opus.com/api/v1/integration/provider"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {"name": "Acme Corp"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/integration/provider",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({ name: "Acme Corp" }),
}
);
const data = await response.json();
console.log(data);
{
"id": "{PROVIDER_ID}",
"name": "Acme Corp",
"email": "org-provider@opus.ai",
"status": "active",
"icon": "",
"createdAt": "2026-08-13T10:24:11.000Z"
}
Create the provider an integration is authored under — the vendor or system it talks to, such as Google, Slack, or an internal service of your own.
The provider carries your organization, and that binding is what authorizes later action, credential and publish calls on integrations built on it. Create one before your first integration and reuse its
id for everything from the same vendor.
Requires the Integration: Full permission at organization level.
Headers
Body Parameters
Provider icon as a base64-encoded SVG (or PNG) — a plain string, with no
data: prefix. Typically 360–8000 characters, maximum 65535.Your organization is always taken from the API key — it cannot be set in the body.
email must use a real domain. Reserved domains — .test, .example, .invalid, .localhost — are rejected with 422. Omit the field if you do not have a real address.Response
The provider id. Pass it as
providerId when creating an integration.Only
id is guaranteed. The other fields may be absent, because the provider version is not loaded on create.Errors
Your organization is not verified to author integrations, the API key is not org-scoped, or the key owner lacks the Integration: Full permission.
Rejected downstream after passing validation here — most commonly an
email on a reserved domain.curl --request POST \
--url https://operator.opus.com/api/v1/integration/provider \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"name": "Acme Corp"
}'
import requests
url = "https://operator.opus.com/api/v1/integration/provider"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {"name": "Acme Corp"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/integration/provider",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({ name: "Acme Corp" }),
}
);
const data = await response.json();
console.log(data);
{
"id": "{PROVIDER_ID}",
"name": "Acme Corp",
"email": "org-provider@opus.ai",
"status": "active",
"icon": "",
"createdAt": "2026-08-13T10:24:11.000Z"
}
Was this page helpful?