Skip to main content
GET
Get the pre-built Copilot widgets

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Response

Returns the widget catalog and the default space.

The widget catalog plus the space derived from it. Unscoped - the catalog is the same for every Project, and the create dialog reads it before any Copilot config exists, to size a new one's default space from the sum of the widget heights.

widgets
object[]
defaultSpace
object

How much room the Copilot has in the agent's workspace.

Last modified on September 30, 2026