Skip to content

The open-source app everyone uses to manage agents at work

1.2 KB
Raw Blame
{
  "schemaVersion": 1,
  "slug": "api-key-generic",
  "name": "API key app",
  "description": "Connect an API using a key from your provider.",
  "categories": [
    "other"
  ],
  "featured": false,
  "branding": {
    "logoUrl": "/brands/apps/api-key-generic.svg"
  },
  "urlPatterns": [],
  "methods": [
    {
      "key": "api-key",
      "transport": "rest_api",
      "auth": "api_key",
      "ownershipModes": [
        "customer"
      ],
      "whenToUse": "Use credentials from your provider account.",
      "defaults": {},
      "guidanceMd": "Create a restricted API key and paste it here.",
      "riskTier": "S3",
      "credentialFields": [
        {
          "key": "apiKey",
          "label": "API key",
          "type": "password",
          "required": true,
          "placeholder": "Paste the API key",
          "secret": true,
          "helperMd": "Actions depend on the operator-supplied API and key; grant read/write on the required resources at the provider. Create a key with read and write permissions for these actions; Paperclip cannot increase an existing key’s permissions."
        }
      ],
      "keyPlacement": {
        "location": "header",
        "name": "Authorization",
        "prefix": "Bearer "
      }
    }
  ]
}