Predict in batch

curl --request POST \
  --url https://api.finowl.co/v1/gender/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "id": "lead_1",
      "type": "name",
      "value": "Alice"
    },
    {
      "id": "lead_2",
      "type": "email",
      "value": "alice.johnson@example.com"
    },
    {
      "id": "lead_3",
      "type": "username",
      "value": "prenses",
      "country": "TR",
      "forceToGenderize": true
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {id: 'lead_1', type: 'name', value: 'Alice'},
      {id: 'lead_2', type: 'email', value: 'alice.johnson@example.com'},
      {
        id: 'lead_3',
        type: 'username',
        value: 'prenses',
        country: 'TR',
        forceToGenderize: true
      }
    ]
  })
};

fetch('https://api.finowl.co/v1/gender/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.finowl.co/v1/gender/batch"

payload = { "items": [
        {
            "id": "lead_1",
            "type": "name",
            "value": "Alice"
        },
        {
            "id": "lead_2",
            "type": "email",
            "value": "alice.johnson@example.com"
        },
        {
            "id": "lead_3",
            "type": "username",
            "value": "prenses",
            "country": "TR",
            "forceToGenderize": True
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.finowl.co/v1/gender/batch"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.finowl.co/v1/gender/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'id' => 'lead_1',
                'type' => 'name',
                'value' => 'Alice'
        ],
        [
                'id' => 'lead_2',
                'type' => 'email',
                'value' => 'alice.johnson@example.com'
        ],
        [
                'id' => 'lead_3',
                'type' => 'username',
                'value' => 'prenses',
                'country' => 'TR',
                'forceToGenderize' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.finowl.co/v1/gender/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.finowl.co/v1/gender/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}")
  .asString();

{
  "data": [
    {
      "index": 0,
      "id": "lead_1",
      "charged_credits": 1,
      "data": {
        "result_status": "identified",
        "gender": "female",
        "confidence": 0.98
      }
    },
    {
      "index": 1,
      "id": "lead_2",
      "charged_credits": 1,
      "data": {
        "result_status": "identified",
        "gender": "female",
        "confidence": 0.95
      }
    },
    {
      "index": 2,
      "id": "lead_3",
      "charged_credits": 1,
      "data": {
        "result_status": "unknown",
        "gender": null
      }
    }
  ],
  "billing_status": "confirmed"
}

{
  "error": {
    "code": "invalid_input"
  }
}

{
  "error": {
    "code": "unauthorized"
  }
}

{
  "error": {
    "code": "rate_limited"
  }
}

{
  "data": [
    {
      "index": 123,
      "id": "<string>",
      "charged_credits": 123,
      "data": {
        "result_status": "identified",
        "gender": "male",
        "confidence": 123,
        "country": "<string>"
      },
      "error": {
        "code": "<string>",
        "status": 502,
        "action": "inspect_billing_before_retry"
      }
    }
  ],
  "billing_status": "confirmed"
}

{
  "error": {
    "code": "provider_unavailable"
  }
}

{
  "error": {
    "code": "provider_response_unconfirmed"
  }
}

POST

gender

batch

Predict in batch

curl --request POST \
  --url https://api.finowl.co/v1/gender/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "id": "lead_1",
      "type": "name",
      "value": "Alice"
    },
    {
      "id": "lead_2",
      "type": "email",
      "value": "alice.johnson@example.com"
    },
    {
      "id": "lead_3",
      "type": "username",
      "value": "prenses",
      "country": "TR",
      "forceToGenderize": true
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {id: 'lead_1', type: 'name', value: 'Alice'},
      {id: 'lead_2', type: 'email', value: 'alice.johnson@example.com'},
      {
        id: 'lead_3',
        type: 'username',
        value: 'prenses',
        country: 'TR',
        forceToGenderize: true
      }
    ]
  })
};

fetch('https://api.finowl.co/v1/gender/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.finowl.co/v1/gender/batch"

payload = { "items": [
        {
            "id": "lead_1",
            "type": "name",
            "value": "Alice"
        },
        {
            "id": "lead_2",
            "type": "email",
            "value": "alice.johnson@example.com"
        },
        {
            "id": "lead_3",
            "type": "username",
            "value": "prenses",
            "country": "TR",
            "forceToGenderize": True
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.finowl.co/v1/gender/batch"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.finowl.co/v1/gender/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'id' => 'lead_1',
                'type' => 'name',
                'value' => 'Alice'
        ],
        [
                'id' => 'lead_2',
                'type' => 'email',
                'value' => 'alice.johnson@example.com'
        ],
        [
                'id' => 'lead_3',
                'type' => 'username',
                'value' => 'prenses',
                'country' => 'TR',
                'forceToGenderize' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.finowl.co/v1/gender/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.finowl.co/v1/gender/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"id\": \"lead_1\",\n      \"type\": \"name\",\n      \"value\": \"Alice\"\n    },\n    {\n      \"id\": \"lead_2\",\n      \"type\": \"email\",\n      \"value\": \"alice.johnson@example.com\"\n    },\n    {\n      \"id\": \"lead_3\",\n      \"type\": \"username\",\n      \"value\": \"prenses\",\n      \"country\": \"TR\",\n      \"forceToGenderize\": true\n    }\n  ]\n}")
  .asString();

{
  "data": [
    {
      "index": 0,
      "id": "lead_1",
      "charged_credits": 1,
      "data": {
        "result_status": "identified",
        "gender": "female",
        "confidence": 0.98
      }
    },
    {
      "index": 1,
      "id": "lead_2",
      "charged_credits": 1,
      "data": {
        "result_status": "identified",
        "gender": "female",
        "confidence": 0.95
      }
    },
    {
      "index": 2,
      "id": "lead_3",
      "charged_credits": 1,
      "data": {
        "result_status": "unknown",
        "gender": null
      }
    }
  ],
  "billing_status": "confirmed"
}

{
  "error": {
    "code": "invalid_input"
  }
}

{
  "error": {
    "code": "unauthorized"
  }
}

{
  "error": {
    "code": "rate_limited"
  }
}

{
  "data": [
    {
      "index": 123,
      "id": "<string>",
      "charged_credits": 123,
      "data": {
        "result_status": "identified",
        "gender": "male",
        "confidence": 123,
        "country": "<string>"
      },
      "error": {
        "code": "<string>",
        "status": 502,
        "action": "inspect_billing_before_retry"
      }
    }
  ],
  "billing_status": "confirmed"
}

{
  "error": {
    "code": "provider_unavailable"
  }
}

{
  "error": {
    "code": "provider_response_unconfirmed"
  }
}

How batches behave

Mix input types freely. Each item sets its own type, country, forceToGenderize and options.
Order is preserved. data[i] always matches items[i]. Use index, or your own id, to join results back.
Validation is all or nothing. One invalid item rejects the whole request with 400 invalid_input, and nothing is charged.
Execution is per item. Once the batch runs, each item succeeds or fails on its own. A 200 can contain item errors.
Batch items default to dataset only. Set options.ai_mode to fallback on an item if you want AI to fill gaps, as single lookups do.
Credits are reserved up front. A batch of 50 needs 50 available credits, and counts as one request toward your rate limit.

Handling a mixed result

const { data } = await response.json();

for (const item of data) {
  if (item.error) {
    // Do not resend automatically. See the Retries page.
    console.warn(`Item ${item.id ?? item.index} failed: ${item.error.code}`);
    continue;
  }
  save(item.id, item.data.result_status === "identified" ? item.data.gender : null);
}

Never resend a whole batch because a few items failed. Successful items were already charged. Collect the failed items and decide whether to send them again in a new, smaller batch.

Guide: enrich a contact list

Chunking, rate limiting and resuming a large import safely.

Authorizations

Authorization

string

header

required

Your Finowl API key, for example finowl_3f9a.... Create keys in the dashboard under API Keys.

Body

application/json

items

object[]

required

Required array length: 1 - 50 elements

Show child attributes

Response

The batch ran. Each entry has either data or error.

data

object[]

required

One entry per input item, in the same order.

Show child attributes

billing_status

string

required

Whether processing cost for this batch was confirmed. unconfirmed means do not assume the failed items were free.

Example:

"confirmed"

Overview

Breaches

Gender

Breaches

Gender

Predict in batch

How batches behave

Handling a mixed result

Guide: enrich a contact list

Authorizations

Body

Response

​How batches behave

​Handling a mixed result

Guide: enrich a contact list

Authorizations

Body

Response

How batches behave

Handling a mixed result