# Getting Started

All REST API calls will return `JSON or HTML` results.

Our API endpoint is: `https://api.serpdog.io/`

### Uses

Our API is easy to use and is designed to be used by developers.\
\
Here are a few things to consider before we get started:<br>

* The request will be retried until it can be completed (up to 60 seconds). In cases where the request fails in 60 seconds, we will return a 502 error, you will not be charged for the unsuccessful API call(you are only charged for successful requests, 200 status code). Make sure to catch these errors! They will occur on roughly 1-2% of requests.
* &#x20;If you exceed 1000 requests per month on your free plan, you will receive a 403 error.
* &#x20;Each request will return an HTML response or object of arrays with the requested data.

### Error Codes

Handling the HTTP response status codes below is advisable for a smooth scraping experience.

| Error Codes |              Description              |
| :---------: | :-----------------------------------: |
|     200     |          Request Successfull          |
|     404     | User not found or enter a valid query |
|     408     |           Request timed out           |
|     503     |       Request couldn't proceed.       |


---

# 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.serpdog.io/getting-started.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.