Legacy - Instances

Cria uma instância pelo alias legado

Deprecated

POSThttp://localhost:8084/instance/create

Autenticação

GlobalApiKeyobrigatório

Token global. O runtime também aceita x-api-key e apiKey; aliases simultâneos precisam ter o mesmo valor.

Header: apikey
Exemplo: <GLOBAL_API_KEY>

Request body

obrigatório

bodyobject

Exemplo: {"instanceName":"codechat","description":"Atendimento principal","externalAttributes":{"tenantId":"acme"}}

instanceNamestringmaxLength: 255

descriptionstringmaxLength: 255

externalAttributesobject

Exemplo JSONgerado do schema

{
  "instanceName": "codechat",
  "description": "Atendimento principal",
  "externalAttributes": {
    "tenantId": "acme"
  }
}

Respostas

application/json

201

Instância criada

response 201object

idintegerobrigatório

namestringobrigatório

descriptionstring | nullobrigatório

createdAtstring | nullobrigatórioformat: date-time

updatedAtstring | nullobrigatórioformat: date-time

Authobjectobrigatório

idintegerobrigatório

tokenstringobrigatório

Exemplo 201gerado do schema

{
  "id": 1,
  "name": "CodeChat",
  "description": "string",
  "createdAt": "2026-07-13T15:10:00Z",
  "updatedAt": "2026-07-13T15:10:00Z",
  "Auth": {
    "id": 1,
    "token": "<INSTANCE_TOKEN>"
  }
}