REST API

Index URLs from your own code

One JSON endpoint per action, one API key, no SDK required. Submit up to 500 URLs per request to Google or Bing and poll their index status from your pipeline, CI job or CMS.

Get an API key Full reference (signed in)

Quick start

Your first indexing call

Create an account, copy your key from the dashboard, then POST a batch of URLs.

Submit URLs to Google

Every call creates a project you can follow in the dashboard. Credits are debited on acceptance, so a rejected batch costs nothing.

Request

curl https://flash-index.com/api/v1/project \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{
    "apikey": "fi_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "projectName": "october-launch",
    "urls": [
      "https://example.com/page-1",
      "https://example.com/page-2"
    ]
  }'

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"status":"ok","task_id":"task_123456789","creditsUsed":2}

Authentication

Pass your key as the apikey field of the JSON body. Keys look like fi_live_…, are created and revoked from the dashboard, and are the only credential you need.

Limits

500 URLs maximum per request.
JSON over HTTPS, POST for every endpoint.
Index checks are rounded up to the next whole credit.

Reference

Six endpoints, nothing else to learn

Base URL https://flash-index.com/api/v1

FlashIndex API endpoints and their credit cost
Endpoint	What it does	Cost
POST`/status`	Service health check.	Free
POST`/balance`	Your current credit balance.	Free
POST`/project`	Submit URLs for indexing on Google.	1 credit / URL
POST`/projectBing`	Submit URLs for indexing on Bing.	10 credits / URL
POST`/check`	Check whether URLs are indexed on Google.	0.2 credits / URL
POST`/checkBing`	Check whether URLs are indexed on Bing.	0.2 credits / URL

Check index status

Same shape for Google (/check) and Bing (/checkBing).

Request

curl https://flash-index.com/api/v1/check \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{
    "apikey": "fi_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "urls": ["https://example.com/page-1"]
  }'

Read your balance

Free to call — useful before queueing a large batch.

Request

curl https://flash-index.com/api/v1/balance \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"apikey": "fi_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}'

Response

{"status":"ok","balance":9994}

Errors

Predictable failure responses

Every error returns a numeric errorCode and a human-readable message. No credits are charged on a rejected request.

API error codes
errorCode	message	How to fix it
1	Invalid API key	Check the key, or generate a new one in the dashboard.
2	Invalid JSON	The body could not be parsed. Send valid JSON.
3	Not enough credits	Top up before retrying; nothing is charged on failure.
4	Too many URLs	Split the batch: 500 URLs maximum per request.

Optional modes such as the instant indexer can be switched off for maintenance. The signed-in reference always shows what is live right now, and a disabled endpoint returns 503 without charging credits.

Ready to wire it up?

Create an account, confirm your email and your key is waiting in the dashboard with welcome credits to test against.

Create my account