> For the complete documentation index, see [llms.txt](https://dressx.gitbook.io/dressx-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dressx.gitbook.io/dressx-docs/getting-started/overview.md). # Overview The DRESSX API lets you integrate DRESSX AI fashion tools into your own products, workflows, and applications. You can use the API to build image-based fashion experiences such as virtual try-on, size recommendations, product image generation, jewelry try-on, and related creative automation flows. The documentation is organized to help you move from setup to your first successful API request as quickly as possible. ### Base URL Use the following base URL for the current DRESSX paywall API: ``` https://api.dressxagent.com ``` Endpoint pages in this documentation show paths relative to this base URL. For example: ``` POST https://api.dressxagent.com/api_paywall/size/ask-image-size/ ``` ### Get API Access To start using the API, open the DRESSX API Dashboard: [https://dashboard.dressxagent.com](https://dashboard.dressxagent.com/dashboard) If you are not signed in, you will be redirected to the login page. After signing in, open the Dashboard page and copy your API key from the **API Keys** section. The dashboard also shows available APIs, request pricing, account balance, and recent request history. ### Authentication Paywall API endpoints require an API key. Send your key in the `Api-Key` header: ```http Api-Key: drx_live_1234567890abcdef1234567890abcdef1234567890abcdef ``` Some endpoints also accept `X-Api-Key`. For full details, see the Authentication page. ### How to Use These Docs Use the sidebar to navigate between API sections. Each endpoint page includes: * The request URL and HTTP method. * Required and optional parameters. * Supported request formats. * Example `curl` requests. * Example responses. * Polling instructions for asynchronous tasks. * Common error responses. Most image-generation APIs are asynchronous: the create request returns a task ID, and you poll for the final result image. Utility APIs, such as size estimation, may return results synchronously. ### Recommended First Steps 1. Sign in to the [DRESSX API Dashboard](https://dashboard.dressxagent.com/dashboard). 2. Copy your API key from the **API Keys** section. 3. Review the Authentication page. 4. Choose the API endpoint that matches your workflow. 5. Send a test request using one of the provided `curl` examples. ### Support If you need access to additional APIs, have questions about your API key, or need help with integration, contact your DRESSX administrator or support contact. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://dressx.gitbook.io/dressx-docs/getting-started/overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.