# Response Objects

The API responds with JSON-encoded objects and has a standardized response structure which is the basic template for all responses. Some operations return additional information with this basic structure and any raw data that is returned is sent under the key `data`.

**Basic Success Response Object**

```
{"message":"A describing the effect of the operation"}, 200
```

**Basic Error Response Object**

In this example, we use 404 Not Found as the error.

```
{"message":"A describing the error", "error_id": "xIxTs","error": "Not Found"}, 404
```

**Basic Retrieve Response Object**

```
{"message":"A describing the operation", "data": Proxy}, 200
```

**Basic Search Response Object**

In this example, a single proxy is returned by our search operation and filter.

```
{"message":"A describing the operation", "count": 1, "data": [Proxy]}, 200
```

In this example, a no proxy is returned by our search operation and filter.

```
{"message":"A describing the operation", "count": 0, "data": []}, 200
```

**Basic Create Response Object**

In this example, an authentication has been created with authentication\_id 123

```
{"message":"A describing the operation", "created": [123]}, 201
```

**Basic Create Response Object**

In this example, an authentication has been deleted with authentication\_id 123

```
{"message":"A describing the operation", "deleted": [123]}, 200
```

**Basic Edit Response Object**

In this example, an authentication has been edited with authentication\_id 123

```
{"message":"A describing the operation", "edited": [123]}, 200
```


---

# 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/response-objects.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.
