Criar uma chave de API do modelo Atlas Voyage / AI

POSTAR /api/v1/atlas/projects/{project_id}/model-api-keys
Autenticação do portador

Faz o proxy do POST API do Administrador do Atlas /groups/{id}/aiModelApiKeys usando um token delegado do chamador humano ou uma conta de serviço emparelhada do Agent Engine. As chaves da API do Agent Engine não são aceitas. O segredo único é devolvido ao chamador e nunca é refletido em respostas ou registros de erro. Project_id inválido é rejeitado antes de qualquer chamada Atlas .

parâmetros de caminho

  • PROJECT_ID string Obrigatório

    ID do projeto Atlas

aplicação/json
corpo, corpo objeto Obrigatório

Chave de API do modelo a ser criada

Um dos seguintes:
objeto-1 objeto objeto

Respostas

  • 406

    Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.
  • 201

    Criado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • id string
    • modified_secret string
    • name string
    • segredo string
    • Status string
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • id string
    • modified_secret string
    • name string
    • segredo string
    • Status string
  • 400

    Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 401

    Não autorizado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 402

    Atlas_payment_METHOD_REQUIRED

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 403

    atlas_permissão_required, atlas_service_account_not_paired ou forBidden

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 404

    NÃO_FOUND

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 409

    Conflito

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 413

    corpo da solicitação muito grande

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 500

    Internal_error

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 502

    Gateway incorreto

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 503

    PLATFORM_OAUTH_NOT_CONFIGURED ou SERVIÇO_UNAVAILABLE quando uma atualização de token delegada já estiver em andamento

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
POST /api/v1/atlas/projects/{project_id}/model-api-keys 
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/model-api-keys' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json"
Exemplos de solicitação 
{}
{
  "name": "string"
}
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (201) 
{
  "id": "string",
  "masked_secret": "string",
  "name": "string",
  "secret": "string",
  "status": "string"
}
Exemplos de resposta (201) 
{
  "id": "string",
  "masked_secret": "string",
  "name": "string",
  "secret": "string",
  "status": "string"
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}