# Partner API Structure

In order to integrate with our Partner Portal, the base URL of all API endpoints is

```
https://partners.clym.io/api/portal
```

When calling API endpoints that change a resource, you must provide a `JSON` request body with the `Content-Type: application/json` HTTP header set. 

When calling API endpoints that perform asset uploading, you must use the multipart/form-data encoding with the `Content-Type: multipart/form-data` HTTP header set and the asset under the `asset` field.

All API endpoints will return `JSON` data with the `Content-Type: application/json` response HTTP header set.

The following status codes can be returned:

| Status code                              | Description                                                                                              |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| <mark style="color:green;">`2xx`</mark>  | Everything worked as expected                                                                            |
| <mark style="color:yellow;">`400`</mark> | The request data was unacceptable, most likely due to missing required params or invalid specified data. |
| <mark style="color:orange;">`401`</mark> | The specified API key is not valid                                                                       |
| <mark style="color:orange;">`403`</mark> | The API key does not have permissions to perform the request.                                            |
| <mark style="color:yellow;">`404`</mark> | The specified API endpoint, resource or requested resource does not exist.                               |
| <mark style="color:yellow;">`429`</mark> | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.         |
| <mark style="color:red;">`5xx`</mark>    | Server errors, something went wrong on Clym's end.                                                       |


---

# Agent Instructions: 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:

```
GET https://docs.clym.io/getting-started/partner-api-structure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.