curl --request POST \
--url https://operator.opus.com/api/v1/integration/v/{INTEGRATION_VERSION_ID}/credential \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": true
}
}
}
}'
import requests
version_id = "{INTEGRATION_VERSION_ID}"
url = f"https://operator.opus.com/api/v1/integration/v/{version_id}/credential"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": True,
}
},
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const versionId = "{INTEGRATION_VERSION_ID}";
const response = await fetch(
`https://operator.opus.com/api/v1/integration/v/${versionId}/credential`,
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({
credential: {
name: "Acme API Key",
description: "API key for the Acme Search API",
icon: "{BASE64_ICON}",
authType: "api_key",
inputs: {
api_key: {
displayName: "API Key",
variableName: "api_key",
type: "str",
order: 1,
placeholder: "Enter your Acme API key",
isSecret: true,
},
},
},
}),
}
);
const data = await response.json();
console.log(data);
{
"id": "{CREDENTIAL_ID}",
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"isNullable": false,
"placeholder": "Enter your Acme API key",
"isSecret": true,
"isEditable": true,
"isVisible": true,
"default": null
}
},
"status": "active",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"versionId": "{CREDENTIAL_VERSION_ID}",
"createdAt": "2026-08-13T10:31:02.000Z"
}
Integrations
Add a Credential
Define how an integration authenticates
POST
/
api
/
v1
/
integration
/
v
/
{integrationVersionId}
/
credential
curl --request POST \
--url https://operator.opus.com/api/v1/integration/v/{INTEGRATION_VERSION_ID}/credential \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": true
}
}
}
}'
import requests
version_id = "{INTEGRATION_VERSION_ID}"
url = f"https://operator.opus.com/api/v1/integration/v/{version_id}/credential"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": True,
}
},
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const versionId = "{INTEGRATION_VERSION_ID}";
const response = await fetch(
`https://operator.opus.com/api/v1/integration/v/${versionId}/credential`,
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({
credential: {
name: "Acme API Key",
description: "API key for the Acme Search API",
icon: "{BASE64_ICON}",
authType: "api_key",
inputs: {
api_key: {
displayName: "API Key",
variableName: "api_key",
type: "str",
order: 1,
placeholder: "Enter your Acme API key",
isSecret: true,
},
},
},
}),
}
);
const data = await response.json();
console.log(data);
{
"id": "{CREDENTIAL_ID}",
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"isNullable": false,
"placeholder": "Enter your Acme API key",
"isSecret": true,
"isEditable": true,
"isVisible": true,
"default": null
}
},
"status": "active",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"versionId": "{CREDENTIAL_VERSION_ID}",
"createdAt": "2026-08-13T10:31:02.000Z"
}
Define how an integration authenticates: which fields exist, their types, and how they render in the Opus app.
This is the credential schema — it carries no secret values. Real secrets are supplied later, when someone connects the integration inside a workspace.
Use the
versionId returned by Create an Integration as {integrationVersionId}.
Requires the Integration: Full permission at organization level.
An integration may hold only one credential per
authType. Adding a second with the same type returns 409.Headers
Path Parameters
The integration version to attach the credential to. This is
versionId from Create an Integration — not the integration’s id.Body Parameters
The credential is nested under acredential key.
Credential icon as a base64-encoded SVG (or PNG) — a plain string, with no
data: prefix. Maximum 65535 characters.The credential input schema, keyed by each field’s
variableName. See Input field object.Authentication type —
jwt, oauth, api_key, access_token, custom_header_auth, other or no_auth.Input field object
Each value insideinputs. The map key must equal the field’s variableName.
Programmatic key for this field. Must equal the key it sits under. Maximum 255 characters.
Value type accepted by this field —
str, int, float, bool, date, list, dict, set, object, array, file or array_files.Response
Errors
Your organization is not verified to author integrations, the key owner lacks the Integration: Full permission, or the integration belongs to another organization.
The integration version does not exist. Check you are using
versionId and not the integration’s id.curl --request POST \
--url https://operator.opus.com/api/v1/integration/v/{INTEGRATION_VERSION_ID}/credential \
--header 'Content-Type: application/json' \
--header 'x-service-key: {YOUR_SERVICE_KEY}' \
--data '{
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": true
}
}
}
}'
import requests
version_id = "{INTEGRATION_VERSION_ID}"
url = f"https://operator.opus.com/api/v1/integration/v/{version_id}/credential"
headers = {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
"credential": {
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"placeholder": "Enter your Acme API key",
"isSecret": True,
}
},
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const versionId = "{INTEGRATION_VERSION_ID}";
const response = await fetch(
`https://operator.opus.com/api/v1/integration/v/${versionId}/credential`,
{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-service-key": "{YOUR_SERVICE_KEY}",
},
body: JSON.stringify({
credential: {
name: "Acme API Key",
description: "API key for the Acme Search API",
icon: "{BASE64_ICON}",
authType: "api_key",
inputs: {
api_key: {
displayName: "API Key",
variableName: "api_key",
type: "str",
order: 1,
placeholder: "Enter your Acme API key",
isSecret: true,
},
},
},
}),
}
);
const data = await response.json();
console.log(data);
{
"id": "{CREDENTIAL_ID}",
"name": "Acme API Key",
"description": "API key for the Acme Search API",
"inputs": {
"api_key": {
"displayName": "API Key",
"variableName": "api_key",
"type": "str",
"order": 1,
"isNullable": false,
"placeholder": "Enter your Acme API key",
"isSecret": true,
"isEditable": true,
"isVisible": true,
"default": null
}
},
"status": "active",
"icon": "{BASE64_ICON}",
"authType": "api_key",
"versionId": "{CREDENTIAL_VERSION_ID}",
"createdAt": "2026-08-13T10:31:02.000Z"
}
Was this page helpful?