Integrations

Test an integration

Check that the saved keys still work with the platform.

POSThttps://api.ollive.ai/api/integrations/test/v1

Safe to retryv1

How it works

You get a 200 either way. Look at ok: true means the platform accepted the keys, false means it refused them, and message says why.

Authorization

Authorizationheaderrequired
Your API key, after the word Bearer, like this: Bearer sk-…. Create a key.

Request body

application/json

idstring (uuid)required
The integration’s ID.

Response

The result of the test.

okbooleanrequired
Whether the platform accepted the keys.
messagestringrequired
What the platform said.

← Delete an integration Sync an integration →

curl -X POST "https://api.ollive.ai/api/integrations/test/v1" \  -H "Authorization: Bearer $OLLIVE_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "id": "8f14e45f-ceea-4b2a-9c1e-2a6f0e3d7b51"  }'

Response

{  "ok": true,  "message": "Connected."}

{  "error": {    "code": "invalid_request",    "message": "id is required.",    "param": "id",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}

{  "error": {    "code": "authentication_failed",    "message": "Invalid API key.",    "param": "",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}

{  "error": {    "code": "not_found",    "message": "Integration not found.",    "param": "",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}