> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/welcome.md).

# Welcome

This section is the starting point for anyone who wants to integrate, extend, or automate workflows around equipme. The APIs and technical references you’ll find here are built to support real production systems, not isolated experiments.

equipme is designed around clear structures, predictable lifecycles, and explicit responsibilities. The APIs reflect that philosophy. Resources are intentionally modeled, relationships are explicit, and actions follow defined states rather than hidden side effects.

#### Two contexts, one platform

equipme exposes APIs for two different but connected contexts:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><p><strong>equipme app</strong></p><p>focuses on application-level interactions such as users, assets, services, and assignments. This is where integrations typically connect HR systems, inventory sources, or internal tools.</p></td><td><a href="https://3161069842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTpKsWHNvbxnWLdatT7G8%2Fuploads%2F5KOstOYhdNODKpYype3w%2FAPI%20APP.png?alt=media&#x26;token=0e76c610-b9d0-41a7-9b2c-4419949e6b92">https://3161069842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTpKsWHNvbxnWLdatT7G8%2Fuploads%2F5KOstOYhdNODKpYype3w%2FAPI%20APP.png?alt=media&#x26;token=0e76c610-b9d0-41a7-9b2c-4419949e6b92</a></td><td><a href="/development/api-reference-app.md">API Reference APP</a></td></tr><tr><td><p><strong>equipme pro</strong></p><p>focuses on provider-level operations such as customers, service portfolios, fulfillment, and operational processes. These APIs are designed for scalable, long-running integrations on the provider side.</p></td><td><a href="https://3161069842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTpKsWHNvbxnWLdatT7G8%2Fuploads%2FUpmBEaKqUAwrawsH2345%2FAPI%20PRO.png?alt=media&#x26;token=f825a0fa-0cfd-4847-86ad-0f2f19dbb0cc">https://3161069842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTpKsWHNvbxnWLdatT7G8%2Fuploads%2FUpmBEaKqUAwrawsH2345%2FAPI%20PRO.png?alt=media&#x26;token=f825a0fa-0cfd-4847-86ad-0f2f19dbb0cc</a></td><td><a href="/development/api-reference-pro.md">API Reference PRO</a></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/development/welcome.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
