Skip to main content

POST Salvar Credencial de Provedor

Salva (ou substitui) a chave de API de um provedor de IA para a conta. A chave é armazenada criptografada.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_configurations.


Endpoint​

POST https://api-dev.imagemais.com.br/api/ai/settings/credentials

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
providerstring✅OPENAI, GROKProvedor de IA
apiKeystring✅não vazioChave de API do provedor

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/ai/settings/credentials' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"provider": "OPENAI",
"apiKey": "texto"
}'

Respostas​

201 Sucesso​

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"provider must be one of the following values: OPENAI, GROK",
"A chave é obrigatória",
"apiKey must be a string"
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

500 Erro interno​

Mensagens possíveis:

  • Erro ao salvar a credencial.
  • Erro de configuração do servidor. Contate o suporte.
{
"message": "Erro ao salvar a credencial.",
"error": "Internal Server Error",
"statusCode": 500
}