> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar workspace

> Crie um workspace com POST /v2/workspaces para compartilhar aplicações com outras contas da Square Cloud por função. Disponível no Standard, Pro e Enterprise.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `workspaces:manage`.

Cria um workspace pertencente ao usuário autenticado, permitindo compartilhar aplicações com outras contas Square Cloud sob um modelo de permissões baseado em funções, em vez de transferir a propriedade. Workspaces estão disponíveis apenas nos planos Standard, Pro e Enterprise; em todos esses níveis, a conta é limitada a 5 workspaces.

O `name` deve ter de 1 a 32 caracteres (letras, números, espaços, hifens ou sublinhados). Depois de criar um workspace, use [Adicionar aplicação](/pt-br/api-reference/endpoint/workspace/apps/add) para compartilhar aplicações nele e [Convidar membro](/pt-br/api-reference/endpoint/workspace/members/invite) para adicionar colaboradores. Este endpoint é limitado a 1 criação a cada 10 segundos por usuário.

## Parâmetros

<ParamField body="name" type="string" placeholder="Nome do Workspace" required>
  Uma string que representa o nome do workspace. <br />Deve obedecer ao padrão a a z, A a Z, 0 a 9, espaços e \_ (1-32 caracteres)
</ParamField>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

<ResponseField name="response" type="object">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="id" type="string">
      O ID do Workspace.
    </ResponseField>

    <ResponseField name="name" type="string">
      O nome do Workspace.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={"system"}

  {
      "status": "success",
      "response": {
          "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
          "name": "Test"
      }
  }

  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `INVALID_NAME` | 400 | `name` está ausente ou não atende ao padrão de 1 a 32 caracteres. |
| `UPGRADE_REQUIRED` | 403 | O plano ativo não é Standard, Pro ou Enterprise. |
| `WORKSPACE_LIMIT_REACHED` | 400 | A conta já atingiu o número máximo de workspaces do plano. |
| `WORKSPACE_CREATION_FAILED` | 400 | Não foi possível criar o workspace. |

## Relacionados

* CLI: [`squarecloud workspace create`](/pt-br/cli-reference/workspaces#squarecloud-workspace-create)
* SDKs: [`api.workspaces.create()`](/pt-br/sdks/js/workspaces) (JavaScript), [`client.workspaces.create()`](/pt-br/sdks/py/workspaces) (Python), [`c.Workspaces.Create()`](/pt-br/sdks/go/workspaces) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.