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.

IP allow list

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

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.2.412025-11-2569993Update dependencies
0.2.402025-11-1869635Update dependencies
0.2.392025-10-2968954Update dependencies
0.2.382025-10-2168267Update dependencies
0.2.372025-10-1467825Update dependencies
0.2.362025-10-0767496Update dependencies
0.2.352025-10-0166963Update dependencies
0.2.342025-09-2366413Update dependencies
0.2.332025-09-0965882Update dependencies
0.2.322025-08-2365221Update dependencies
0.2.312025-08-0964735Update dependencies
0.2.302025-08-0264217Update dependencies
0.2.292025-07-2663827Update dependencies
0.2.282025-07-1963420Update dependencies
0.2.272025-07-1263234Update dependencies
0.2.262025-07-0562577Update dependencies
0.2.252025-06-2862363Update dependencies
0.2.242025-06-2161933Update dependencies
0.2.232025-06-1460548Update dependencies
0.2.222025-05-1060094Update dependencies
0.2.212025-05-0459049Update dependencies
0.2.202025-04-1958479Update dependencies
0.2.192025-04-1257851Update dependencies
0.2.182025-04-0557350Update dependencies
0.2.172025-03-2956794Update dependencies
0.2.162025-03-2256201Update dependencies
0.2.152025-03-0855543Update dependencies
0.2.142025-03-0155034Update dependencies
0.2.132025-02-2354572Update dependencies
0.2.122025-02-1553990Update dependencies
0.2.112025-02-0853477Update dependencies
0.2.102025-02-0152990Update dependencies
0.2.92025-01-2552533Update dependencies
0.2.82025-01-1851923Update dependencies
0.2.72025-01-1151374Update dependencies
0.2.62024-12-2850680Update dependencies
0.2.52024-12-2150274Update dependencies
0.2.42024-12-1449708Update dependencies
0.2.32024-12-1249324Update dependencies
0.2.22024-12-1147678Starting 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.12024-08-1644196Bump source-declarative-manifest version
0.2.02024-08-1544097Refactor connector to manifest-only format
0.1.142024-08-1243817Update dependencies
0.1.132024-08-0343057Update dependencies
0.1.122024-07-2742767Update dependencies
0.1.112024-07-2042204Update dependencies
0.1.102024-07-1538930Make compatible with builder
0.1.92024-07-1341932Update dependencies
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