# Rest Api Component

The **REST API** component provides a way for applications to interact with a web-based service through a set of predefined operations or HTTP methods, such as GET, POST, PUT,PATCH, DELETE, etc.

All component configurations are classified broadly into 3 section

* [​Basic Information​](https://docs.bdb.ai/data-pipeline-2/components/component-base-configuration)
* Meta Information
* [Resource Configuration​](https://docs.bdb.ai/data-pipeline-2/components/resource-configuration)

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2FjOCDggwWtpE1AmzY0c9i%2FRest_API__1__AdobeExpress%20(online-video-cutter.com).mp4?alt=media&token=946b42a4-3e40-4f3e-bd09-86799f09bdae>" %}
Configuring Rest API component
{% endembed %}

## **Configuring Meta Information of Rest API component**

<figure><img src="https://content.gitbook.com/content/q2i9CKCFbySxr6jRoJfA/blobs/GJeOCtVpzda0eLPJWK2b/MicrosoftTeams-image%20(17).png" alt=""><figcaption><p>Meta information of Rest API Component</p></figcaption></figure>

* **Source Name:** Provide the name of the source you would like to reference.
* **URL:** It is a unique identifier that specifies the location of a resource on the web.&#x20;
* **Request Type:** The Request Type refers to the HTTP method or operation used to interact with a web service or resource. The most common HTTP methods used in REST APIs are:
  * **GET:** It retrieves data from a resource.&#x20;
  * **POST:** It submits new data to a resource.&#x20;
  * **PUT:** It updates existing data in a resource.&#x20;
  * **DELETE:** It deletes data from a resource.&#x20;
  * **PATCH:** It is to partially update a resource or entity on the server.
* **Query Params:** These are additional parameters that can be passed along with the URL of a request to modify the data returned by an API endpoint
* **Headers:** It refer to the additional information sent in the HTTP request or response along with the actual data.&#x20;
* **Authorization:** It refers to the process of verifying that a user or application has the necessary permissions to access a particular resource or perform a particular action.&#x20;
* **Iteration(s):** It refers to the process of retrieving a collection of resources from a web service in a paginated manner, where each page contains a subset of the overall resource collection.&#x20;
* **Delay(in sec):** It refers to a period of time between when a request is made by a client and when a response is received from the server.
* **Body:** It refers to the data or payload of a request or response message.


---

# 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.bdb.ai/data-pipeline-2/components/transformations/rest-api-component.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.