> For the complete documentation index, see [llms.txt](https://play.docs.nexx.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://play.docs.nexx.cloud/other-integration-options/oembed.md).

# oEmbed Discovery

Many Third-Party Services rely on an oEmbed Discovery Service, integrated into a Website. Although nexxPLAY cannot embed the oEmbed Discovery Link directly, nexxOMNIA can construct the necessary oEmbed URL, that can be integrated into your Frontends. This oEmbed Link can also be obtained by using the nexxOMNIA API.

You integrate the oEmbed Discovery Link like this:

```markup
<link rel="alternate" type="application/json+oembed" 
href="https://services.nexx.cloud/oembed/json?url=URL">
```

Per Default, the oEmbed Service returns JSON - if you need XML, the URL and Mimetype would look like this:

```markup
<link rel="alternate" type="text/xml+oembed" 
href="https://services.nexx.cloud/oembed/xml?url=URL">
```

The URL Attribute is normally the current Webpage. If Embedding is allowed in the nexxOMNIA Settings and nexxOMNIA can find the Media Object URL (with a corresponding /slug Attribute or a Domain Media Template), the oEmbed Service will return a valid oEmbed Response (in JSON or XML, exposing all necessary Metadata for the target iFrame).

Furthermore, the oEmbed Service will also respond to Calls with a Shortcut URL like the following:

```markup
/:domainid/:streamtype/:mediahash/:deliverypartner
```

{% hint style="info" %}
&#x20;The **:domainid** Parameter is the Domain ID of the Media Object
{% endhint %}

{% hint style="info" %}
&#x20;The **:streamtype** Parameter is the Media Type
{% endhint %}

{% hint style="info" %}
&#x20;The **:mediahash** Parameter is the Hash ID of the Media Object
{% endhint %}

{% hint style="info" %}
&#x20;The **:deliverypartner** Parameter is optional. If given, it must be the ID of an exisiting Delivery Partner of the Domain of the Media Object.
{% endhint %}

Both URL Building Options support the following oEmbed Standard Parameters:

| Parameter     | Description                                                                                                            |
| ------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **maxwidth**  | the desired Width of the iFrame. If omitted, the default Value will be 640px (or, in Case of a Portrait Media, 360px)  |
| **maxheight** | the desired Height of the iFrame. If omitted, the default Value will be 360px (or, in Case of a Portrait Media, 640px) |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://play.docs.nexx.cloud/other-integration-options/oembed.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.