Organizations
Manages organizations, projects and launch contexts
Experimental feature: this API is likely to change.
Last updated
Manages organizations, projects and launch contexts
Experimental feature: this API is likely to change.
Last updated
Deletes organization and its related resources. It requires the user to have full permissions (:) to perform the deletion.
Default Response
Deletes a project and its associated resources. Requires write permissions for the project and its children.
Default Response
Default Response
Retrieves details of a specific project within an organization. Access is controlled by read permissions on the project.
The details for a project
The name of the project
Retrieves all the projects associated with a specific organization, returning the list of projects the user has access to based on their permissions.
The data of all the projects in an organization
Allows creating a new project within an organization. The user must have write permissions to the organization to successfully create the project.
The name of the project
The details of the created project
The ID of a project
Updates a project’s attributes, such as the project name. The user needs write permissions on the project to make changes.
The name of the project
The details of the updated project
The name of the project
The details for a webhook endpoint
The generated ID of the webhook endpoint
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The date and time the webhook endpoint was created
The date and time the webhook endpoint was last updated
The list of event types that the webhook endpoint is subscribed to
The details for all webhook endpoints
The generated ID of the webhook endpoint
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The date and time the webhook endpoint was created
The date and time the webhook endpoint was last updated
The list of event types that the webhook endpoint is subscribed to
Allows updating specific fields (like name or featured event) for an organization. It checks for write permissions before processing the request.
The name of an organization
Default Response
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The list of event types that the webhook endpoint is subscribed to
The details of the created webhook endpoint
The generated ID of the webhook endpoint
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The date and time the webhook endpoint was created
The date and time the webhook endpoint was last updated
The list of event types that the webhook endpoint is subscribed to
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The list of event types that the webhook endpoint is subscribed to
The details of the updated webhook endpoint
The generated ID of the webhook endpoint
The description of the webhook endpoint
The URL of the webhook endpoint
Whether the webhook endpoint is disabled
The rate limit for the webhook endpoint
The date and time the webhook endpoint was created
The date and time the webhook endpoint was last updated
The list of event types that the webhook endpoint is subscribed to
Fetches the details of a specific organization by its organizationId. If the organization exists, the data is returned.
The details for an organization
The name of an organization
The ID of an organization
Retrieves details of a slot organization. Ensures the organization is active before returning its data. If the organization is not a slot or inactive, access is forbidden.
The details for an organization
The name of an organization
The ID of an organization
Updates the picture URL for an organization. A file is uploaded, transformed, and stored in Cloud Storage, with the resulting URL saved in the organization's record.
The shape of an organization
The ID of an organization
The name of an organization
The details for all organizations
An organization with permissions
Get the attributes of the given Launch Context.
The attributes of a launch context
Defines whether the launch context is live
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.
Fetches the launch contexts for a specific organization based on the organizationId. Includes relevant project and world information as well as any associated picture URLs.
The launch contexts for an organization
Defines whether the launch context is live
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.
The ID of an organization
The ID of a project
The permission level that the user has over this resource.
Fetches the launch contexts for a specific organization and project based on the organization ID and project ID in the headers. Includes relevant project and world information as well as any associated picture URLs.
The launch cofntexts for an organization
Defines whether the launch context is live
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.
The ID of an organization
The ID of a project
The permission level that the user has over this resource.
This is a legacy field and should avoid being used where possible
Creates a new organization.
The name of an organization
The details of the created organization
The ID of an organization
Updates a launch context's attributes, such as the name. The user needs write permissions on the launch context to make changes.
Defines whether the launch context is live
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.
The details of the updated launch context
Defines whether the launch context is live
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out
^https?://.*$
Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully
^https?://.*$
Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.