Process Image with OCRSpace API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for OCRSpace, GitHub and 3,000+ other apps remarkably fast.

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Process Image with the OCRSpace API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a GitHub trigger and OCRSpace action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Process Image action
1. Connect your OCRSpace account
2. Optional- Select a Language
3. Optional- Configure Is Overlay Required
4. Optional- Configure Detect Orientation
5. Optional- Configure Scale
6. Optional- Configure Is Table
7. Optional- Select a OCR Engine
8. Configure File Path or URL
9. Optional- Select a File Type
10. Optional- Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.12

Key:github-new-branch

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.12",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Process Image on OCRSpace

Description:Submits an image file for OCR processing using OCR.space. [See the documentation](https://ocr.space/ocrapi)

Version:0.1.2

Key:ocrspace-process-image

View on GitHub

OCRSpace Overview#

The OCRSpace API enables text extraction from images and PDFs, converting various image formats into editable and searchable data. This service is a game-changer for automating document handling processes, where the need to digitize content is crucial. Pipedream's platform allows for seamless integration of OCRSpace's capabilities with various apps to streamline workflows, such as organizing documents, populating databases, or even triggering event-driven actions based on the extracted content.

Action Code#

import common from "../common/process-base.mjs";

export default {
  ...common,
  key: "ocrspace-process-image",
  name: "Process Image",
  description: "Submits an image file for OCR processing using OCR.space. [See the documentation](https://ocr.space/ocrapi)",
  version: "0.1.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    ...common.props,
    file: {
      propDefinition: [
        common.props.ocrspace,
        "file",
      ],
    },
    filetype: {
      propDefinition: [
        common.props.ocrspace,
        "filetype",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    getSummary() {
      return "Image submitted for OCR processing.";
    },
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
OCRSpace	`ocrspace`	`app`	This component uses the OCRSpace app.
Language	`language`	`string`	Select a value from the drop down menu:`{ "label": "Arabic", "value": "ara" }{ "label": "Bulgarian", "value": "bul" }{ "label": "Chinese (Simplified)", "value": "chs" }{ "label": "Chinese (Traditional)", "value": "cht" }{ "label": "Croatian", "value": "hrv" }{ "label": "Czech", "value": "cze" }{ "label": "Danish", "value": "dan" }{ "label": "Dutch", "value": "dut" }{ "label": "English", "value": "eng" }{ "label": "Finnish", "value": "fin" }{ "label": "French", "value": "fre" }{ "label": "German", "value": "ger" }{ "label": "Greek", "value": "gre" }{ "label": "Hungarian", "value": "hun" }{ "label": "Korean", "value": "kor" }{ "label": "Italian", "value": "ita" }{ "label": "Japanese", "value": "jpn" }{ "label": "Polish", "value": "pol" }{ "label": "Portuguese", "value": "por" }{ "label": "Russian", "value": "rus" }{ "label": "Slovenian", "value": "slv" }{ "label": "Spanish", "value": "spa" }{ "label": "Swedish", "value": "swe" }{ "label": "Turkish", "value": "tur" }`
Is Overlay Required	`isOverlayRequired`	`boolean`	If true, returns the coordinates of the bounding boxes for each word. If false, the OCR'ed text is returned only as a text block (this makes the JSON reponse smaller). Overlay data can be used, for example, to show text over the image
Detect Orientation	`detectOrientation`	`boolean`	If set to true, the api autorotates the image correctly and sets the TextOrientation parameter in the JSON response. If the image is not rotated, then TextOrientation=0, otherwise it is the degree of the rotation, e. g. "270".
Scale	`scale`	`boolean`	If set to true, the api does some internal upscaling. This can improve the OCR result significantly, especially for low-resolution PDF scans. Note that the front page demo uses scale=true, but the API uses scale=false by default. See also this OCR forum post.
Is Table	`isTable`	`boolean`	If set to true, the OCR logic makes sure that the parsed text result is always returned line by line. This switch is recommended for table OCR, receipt OCR, invoice processing and all other type of input documents that have a table like structure.
OCR Engine	`ocrEngine`	`string`	Select a value from the drop down menu:`{ "label": "OCR Engine 1", "value": "1" }{ "label": "OCR Engine 2", "value": "2" }`
File Path or URL	`file`	`string`	The file to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)
File Type	`filetype`	`string`	Select a value from the drop down menu:`GIFPNGJPGTIFBMP`
syncDir	`syncDir`	`dir`

Action Authentication#

OCRSpace uses API keys for authentication. When you connect your OCRSpace account, Pipedream securely stores the keys so you can easily authenticate to OCRSpace APIs in both code and no-code steps.

In order to get an API Key, you need to register here for your free OCR API key. Then follow the instructions that are sent to the email you provided when registering.

About OCRSpace#

The OCR.space Online OCR service converts scans or (smartphone) images of text documents into editable files by using Optical Character Recognition (OCR). The OCR software also can get text from PDF . Our Online OCR service is free to use, no registration necessary. Just upload your image files.

More Ways to Connect OCRSpace + GitHub#

Other Popular Integrations#

Process Image with OCRSpace API on New Card in Column (Classic Projects) from GitHub API

GitHub + OCRSpace

Process Image with OCRSpace API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for OCRSpace, GitHub and 3,000+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular