> For the complete documentation index, see [llms.txt](https://developer.goshiip.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.goshiip.com/getting-started/request-formats-responses.md).

# Request Format & Responses

## Base URLs

* SANDBOX BASE URL: [https://delivery-staging.apiideraos.com/api/v2/token](<https://delivery-staging.apiideraos.com/api/v2&#xA;/token/user/myprofile>)
* PRODUCTION BASE URL: [https://delivery.apiideraos.com/api/v2/token](<https://delivery-staging.apiideraos.com/api/v2&#xA;/token/user/myprofile>)

### Request Header

Shiip uses Bearer Authentication to securely authenticate API requests. To authorize your requests, you need to include an `Authorization` header in every API call. The header should follow this format:

`Authorization: Bearer <API_KEY>`

Here, `<API_KEY>` is your unique secret key, which is required for each request to validate your access. This token must be kept secure, as it grants access to your account's API functionality. Without the correct Bearer token in the header, requests to the API will be denied.

### Response Sample

Our JSON responses adhere to a consistent format, which includes the following fields:

* **status**: Indicates the overall success(true) or failure(false) of the request.&#x20;
* **message**: Provides a descriptive message or error details relevant to the request.
* **data**: Contains the main content or payload of the response, which varies based on the API endpoint.
* **status\_code**: Represents the HTTP status code associated with the response, reflecting the outcome of the request.

This structured format ensures that responses are uniform and easily interpretable, facilitating effective error handling and data processing.


---

# 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://developer.goshiip.com/getting-started/request-formats-responses.md?ask=<question>&goal=<endgoal>
```

`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.