Universes Management

Create Universe

Create a new universe

POST
https://api.textreveal.com/v3/universes

Request

Request Body

  • name*string

    Name of the universe.

    Example: "Tech Asian companies"
  • type*string (enum)

    Universe visibility and access level.

    • PRIVATE: visible and manageable by the owner only.

    • SHARED: visible to the owner and company members, manageable by the owner.

    • SESAMM: visible to company members, not manageable.

    Values: "PRIVATE", "SHARED", "SESAMM"
  • owneruuid | null

    When present, only the user with this id can manage the universe.

  • companyuuid

    With which company is the universe shared

  • descriptionstring | null

    Description of the universe

    Example: "The Asian companies that are in the Tech sector"
Request
{
  "name": "Tech Asian companies",
  "type": "PRIVATE",
  "owner": "00000000-0000-0000-0000-000000000000",
  "company": "00000000-0000-0000-0000-000000000000",
  "description": "The Asian companies that are in the Tech sector"
}

Response

Response - 200

Universe successfully created

  • universe_id*uuid

    Unique identifier of the universe.

Response
{
  "universe_id": "00000000-0000-0000-0000-000000000000"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "The server returned an unexpected response"
  • code*integer

    Error code.

    Example: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid", "timeout", "offline", "unknown", "not_found", "unauthorized", "forbidden", "internal"
  • errorsobject[]

    Possible error causes, like query params, headers or body.

Response
{
  "message": "The server returned an unexpected response",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "Expected number, received string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Not authorized

  • message*string
    Example: "Not authorized to access this resource"
  • code*number (enum)

    Error code.

    Values: 403
  • reason*string (enum)
    Values: "forbidden"
Response
{
  "message": "Not authorized to access this resource",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

No universe found

  • message*string
    Example: "[record] not found."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)
    Values: "not_found"
Response
{
  "message": "[record] not found.",
  "code": 404,
  "reason": "not_found"
}

Error - 409

Universe with this name already exists

  • message*string
    Example: "duplicated resource"
  • code*number (enum)

    Error code.

    Values: 409
  • reason*string (enum)
    Values: "invalid"
Response
{
  "message": "duplicated resource",
  "code": 409,
  "reason": "invalid"
}