The Client SDKs section helps you find the information needed to start using an API from a supported client environment. Use it when you are reading API Reference documentation and need guidance before making your first API request.
Overview
In your project’s Technical Docs area, the API Reference documentation can include a Client SDKs section. This section presents client SDK information alongside the API reference so you can move from understanding an endpoint to initializing a client for your application.
The section is most useful when you need to connect an application to an API rather than review API operations alone. Look for the Initialize Client or Initialize the Client action when you are ready to begin setup.
Client SDK information is part of technical documentation. If you are looking for task-focused help for business users instead, use 📋 User Manuals or User Guides where available.
📷 Screenshot pending: API Reference documentation showing the Client SDKs section and the Initialize Client action.
Terms used on this page
- Technical Docs
- Documentation for technical implementation and system reference material.
- API Reference
- The area of Technical Docs where you review API-related information, including client SDK guidance when it is available.
- Client SDK
- A client library or integration resource that helps your application work with an API.
- Initialize Client
- An on-screen action that begins the client setup guidance or displays initialization information.
Prerequisites
Before you use the Client SDKs section, make sure that:
- You have access to the relevant project in Atloria.
- You can open the project’s Technical Docs area.
- API documentation is available or has been generated for the project.
- You are viewing API Reference, rather than only User Guides or 📋 User Manuals.
- You know which application or environment you want to connect to the API.
- You have the connection details, credentials, or configuration values required by your organization, if applicable.
Note: If API reference content is not available yet, use Generate Documentation → or Generate section where those actions are available to create or update documentation content.
Step-by-Step Instructions
-
Open your project’s documentation area.
From your project, select Technical Docs. This opens the technical documentation workspace for the project. -
Open the API reference.
Select API Reference to view API-focused documentation. The API Reference view is where client SDK information is presented when it is included in your documentation. -
Locate the Client SDKs section.
Review the API Reference content for the section that introduces client SDK information. Use this section to understand the available client setup information before you begin integration work. -
Start client setup.
Select Initialize Client. In some documentation content, the same action may be shown as Initialize the Client. Follow the displayed initialization guidance for the client environment you are using. -
Review the setup details before continuing.
Confirm that the client information matches the application you are configuring. Pay particular attention to any values you must supply from your organization, such as environment-specific connection settings or access credentials. -
Continue to the relevant API content.
After reviewing client initialization information, continue using API Reference to find the API operations your application needs. The client setup step prepares you to use those operations from your chosen client environment. -
Generate or refresh documentation if information is missing.
If the expected client SDK details do not appear, select Generate section to generate the current section, or select Generate Documentation → to generate documentation more broadly. If you already maintain documentation elsewhere, select Or import existing documentation instead.
📷 Screenshot pending: The Initialize Client action within API Reference documentation.
What to select
| Your goal | Where to go | Action to use |
|---|---|---|
| Find client SDK setup information | Technical Docs → API Reference | Locate the Client SDKs section |
| Begin setup guidance | Client SDKs section | Initialize Client or Initialize the Client |
| Create missing documentation content | Technical Docs | Generate section |
| Generate documentation more broadly | Technical Docs | Generate Documentation → |
| Bring in documentation you already have | Technical Docs | Or import existing documentation |
| Read end-user guidance instead of API material | 📋 User Manuals or User Guides | Open the applicable guide |
Tips and Best Practices
-
Start in API Reference for integration work.
The Client SDKs section is intended for API-related implementation information. Use API Reference rather than User Guides when you need to initialize a client or work with API operations. -
Treat client initialization as an early setup step.
Review the Client SDKs section before attempting to use individual API operations. This helps you identify the required setup information first. -
Use the label shown in your documentation.
Depending on the content being displayed, you may see Initialize Client or Initialize the Client. Both labels indicate the client initialization step. -
Keep technical and end-user documentation separate.
Use Technical Docs for API reference and client SDK information. Use 📋 User Manuals for user-facing procedures and help content. This keeps your audience in the right documentation type. -
Generate only what you need when possible.
If only the Client SDKs information is missing or outdated, use Generate section rather than regenerating all documentation. Use Generate Documentation → when you need a broader refresh. -
Import existing material when it is authoritative.
If your organization already has approved SDK or integration guidance, choose Or import existing documentation so the technical documentation can reflect that material.
Related Pages
- Open Technical Docs — Access the project’s technical documentation workspace.
- Use API Reference — Review API operations and related reference information.
- Generate Documentation — Create or refresh documentation using Generate Documentation →.
- Generate a Documentation Section — Update a specific area using Generate section.
- Import Existing Documentation — Use Or import existing documentation to bring in existing content.
- Use User Manuals — Find user-facing procedures under 📋 User Manuals.
- Use User Guides — Access task-oriented guidance through User Guides.
Troubleshooting
| Issue | Possible cause | What to do |
|---|---|---|
| You cannot find the Client SDKs section. | You may be viewing a different documentation type or the API reference content has not been generated. | Open Technical Docs, then select API Reference. If the section is still unavailable, use Generate section or Generate Documentation →. |
| You see User Guides or 📋 User Manuals, but not API client information. | You are in end-user documentation rather than technical API documentation. | Return to Technical Docs and open API Reference. |
| The Initialize Client action is not shown. | The documentation may use the alternate label, or the client SDK content may not be present. | Look for Initialize the Client. If neither action appears, generate or import the relevant documentation content. |
📷 Screenshot pending: Technical Docs showing Generate section, Generate Documentation, and Or import existing documentation actions.
Was this page helpful?