Skip to content

Text API Example ​

API Examples ​

The following code will detect text in an image using Node.js to make an API call with a URL pointing to the image. Please note: the x-api-key in the line highlighted below is a placeholder for your real key.

Node.js code to recognise text in an image

js
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.weburban.com/image/to-text',
  'headers': {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
    'x-api-key': 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'
  },
  body: JSON.stringify({
    "imageUrl": "https://www.your-website.com/image.jpg"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.weburban.com/image/to-text',
  'headers': {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
    'x-api-key': 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'
  },
  body: JSON.stringify({
    "imageUrl": "https://www.your-website.com/image.jpg"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

GO Native API code ​

The API is language agnostic and can be called from any language, including Go Native, and shown below. Please note: the x-api-key in the line highlighted below is a placeholder for your real key.

Go Native code to recognise text in an image

go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.weburban.com/image/to-text"
  method := "POST"

  payload := strings.NewReader(`{
    "imageUrl" : "https://www.your-website.com/image.jpg"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("x-api-key", "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.weburban.com/image/to-text"
  method := "POST"

  payload := strings.NewReader(`{
    "imageUrl" : "https://www.your-website.com/image.jpg"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("x-api-key", "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Javascript Fetch Request ​

Finally, this example shows how the call can be made using a Javascript fetch request. Please note: the x-api-key in the line highlighted below is a placeholder for your real key.

js
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx");

var raw = JSON.stringify({
  "imageUrl": "https://www.your-website.com/image.jpg"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.weburban.com/image/to-text", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx");

var raw = JSON.stringify({
  "imageUrl": "https://www.your-website.com/image.jpg"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.weburban.com/image/to-text", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Sample Response ​

The response from the server will always be a JSON object. An example of a response is shown below.

json
{
    "Version": "1.0",
    "Output": {
        "text": [
            "HUMPHREY",
            "INGRID",
            "PAUL",
            "BOGART BERGMAN HENREID"
        ]
    }
}
{
    "Version": "1.0",
    "Output": {
        "text": [
            "HUMPHREY",
            "INGRID",
            "PAUL",
            "BOGART BERGMAN HENREID"
        ]
    }
}

This JSON response will always contain Version and Output data. Versions can be targetted for specific legacy algorithms used by the endpoints. Please see detailed documentation for syntax and specifications.

https://RapidAnalysis.com