Ver .md

ai_credentials.create

Cadastrar chave de provedor de IA. Guarda a chave de um provedor (openai: sk-...; anthropic: sk-ant-...), cifrada, e devolve só os 4 últimos dígitos. O provedor é consultado: chave recusada dá invalid_input; se ele não responder, a chave entra como "não validada". A mesma chave duas vezes na conta dá invalid_input. label é opcional (padrão: o nome do provedor). Sem TOKEN_ENC_KEY no servidor responde credencial_ausente.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/ai_credentials.create (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: crm:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: ai_credentials_create
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId ai_credentials.create)

Entrada

CampoTipoObrigatórioNota
provider"openai" | "anthropic"sim
labelstringnão
apiKeystringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "openai",
        "anthropic"
      ]
    },
    "label": {
      "type": "string",
      "maxLength": 80
    },
    "apiKey": {
      "type": "string",
      "minLength": 20,
      "maxLength": 400,
      "pattern": "^\\S+$"
    }
  },
  "required": [
    "provider",
    "apiKey"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/ai_credentials.create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"openai","label":"Chave principal","apiKey":"sk-proj-exemplo-exemplo-exemplo"}'

CLI:

node cli/atomiks.mjs ai_credentials.create --json '{"provider":"openai","label":"Chave principal","apiKey":"sk-proj-exemplo-exemplo-exemplo"}'

MCP: ferramenta ai_credentials_create com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "provider": {
      "type": "string",
      "enum": [
        "openai",
        "anthropic"
      ]
    },
    "label": {
      "type": "string"
    },
    "keyLast4": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "invalid",
        "revoked"
      ]
    },
    "lastValidatedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "provider",
    "label",
    "keyLast4",
    "status",
    "lastValidatedAt",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).