Criar uma organização

POSTAR /api/v1/organizations

Autenticação do portador

Cria uma nova organização. O chamador recebe automaticamente o role ORG_ADMIN.

aplicação/json

corpo, corpo Obrigatório

Organização a ser criada

Descrição string
name string Obrigatório

O nome é cortado antes da validação. Deve ter 1-64 caracteres e pode conter letras/números Unicode, espaços e os caracteres - _ . ( ) , & @ + '.

O comprimento mínimo é 1, o comprimento máximo é 64.

Respostas

406

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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

aplicação/vnd.agent-engine-2026-09-20-preview+json

aplicação/vnd.agent-engine-2026-09-20-preview+json aplicação/json

Criado
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- admins array[objeto]
  
  Admins lista os ORG_ADMINs da organização. Preenchido somente pela listagem de administrador da plataforma; omitido nos endpoints da organização voltados para os membros.
  
  Ocultar atributos de administradores Mostrar atributos dos administradores objeto
  
  Email string
  
  name string
- atlas objeto
  
  Ocultar atributos do atlas Mostrar atributos do atlas objeto
  
  ambiente string Obrigatório
  
  id string Obrigatório
- created_at string
- Descrição string
- id string
- name string
- Fonte string
  
  Os valores são atlas ou agent_engine.
- updated_at string
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- admins array[objeto]
  
  Admins lista os ORG_ADMINs da organização. Preenchido somente pela listagem de administrador da plataforma; omitido nos endpoints da organização voltados para os membros.
  
  Ocultar atributos de administradores Mostrar atributos dos administradores objeto
  
  Email string
  
  name string
- atlas objeto
  
  Ocultar atributos do atlas Mostrar atributos do atlas objeto
  
  ambiente string Obrigatório
  
  id string Obrigatório
- created_at string
- Descrição string
- id string
- name string
- Fonte string
  
  Os valores são atlas ou agent_engine.
- updated_at string
400

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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
403

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

Proibido
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

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

Erro interno do servidor
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/organizations

curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/organizations' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "name": "string"
}'

Exemplos de solicitação

{
  "description": "string",
  "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)

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "string"
}

Exemplos de resposta (201)

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "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 (403)

{
  "code": "string",
  "error": "string",
  "success": true
}

Exemplos de resposta (403)

{
  "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
}