Trying out an API

Learn how to try out an API by sending requests and exploring responses with IBM API Studio.

About this task

Exploring an API before using it in your application helps you understand how its endpoints behave and what kind of data it returns. The Tryout feature lets you test API endpoints directly within the IBM API Studio, without relying on external tools. By trying out an API, you validate request structures, review response formats, and confirm that the API behaves as expected.

You can access the Tryout button from the top-right corner or from the Paths and Operations section in the API. When you activate it, the platform automatically pre-populates request details based on the selected API or endpoint. You can test one HTTP method and one endpoint at a time to keep validation focused.

The Tryout panel shows the entire request and response cycle. It displays the HTTP method, URL, parameters, and request body, and it also shows the response, including headers, cookies, and body content. You configure authorization directly within the panel to securely test protected endpoints.

Procedure

  1. From the home page, click the API project that you want to try out.
    The project opens in the explorer.
  2. Open the OpenAPI specification file for the API you want to try out.
  3. Click Try out in the top right corner, or use the Try out button available on each method.

    You can tryout the API directly using the server URL defined in the API specification. If the API is published, the gateway URL also appears under the server URL.

  4. Select the HTTP method and URL to test.
  5. Provide the required details for Parameters, Body, Header, and Authorization, including query/path parameters, request payload, HTTP headers, and authentication details such as API key or token.
  6. Click Send.
    View the response in the Response section.