Create Organization

Create a new organization.

POST /api/v1/organizations/

Typescript (SDK)

TypeScript

import { openAsBlob } from "node:fs";
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.organizations.create({
    logo: await openAsBlob("example.file"),
    displayName: "My Great Org",
    description: "An organization that does great things with agentic AI",
    domains: "mygreatorg.com,mygreatorg.org",
    samlProviderId: "saml.syllablesso",
  });

  console.log(result);
}

run();

200

{
  "display_name": "<string>",
  "id": 123,
  "name": "<string>",
  "last_updated": "2023-11-07T05:31:56Z",
  "description": "An organization that does great things with agentic AI.",
  "domains": "mygreatorg.com,myothergreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "last_updated_comments": "Updated to add an additional domain",
  "slug": "my-great-org",
  "last_updated_by": "<string>",
  "logo_url": "https://image.png"
}

Authorizations

Syllable-API-Key · string · header · required

Body

multipart/form-data

logo · file · required

The organization logo image file to upload. Must be a PNG file and 120x120 pixels.

display_name · string · required

The human-readable display name of the organization

Example:

"My Great Org"

description · string | null

Description of the organization

Example:

"An organization that does great things with agentic AI"

domains · string | null

Comma-delimited list of domains that users at the organization may have in their email addresses

Example:

"mygreatorg.com,mygreatorg.org"

saml_provider_id · string | null

SAML provider ID for user authentication

Example:

"saml.syllablesso"

Response

200

application/json

Successful Response

display_name · string · required

The human-readable display name of the organization.

Example:

"My Great Org"

id · integer · required

The internal ID of the organization.

Example:

1

name · string · required

Unique, non-human-readable hash for the organization

last_updated · string<date-time> · required

The timestamp of the most recent update to the organization

description · string | null

Description of the organization.

Example:

"An organization that does great things with agentic AI."

domains · string | null

Comma-delimited list of domains that users at the organization may have in their email addresses.

Example:

"mygreatorg.com,myothergreatorg.org"

saml_provider_id · string | null

SAML provider ID for user authentication

Example:

"saml.syllablesso"

last_updated_comments · string | null

Comments for the most recent edit to the organization.

Example:

"Updated to add an additional domain"

slug · string | null

The slug of the organization used for URLs in the Console UI. Null until slug backfill has been run.

Example:

"my-great-org"

last_updated_by · string | null

The email of the user who most recently updated the organization

logo_url · string | null

CDN URL. The org will always have a logo, but this value will be null on a response to an update where no logo was provided on the request

Example:

"https://image.png"