integrations

Provision Plugin

Provision a dedicated agent identity for a plugin, and add a key for it.

Idempotent get-or-create: the first call creates an agent sub-user for (user, plugin_key); every later call returns the same agent. Every call adds one new key, so each machine holds its own. The returned key is shown once and never retrievable again.

Provisioning never deletes a key. An agent already holding MAX_USER_API_KEYS keys (default 10) answers 409 and nothing changes: free a slot through DELETE /plugins/{plugin_key}/keys/{key_id}. Provisioning does not revoke a leaked key either: revoke it the same way, or every key through DELETE /plugins/{plugin_key}.

Path Parameters

plugin_key (str): Key of a known plugin (see GET /api/v1/integrations/status).

POST

api

integrations

plugins

{plugin_key}

provision

Provision Plugin

curl --request POST \
  --url https://{tenant}.aws.cognee.ai/api/v1/integrations/plugins/{plugin_key}/provision \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.aws.cognee.ai/api/v1/integrations/plugins/{plugin_key}/provision"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "pluginKey": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "apiKey": "<string>",
  "keyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plugin_key

string

required

Response

Successful Response

pluginKey

string

required

agentId

string<uuid>

required

apiKey

string

required

keyId

string<uuid>

required

created

boolean

required

⌘I

Provision Plugin

curl --request POST \
  --url https://{tenant}.aws.cognee.ai/api/v1/integrations/plugins/{plugin_key}/provision \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.aws.cognee.ai/api/v1/integrations/plugins/{plugin_key}/provision"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "pluginKey": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "apiKey": "<string>",
  "keyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

auth

add

cognify

memify

search

permissions

conflicts

datasets

ontologies

settings

visualize

schema

skills

configuration

delete

validate

update

responses

llm

sync

users

checks

health

agent management

agent connections

activity

sessions

remember

recall

improve

forget

slack

integrations

Provision Plugin

Path Parameters

Authorizations

Path Parameters

Response