Read API Reference Content

Use the API Reference section in published technical documentation to understand available endpoints, request and response schemas, SDK guidance, and code examples. This helps you integrate with an API using the information that has been reviewed and made available to readers.

Overview

Published documentation gives you a reader-focused view of technical content without requiring access to the documentation workspace. When documentation is ready for external or internal audiences, you can open it through View Published Docs or 🌐 View Published Docs and navigate to API Reference.

The API Reference content is intended to help you answer practical integration questions, such as what an endpoint does, what information it accepts, what it returns, and how to use it in an application. Depending on the published documentation, you may find endpoint descriptions, schema details, SDK information, and code examples.

Use this page when you need to review an API before implementing an integration, verify the structure of data sent to or returned by an API, or copy an example into your own development environment. If documentation includes a schema download, you can also select Download JSON Schema for a machine-readable version of the documented schema.

📷 Screenshot pending: Published documentation open to the API Reference section, showing endpoint content and available actions.

Prerequisites

Before you begin, make sure that:

• You have access to the published documentation for the relevant project.
• The documentation has a Published or 3. Published Status state.
• You know the API area, endpoint, schema, or SDK topic you need to review.
• Your browser allows you to download files if you plan to use Download JSON Schema.
• You have an appropriate development environment available if you plan to use copied code examples.

Step-by-Step Instructions

1. Open the published documentation.
   From the documentation area, select View Published Docs. In some locations, this action is shown as 🌐 View Published Docs.

   The published documentation opens in its reader view. This view is designed for reading and using documentation that is already available to its intended audience.

2. Confirm that you are reading published content.
   Look for the Published or 3. Published Status indicator where it is shown. Published content is the version intended for readers; draft content may still be changing.

3. Open the API Reference section.
   In the published documentation navigation, select API Reference.

   Review the section headings and endpoint entries to find the API capability you need. Start with the endpoint or operation that most closely matches your task, rather than reading unrelated entries.

4. Read the endpoint information.
   For each relevant endpoint, review the available description and supporting details. Focus on:

   • The purpose of the endpoint
   • The data you need to provide
   • The expected returned data
   • Any schema information shown for the request or response
   • Available SDK guidance or examples

   Use the schema details to check field names, expected data types, and nesting before you build your request or consume a response.

5. Review code examples.
   When code examples are included, use them as a starting point for your implementation. Compare the example values with your own environment and requirements before using them.

   To copy an example, select Copy next to the code block. Paste the copied content into your development environment, then replace any sample values with the values required for your organization.

6. Use SDK information when it is provided.
   If the API Reference includes SDK-specific instructions or examples, select the SDK language or format that matches your application. Follow the example’s sequence carefully, including setup, request construction, and response handling where documented.

7. Download the schema when needed.
   Select Download JSON Schema to save the available schema file. You can use the downloaded file for validation, tooling, or to compare the published structure with your implementation.

8. Return to the documentation navigation when finished.
   Use the published documentation navigation to continue to another technical topic. If you need a broader introduction before using an endpoint, open the applicable Technical documentation section.

📷 Screenshot pending: API Reference entry with schema details, a code example, and the Copy action.

Tips and Best Practices

• Use published content for implementation decisions.
  Read content marked Published when you need the version intended for use. Do not assume that unfinished or draft material reflects the final API behavior.

• Read the description before copying an example.
  A code example shows one way to use an API, but the surrounding endpoint and schema information explains when that example applies.

• Validate against the schema.
  If you download the JSON Schema, use it to verify that your request payloads and response handling match the documented structure. This is especially useful for nested objects and fields that may be optional or required.

• Treat sample values as examples.
  Replace demonstration values, identifiers, and configuration details with values appropriate to your environment. Do not copy example data into a production workflow without reviewing it.

• Keep copied examples traceable.
  When you use Copy, record the API Reference topic or endpoint that the example came from. This makes it easier to revisit the published guidance when the documentation is updated.

API Reference terms

Endpoint

A documented API operation that you can use to perform a specific task or retrieve information.

Schema

A structured description of data, including fields and their expected format.

SDK

A software development kit that provides language-specific tools or examples for working with an API.

Code example

A sample implementation that demonstrates how to call or use documented API functionality.

JSON Schema

A downloadable structured definition that can be used by compatible tools to validate JSON data.

Related Pages

• View Published Documentation
• Navigate Technical Documentation
• Download JSON Schema
• Use Code Examples in Documentation
• Understand Documentation Publication Status

Troubleshooting