Leadsmart

Create AI Key

POST

/ai-keys/{companyId}

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/ai-keys/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "minLength": 1,
            "description": "Name of the AI key"
        },
        "apiKey": {
            "type": "string",
            "minLength": 1,
            "description": "The API key value"
        },
        "provider": {
            "type": "string",
            "enum": ["openai"],
            "description": "AI provider"
        },
        "model": {
            "type": "string",
            "enum": ["gpt-4o-mini", "gpt-4o", "gpt-4.1", "gpt-4.1-mini"],
            "description": "AI model to use"
        },
        "active": {
            "type": "boolean",
            "default": true,
            "description": "Whether the AI key is active"
        }
    },
    "required": [
        "name",
        "apiKey",
        "provider",
        "model"
    ],
    "x-apidog-orders": [
        "name",
        "apiKey",
        "provider",
        "model",
        "active"
    ]
}'

Response Example

{}

Requisição

Parâmetros Path

companyId

string

requerido

Parâmetros Bodyapplication/json

name

string

requerido

Name of the AI key

apiKey

string

requerido

The API key value

provider

enum<string>

requerido

AI provider

Valores permitidos:

openai

model

enum<string>

requerido

AI model to use

Valores permitidos:

gpt-4o-minigpt-4ogpt-4.1gpt-4.1-mini

active

boolean

opcional

Whether the AI key is active

Padrão:

true

Examples

Respostas

🟢200Success

application/json

Body

object {0}

Modificado em 2025-06-11 17:42:03