Skip to main content

HTTP API reference › Gala Launchpad › oembed

Gala Launchpad — oembed

5 operations in this group.

GET /oembed​

OEmbedController_getHomeOEmbed

Home oEmbed

Get oEmbed data for home page with trending token info

Parameters​

NameInRequiredTypeDescription
formatqueryoptionalstring enum: json

Responses​

200 — Returns the oEmbed JSON body when format=json, otherwise an HTML preview page.​

Content type: application/json

Schema: OEmbedJsonResponseDto

FieldTypeRequiredDescription
author_namestringyes
provider_namestringyes
provider_urlstring (uri)yes
thumbnail_heightnumberyes
thumbnail_urlstring (uri)yes
thumbnail_widthnumberyes
titlestringyes
typestring enum: linkyes
versionstring enum: 1.0yes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

500 — Internal server error - failed to generate oEmbed data.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

GET /oembed/buy-sell/&#123;tokenName&#125;​

OEmbedController_getPoolOEmbed

Pool oEmbed

Get oEmbed data for a token pool page

Parameters​

NameInRequiredTypeDescription
tokenNamepathrequiredstring
formatqueryoptionalstring enum: json

Responses​

200 — Returns the oEmbed JSON body when format=json, otherwise an HTML preview page.​

Content type: application/json

Schema: OEmbedJsonResponseDto

FieldTypeRequiredDescription
author_namestringyes
provider_namestringyes
provider_urlstring (uri)yes
thumbnail_heightnumberyes
thumbnail_urlstring (uri)yes
thumbnail_widthnumberyes
titlestringyes
typestring enum: linkyes
versionstring enum: 1.0yes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

404 — Not found - token does not exist.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

500 — Internal server error - failed to generate oEmbed data.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

GET /oembed/profile/&#123;address&#125;​

OEmbedController_getProfileOEmbed

Profile oEmbed

Get oEmbed data for a user profile page

Parameters​

NameInRequiredTypeDescription
addresspathrequiredstring
formatqueryoptionalstring enum: json

Responses​

200 — Returns the oEmbed JSON body when format=json, otherwise an HTML preview page.​

Content type: application/json

Schema: OEmbedJsonResponseDto

FieldTypeRequiredDescription
author_namestringyes
provider_namestringyes
provider_urlstring (uri)yes
thumbnail_heightnumberyes
thumbnail_urlstring (uri)yes
thumbnail_widthnumberyes
titlestringyes
typestring enum: linkyes
versionstring enum: 1.0yes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

404 — Not found - profile does not exist.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

500 — Internal server error - failed to generate oEmbed data.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

GET /oembed/t/&#123;tokenName&#125;​

OEmbedController_getPoolOEmbedShortUrl

Pool oEmbed (short URL)

Short URL for token pool oEmbed (/t/:tokenName)

Parameters​

NameInRequiredTypeDescription
tokenNamepathrequiredstring
formatqueryoptionalstring enum: json

Responses​

200 — Returns the oEmbed JSON body when format=json, otherwise an HTML preview page.​

Content type: application/json

Schema: OEmbedJsonResponseDto

FieldTypeRequiredDescription
author_namestringyes
provider_namestringyes
provider_urlstring (uri)yes
thumbnail_heightnumberyes
thumbnail_urlstring (uri)yes
thumbnail_widthnumberyes
titlestringyes
typestring enum: linkyes
versionstring enum: 1.0yes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

404 — Not found - token does not exist.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

500 — Internal server error - failed to generate oEmbed data.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

GET /oembed/u/&#123;address&#125;​

OEmbedController_getProfileOEmbedShortUrl

Profile oEmbed (short URL)

Short URL for user profile oEmbed (/u/:address)

Parameters​

NameInRequiredTypeDescription
addresspathrequiredstring
formatqueryoptionalstring enum: json

Responses​

200 — Returns the oEmbed JSON body when format=json, otherwise an HTML preview page.​

Content type: application/json

Schema: OEmbedJsonResponseDto

FieldTypeRequiredDescription
author_namestringyes
provider_namestringyes
provider_urlstring (uri)yes
thumbnail_heightnumberyes
thumbnail_urlstring (uri)yes
thumbnail_widthnumberyes
titlestringyes
typestring enum: linkyes
versionstring enum: 1.0yes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

404 — Not found - profile does not exist.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

Content type: text/html

Schema: string

FieldTypeRequiredDescription
valuestringno

500 — Internal server error - failed to generate oEmbed data.​

Content type: application/json

Schema: OEmbedErrorResponseDto

FieldTypeRequiredDescription
errorboolean enum: trueyes
messagestringyes
statusnumberyes

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

Previous group: stream-chat · Next group: Platform Config