---
agentTools:
  projectIndex: https://hermae.readme.io/llms.txt
---

# Create Organization

Create an organization.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.2.1",
    "title": "Hermae API",
    "description": "API for managing the Hermae application."
  },
  "servers": [
    {
      "url": "https://api.hermae.com"
    }
  ],
  "security": [
    {
      "HermaeKeyAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "HermaeKeyAuth": {
        "type": "apiKey",
        "name": "x-hermae-key",
        "in": "header",
        "description": "Your API key for authentication."
      }
    }
  },
  "paths": {
    "/organizations": {
      "post": {
        "summary": "Create Organization",
        "description": "Create an organization.",
        "tags": [
          "Organizations"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 24,
                    "pattern": "^[a-zA-Z0-9,. ]+$"
                  },
                  "logo_url": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "required": [
                  "name"
                ],
                "description": "An object representing an organization."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The new organization document.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "number"
                    },
                    "returns": {
                      "type": "object",
                      "properties": {
                        "organization": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "creator_id": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string",
                              "maxLength": 24,
                              "pattern": "^[a-zA-Z0-9,. ]+$"
                            },
                            "logo_url": {
                              "type": "string",
                              "format": "uri"
                            },
                            "domain": {
                              "type": "string",
                              "maxLength": 64,
                              "pattern": "^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$"
                            },
                            "credits_used": {
                              "type": "number",
                              "minimum": 0,
                              "default": 0
                            },
                            "credit_balance": {
                              "type": "number",
                              "default": 50
                            },
                            "workos_organization_id": {
                              "type": "string"
                            },
                            "branding": {
                              "type": "object",
                              "properties": {
                                "logo_url": {
                                  "type": "string",
                                  "default": "https://api.hermae.com/images/hermae-wordmark-transparent-dark.png",
                                  "description": "Logo for use with the embed."
                                },
                                "primary_color": {
                                  "type": "string",
                                  "minLength": 7,
                                  "maxLength": 7,
                                  "default": "#000000",
                                  "description": "HEX color code for primary brand color."
                                },
                                "hover_color": {
                                  "type": "string",
                                  "minLength": 7,
                                  "maxLength": 7,
                                  "default": "#262d3e",
                                  "description": "HEX color code for primary brand color when hovered."
                                },
                                "text_color_on_primary": {
                                  "type": "string",
                                  "minLength": 7,
                                  "maxLength": 7,
                                  "default": "#ffffff",
                                  "description": "HEX color code for primary brand color when hovered."
                                },
                                "suggested_questions": {
                                  "type": "array",
                                  "items": {
                                    "type": "string",
                                    "maxLength": 48
                                  },
                                  "default": []
                                },
                                "default_hidden": {
                                  "type": "boolean",
                                  "default": false
                                },
                                "default_dark": {
                                  "type": "boolean",
                                  "default": false
                                }
                              },
                              "default": {
                                "logo_url": "https://api.hermae.com/images/hermae-wordmark-transparent-dark.png",
                                "primary_color": "#000000",
                                "hover_color": "#262d3e",
                                "text_color_on_primary": "#ffffff",
                                "default_dark": false,
                                "default_hidden": false,
                                "suggested_questions": []
                              },
                              "additionalProperties": false,
                              "description": "Object to control branding for this organization."
                            },
                            "tier": {
                              "type": "string",
                              "enum": [
                                "enterprise",
                                "standard"
                              ],
                              "default": "standard"
                            },
                            "created_at": {
                              "type": "string"
                            },
                            "object": {
                              "type": "string",
                              "enum": [
                                "organization"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "creator_id",
                            "name",
                            "workos_organization_id",
                            "created_at",
                            "object"
                          ],
                          "description": "An object representing an organization."
                        },
                        "membership": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "user_id": {
                              "type": "string"
                            },
                            "organization_id": {
                              "type": "string"
                            },
                            "workos_membership_id": {
                              "type": "string"
                            },
                            "created_at": {
                              "type": "string"
                            },
                            "object": {
                              "type": "string",
                              "enum": [
                                "membership"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "user_id",
                            "organization_id",
                            "workos_membership_id",
                            "created_at",
                            "object"
                          ]
                        },
                        "space": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string",
                              "maxLength": 16
                            },
                            "organization_id": {
                              "type": "string"
                            },
                            "system_prompt": {
                              "type": "string"
                            },
                            "framework": {
                              "type": "string"
                            },
                            "created_at": {
                              "type": "string"
                            },
                            "object": {
                              "type": "string",
                              "enum": [
                                "space"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "organization_id",
                            "created_at",
                            "object"
                          ]
                        }
                      },
                      "required": [
                        "organization",
                        "membership",
                        "space"
                      ]
                    }
                  },
                  "required": [
                    "status",
                    "returns"
                  ]
                }
              }
            }
          },
          "404": {
            "description": "Resource not found.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "number"
                    },
                    "message": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "message"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 66,
      "2": 111,
      "3": 18,
      "4": 218,
      "5": 98,
      "6": 116,
      "7": 0,
      "8": 18,
      "9": 82,
      "10": 77,
      "11": 93
    }
  }
}
```