> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/metodi-1/ua/api-docs-ua/eng.md). # ENG ### General information This section contains API methods for integration **with services within Ukraine**. {% hint style="info" %} The corresponding API documentation is available **only in Ukrainian**, as this functionality is intended exclusively for domestic shipments. If you are looking for a universal solution for shipments both within Ukraine and abroad, please visit the [**API Docs Int**](https://api-portal.novapost.com/metodi-1/). section. {% endhint %} ### Аuthorization To start working with the functionality, you need to generate an API key and include it in your requests. For more details, visit the [**Api Key Generation**](/novaposhta-docs/integration-guide/api-key-generation.md) page. ### Endpoints **JSON:** **XML:** ### Request format Data exchange is performed via HTTPS using the POST or GET method, sent to the appropriate endpoint depending on the request type (XML or JSON). The format in the URL path must be specified in lowercase (e.g, ). ### Response format The API always returns an HTTP 200 OK response status code, even when logical or validation errors occur within the payload. --- # 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://api-portal.novapost.com/metodi-1/ua/api-docs-ua/eng.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.