---
schema_version: "1"
id: c37e40046a9d523c35170fa9acd08493759b817d7cd872e5e289690ae54449da
title: Testing APIs in the API Playground (Beta)
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/general/exp-playground-api.md
canonical_url: https://docs.mulesoft.com/general/exp-playground-api
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 6b1ee15e1e72806978fdb8b25e168f687d13b0c18eab0a9c59bd051b3336da20
description: MuleSoft Documentation Site
latest: true
---
---
product: Getting Started
keywords: api playground, test api, api endpoints, api authentication, request snippet, api response, anypoint platform, enhanced experience
---

# Testing APIs in the API Playground (Beta)

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use the API playground to explore an API’s endpoints, configure and send requests, and inspect
responses from the service detail page. Instead of copying paths into an external tool such as
Postman, you exercise the API in the enhanced experience and see the results next to its
documentation.

> [!NOTE] The API playground is a pilot or beta service that is subject to the Beta Services Terms
> at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified
> Pilot Agreement if executed by Customer, and applicable terms in the
> [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992).
> Use of this pilot or beta service is at the Customer’s sole discretion.

## Before You Begin

Before getting started, make sure you have:

- An Anypoint Platform account.

- One of these permissions:

  - Exchange: Exchange Viewer

  - Exchange: Exchange Contributor

  - Exchange: Exchange Administrator

  For more information, see [Enhanced Experience Permissions](https://docs.mulesoft.com/general/exp-home-start#permissions).

## Open the API Playground

The API playground is available only for REST APIs that have at least one instance deployed. To find
a compatible API, filter the catalog by REST API or select a REST API you know.

1.  In **Portfolio**, open the **APIs** catalog and select the REST API you want to test.

2.  On the service detail page, select the **Playground** tab.

The playground shows the endpoint list on the left. Each endpoint has its own required parameters
and configuration.

## Select an Endpoint and Environment

1.  In the endpoint list, select the endpoint you want to test (for example, a **POST** endpoint
    that creates a new record).

2.  Select the version and instance to choose the environment you want to test against.

## Configure Authentication

Before sending a request, authenticate to the API. The available methods depend on what the API
owner enabled.

1.  In the authentication section, select an authentication method. If the API owner enabled only
    one method (for example, API key), use that method.

2.  Enter the required values, such as the API key.

## Configure the Request

After authenticating, configure the details of the request:

Body

Configure the request body in the format the endpoint expects, such as JSON, XML, form, or
multipart. Multipart supports file upload.

Parameters

Add and configure request parameters.

Headers

Add and configure request headers.

### Copy the Request Snippet

The playground generates a request snippet that reflects your current configuration. As you change
the authentication, body, parameters, or headers, the snippet updates to match.

1.  Select the format you want for the snippet.

2.  Copy the snippet to use it outside the playground.

## Send the Request and Review the Response

1.  After configuring the request, select **Send**.

2.  Review the response:

    - **Status code**, along with the response size and speed.

    - **Response body**.

    - **Response headers**, which you can copy.

## Review Request History

After you test several requests or endpoints within an API, the playground keeps a history of your
configurations. Open the history to review a previous request or return to an earlier configuration.

## See Also

- [Testing Services with Playgrounds (Beta)](https://docs.mulesoft.com/general/exp-playground-overview)

- [Exploring MCP Server Tools in the MCP Playground (Beta)](https://docs.mulesoft.com/general/exp-playground-mcp)

- [Viewing Service Details in the Portfolio](https://docs.mulesoft.com/general/exp-services-view-details)

- [Creating and Managing Instances of Services](https://docs.mulesoft.com/general/exp-instances-add)