Co-authored-by: octavia-bot-hoard[bot] <230633153+octavia-bot-hoard[bot]@users.noreply.github.com>
138 lines
9.1 KiB
Markdown
138 lines
9.1 KiB
Markdown
# Pexels-API
|
|
|
|
This page contains the setup guide and reference information for the [Pexels-API](https://www.pexels.com/api/documentation) source connector.
|
|
|
|
## Prerequisites
|
|
|
|
Api key is mandate for this connector to work, It could be generated by a gmail account for free at https://www.pexels.com/api/new/.
|
|
Just pass the generated API key and optional parameters for establishing the connection.
|
|
|
|
## Setup guide
|
|
|
|
### Step 1: Set up Pexels-API connection
|
|
|
|
- Generate an API key (Example: 12345)
|
|
- Params (If specific info is needed)
|
|
- Available params
|
|
- query: Ocean, Tigers, Pears, etc. Default is people
|
|
- orientation: landscape, portrait or square. Default is landscape
|
|
- size: large, medium, small. Default is large
|
|
- color: red, orange, yellow, green, turquoise, blue, violet, pink, brown, black, gray, white or any hexidecimal color code.
|
|
- locale: en-US, pt-BR, es-ES, ca-ES, de-DE, it-IT, fr-FR, sv-SE, id-ID, pl-PL, ja-JP, zh-TW, zh-CN, ko-KR, th-TH, nl-NL, hu-HU, vi-VN, cs-CZ, da-DK, fi-FI, uk-UA, el-GR, ro-RO, nb-NO, sk-SK, tr-TR, ru-RU. Default is en-US
|
|
|
|
## Step 2: Set up the Pexels-APIs connector in Airbyte
|
|
|
|
### For Airbyte Cloud:
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
|
|
3. On the Set up the source page, enter the name for the Pexels-API connector and select **Pexels-API** from the Source type dropdown.
|
|
4. Enter your `api_key`.
|
|
5. Enter the params configuration if needed. Supported params are: query, orientation, size, color, locale, collection_id \
|
|
video_id, photo_id
|
|
6. Click **Set up source**.
|
|
|
|
### For Airbyte OSS:
|
|
|
|
1. Navigate to the Airbyte Open Source dashboard.
|
|
2. Set the name for your source.
|
|
3. Enter your `api_key`.
|
|
4. Enter the params configuration if needed. Supported params are: query, orientation, size, color, locale, collection_id \
|
|
video_id, photo_id
|
|
5. Click **Set up source**.
|
|
|
|
## Supported sync modes
|
|
|
|
The Pexels-API source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
| Feature | Supported? |
|
|
| :---------------------------- | :--------- |
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | No |
|
|
| Replicate Incremental Deletes | No |
|
|
| SSL connection | Yes |
|
|
| Namespaces | No |
|
|
|
|
## Supported Streams
|
|
|
|
- photos_search
|
|
- photos_curated
|
|
- videos_search
|
|
- videos_popular
|
|
- collection_featured
|
|
|
|
## API method example
|
|
|
|
`GET https://api.pexels.com/v1/curated?per_page=1`
|
|
|
|
## Performance considerations
|
|
|
|
Pexels-API's [API reference]https://www.pexels.com/api/documentation) has v1 at present and v2 is at development. The connector as default uses v1.
|
|
|
|
## Changelog
|
|
|
|
<details>
|
|
<summary>Expand to review</summary>
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :------ | :--------- | :------------------------------------------------------ | :------------- |
|
|
| 0.2.41 | 2025-11-25 | [69993](https://github.com/airbytehq/airbyte/pull/69993) | Update dependencies |
|
|
| 0.2.40 | 2025-11-18 | [69635](https://github.com/airbytehq/airbyte/pull/69635) | Update dependencies |
|
|
| 0.2.39 | 2025-10-29 | [68954](https://github.com/airbytehq/airbyte/pull/68954) | Update dependencies |
|
|
| 0.2.38 | 2025-10-21 | [68267](https://github.com/airbytehq/airbyte/pull/68267) | Update dependencies |
|
|
| 0.2.37 | 2025-10-14 | [67825](https://github.com/airbytehq/airbyte/pull/67825) | Update dependencies |
|
|
| 0.2.36 | 2025-10-07 | [67496](https://github.com/airbytehq/airbyte/pull/67496) | Update dependencies |
|
|
| 0.2.35 | 2025-09-30 | [66963](https://github.com/airbytehq/airbyte/pull/66963) | Update dependencies |
|
|
| 0.2.34 | 2025-09-23 | [66413](https://github.com/airbytehq/airbyte/pull/66413) | Update dependencies |
|
|
| 0.2.33 | 2025-09-09 | [65882](https://github.com/airbytehq/airbyte/pull/65882) | Update dependencies |
|
|
| 0.2.32 | 2025-08-23 | [65221](https://github.com/airbytehq/airbyte/pull/65221) | Update dependencies |
|
|
| 0.2.31 | 2025-08-09 | [64735](https://github.com/airbytehq/airbyte/pull/64735) | Update dependencies |
|
|
| 0.2.30 | 2025-08-02 | [64217](https://github.com/airbytehq/airbyte/pull/64217) | Update dependencies |
|
|
| 0.2.29 | 2025-07-26 | [63827](https://github.com/airbytehq/airbyte/pull/63827) | Update dependencies |
|
|
| 0.2.28 | 2025-07-19 | [63420](https://github.com/airbytehq/airbyte/pull/63420) | Update dependencies |
|
|
| 0.2.27 | 2025-07-12 | [63234](https://github.com/airbytehq/airbyte/pull/63234) | Update dependencies |
|
|
| 0.2.26 | 2025-07-05 | [62577](https://github.com/airbytehq/airbyte/pull/62577) | Update dependencies |
|
|
| 0.2.25 | 2025-06-28 | [62363](https://github.com/airbytehq/airbyte/pull/62363) | Update dependencies |
|
|
| 0.2.24 | 2025-06-21 | [61933](https://github.com/airbytehq/airbyte/pull/61933) | Update dependencies |
|
|
| 0.2.23 | 2025-06-14 | [60548](https://github.com/airbytehq/airbyte/pull/60548) | Update dependencies |
|
|
| 0.2.22 | 2025-05-10 | [60094](https://github.com/airbytehq/airbyte/pull/60094) | Update dependencies |
|
|
| 0.2.21 | 2025-05-04 | [59049](https://github.com/airbytehq/airbyte/pull/59049) | Update dependencies |
|
|
| 0.2.20 | 2025-04-19 | [58479](https://github.com/airbytehq/airbyte/pull/58479) | Update dependencies |
|
|
| 0.2.19 | 2025-04-12 | [57851](https://github.com/airbytehq/airbyte/pull/57851) | Update dependencies |
|
|
| 0.2.18 | 2025-04-05 | [57350](https://github.com/airbytehq/airbyte/pull/57350) | Update dependencies |
|
|
| 0.2.17 | 2025-03-29 | [56794](https://github.com/airbytehq/airbyte/pull/56794) | Update dependencies |
|
|
| 0.2.16 | 2025-03-22 | [56201](https://github.com/airbytehq/airbyte/pull/56201) | Update dependencies |
|
|
| 0.2.15 | 2025-03-08 | [55543](https://github.com/airbytehq/airbyte/pull/55543) | Update dependencies |
|
|
| 0.2.14 | 2025-03-01 | [55034](https://github.com/airbytehq/airbyte/pull/55034) | Update dependencies |
|
|
| 0.2.13 | 2025-02-23 | [54572](https://github.com/airbytehq/airbyte/pull/54572) | Update dependencies |
|
|
| 0.2.12 | 2025-02-15 | [53990](https://github.com/airbytehq/airbyte/pull/53990) | Update dependencies |
|
|
| 0.2.11 | 2025-02-08 | [53477](https://github.com/airbytehq/airbyte/pull/53477) | Update dependencies |
|
|
| 0.2.10 | 2025-02-01 | [52990](https://github.com/airbytehq/airbyte/pull/52990) | Update dependencies |
|
|
| 0.2.9 | 2025-01-25 | [52533](https://github.com/airbytehq/airbyte/pull/52533) | Update dependencies |
|
|
| 0.2.8 | 2025-01-18 | [51923](https://github.com/airbytehq/airbyte/pull/51923) | Update dependencies |
|
|
| 0.2.7 | 2025-01-11 | [51374](https://github.com/airbytehq/airbyte/pull/51374) | Update dependencies |
|
|
| 0.2.6 | 2024-12-28 | [50680](https://github.com/airbytehq/airbyte/pull/50680) | Update dependencies |
|
|
| 0.2.5 | 2024-12-21 | [50274](https://github.com/airbytehq/airbyte/pull/50274) | Update dependencies |
|
|
| 0.2.4 | 2024-12-14 | [49708](https://github.com/airbytehq/airbyte/pull/49708) | Update dependencies |
|
|
| 0.2.3 | 2024-12-12 | [49324](https://github.com/airbytehq/airbyte/pull/49324) | Update dependencies |
|
|
| 0.2.2 | 2024-12-11 | [47678](https://github.com/airbytehq/airbyte/pull/47678) | Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64 |
|
|
| 0.2.1 | 2024-08-16 | [44196](https://github.com/airbytehq/airbyte/pull/44196) | Bump source-declarative-manifest version |
|
|
| 0.2.0 | 2024-08-15 | [44097](https://github.com/airbytehq/airbyte/pull/44097) | Refactor connector to manifest-only format |
|
|
| 0.1.14 | 2024-08-12 | [43817](https://github.com/airbytehq/airbyte/pull/43817) | Update dependencies |
|
|
| 0.1.13 | 2024-08-03 | [43057](https://github.com/airbytehq/airbyte/pull/43057) | Update dependencies |
|
|
| 0.1.12 | 2024-07-27 | [42767](https://github.com/airbytehq/airbyte/pull/42767) | Update dependencies |
|
|
| 0.1.11 | 2024-07-20 | [42204](https://github.com/airbytehq/airbyte/pull/42204) | Update dependencies |
|
|
| 0.1.10 | 2024-07-15 | [38930](https://github.com/airbytehq/airbyte/pull/38930) | Make compatible with builder |
|
|
| 0.1.9 | 2024-07-13 | [41932](https://github.com/airbytehq/airbyte/pull/41932) | Update dependencies |
|
|
| 0.1.8 | 2024-07-10 | [41349](https://github.com/airbytehq/airbyte/pull/41349) | Update dependencies |
|
|
| 0.1.7 | 2024-07-09 | [41077](https://github.com/airbytehq/airbyte/pull/41077) | Update dependencies |
|
|
| 0.1.6 | 2024-07-06 | [40946](https://github.com/airbytehq/airbyte/pull/40946) | Update dependencies |
|
|
| 0.1.5 | 2024-06-25 | [40490](https://github.com/airbytehq/airbyte/pull/40490) | Update dependencies |
|
|
| 0.1.4 | 2024-06-22 | [39971](https://github.com/airbytehq/airbyte/pull/39971) | Update dependencies |
|
|
| 0.1.3 | 2024-06-06 | [39216](https://github.com/airbytehq/airbyte/pull/39216) | [autopull] Upgrade base image to v1.2.2 |
|
|
| 0.1.2 | 2024-05-21 | [38458](https://github.com/airbytehq/airbyte/pull/38458) | [autopull] base image + poetry + up_to_date |
|
|
| 0.1.1 | 2024-05-21 | [38458](https://github.com/airbytehq/airbyte/pull/38458) | [autopull] base image + poetry + up_to_date |
|
|
| 0.1.0 | 2022-11-02 | [Init](https://github.com/airbytehq/airbyte/pull/18854) | Initial commit |
|
|
|
|
</details>
|