# Getting Started

The Ping Proxies API is organized around the [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). The API has predictable resource-and-operation-oriented URLs.

Data is accepted through either path parameters, query parameters or JSON-encoded request bodies depending on the request method with the relationship between method and data ingress type remaining consistent throughout. 

Reponses are returned as JSON-encoded responses and uses consistent HTTP response codes.

### **Redoc Document**

{% embed url="<https://development.api.private.user.pingproxies.com/1.0/private/user/documentation/redoc>" %}

### OpenAPI Specification

{% embed url="<https://development.api.private.user.pingproxies.com/1.0/private/user/documentation/openapi.json>" %}


---

# 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://internal.developer.documentation.private.user.pingproxies.com/basic-concepts/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.