Skip to main content

Pexels-API

This page contains the setup guide and reference information for the Pexels-API 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 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:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncNo
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

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.

Reference

Config fields reference

Field
Type
Property name
string
api_key
string
query
string
color
string
locale
string
orientation
string
size

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.82024-07-1041349Update dependencies
0.1.72024-07-0941077Update dependencies
0.1.62024-07-0640946Update dependencies
0.1.52024-06-2540490Update dependencies
0.1.42024-06-2239971Update dependencies
0.1.32024-06-0639216[autopull] Upgrade base image to v1.2.2
0.1.22024-05-2138458[autopull] base image + poetry + up_to_date
0.1.12024-05-2138458[autopull] base image + poetry + up_to_date
0.1.02022-11-02InitInitial commit