>>

Create Sphere

This route requires a valid Authorization header.

POST/spheres

Create a new sphere.

A user can only own up to 100 spheres at once, if you, for any reason need to create more, you’ll need to delete some of your spheres.

If you still aren’t allowed to create a sphere after doing so, then you will have to wait for the server to run its scheduled cleanup to actually remove the old sphere data from the database. This limitation is imposed to avoid abuse.

>>

Request Body
FieldTypeDescription
slugStringThe slug of the sphere. This field has to be between 1 and 32 characters.
typeSphereTypeThe sphere’s type.
nameString?The sphere’s display name. This field has to be between 1 and 32 characters.
descriptionString?The sphere’s description. This field has to be between 1 and 4096 characters.
icon?NumberThe sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket.
banner?NumberThe sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket.
>>

Response

200Sphere

FieldTypeDescription
idNumberThe spheres’s ID.
owner_idNumberThe ID of the sphere’s owner.
name?StringThe name of the sphere.
slugStringThe slug of the sphere.
typeSphereTypeThe sphere’s type.
description?StringThe sphere’s description, can be between 1 and 4096 characters.
icon?NumberThe sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket.
banner?NumberThe sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket.
badgesNumberThe sphere’s badges as a bitfield.
categoriesArray of CategorysThe categories that this sphere contains.
membersArray of MembersThe members that are inside this sphere.
emojisArray of EmojisThe emojis that this sphere has.
>>

Example

 
curl \
  -H "Authorization: <token>" \
  --json '{"slug":"horse","type":"Hybrid"}'
  https://api.eludris.gay/spheres

{
  "id": 4204171493377,
  "owner_id": 4203748065281,
  "slug": "horse",
  "type": "HYBRID",
  "badges": 0,
  "channels": [{
      "type": "TEXT",
      "id": 4204171493378,
      "sphere_id": 4204171493377,
      "name": "general",
      "position": 0
    }]
}