Get Enrichment Status

GET

enrich

requests

{request_id}

curl --request GET \
  --url https://api.orbitsearch.com/v3/enrich/requests/{request_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbitsearch.com/v3/enrich/requests/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/enrich/requests/{request_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "request_id": "<string>",
  "profile_id": "<string>",
  "status": "running",
  "operation": "partial",
  "include_profile": true,
  "generation_level": 2,
  "links": {
    "profile": "<string>",
    "status": "<string>"
  },
  "profile": {
    "id": "<string>",
    "generationLevel": 2,
    "avatarUrl": "<string>",
    "verified": true,
    "sections": {},
    "sources": [
      {
        "link": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "caption": "<string>",
        "images": [
          "<string>"
        ],
        "sourceName": "<string>",
        "sourceImage": "<string>",
        "chunks": [
          {
            "text": "<string>"
          }
        ],
        "sources": "<array>"
      }
    ],
    "displayName": "<string>",
    "personName": "<string>",
    "aliases": [
      "<string>"
    ],
    "profileUrl": "<string>",
    "slug": "<string>",
    "category": {
      "id": "<string>",
      "label": "<string>"
    },
    "location": {
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "headline": {
      "jobTitle": "<string>",
      "companyName": "<string>",
      "schoolName": "<string>"
    },
    "emails": [
      "jsmith@example.com"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "addresses": [
      {}
    ]
  },
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

Returns the latest snapshot for a single-profile Enrich operation or one child of a batch operation.

curl "https://api.orbitsearch.com/v3/enrich/requests/$REQUEST_ID" \
  -H "Authorization: Bearer $ORBIT_API_KEY"

Parameter	Location	Required	Description
`request_id`	path	Yes	The request ID returned by `POST /v3/enrich/{profile_id}`, or a child request ID from batch Enrich.

{
  "request_id": "enrich-profile-123-full",
  "profile_id": "profile_123",
  "status": "completed",
  "operation": "full",
  "include_profile": true,
  "generation_level": 3,
  "profile": {
    "id": "profile_123",
    "displayName": "Example Person",
    "generationLevel": 3
  },
  "links": {
    "status": "/v3/enrich/requests/enrich-profile-123-full",
    "profile": "/v3/enrich/profile_123"
  }
}

Continue polling while status is running. Stop on completed or failed. This endpoint requires search:read; responses created with include_profile: true also require profile:read. Requests are visible only to the API key that created them.

Authorizations

Authorization

string

header

required

Use an Orbit API key from the Developer Dashboard.

Path Parameters

request_id

string

required

The request ID returned by a profile enrichment operation.

Minimum string length: 1

Response

The current enrichment snapshot.

request_id

string

required

profile_id

string

required

status

enum<string>

required

Available options:

running,

completed,

failed

operation

enum<string>

required

Use partial for a useful profile, full for the deepest available profile, or regenerate to rebuild a fresh full profile.

Available options:

partial,

full,

regenerate

include_profile

boolean

required

generation_level

integer | null

required

Required range: x >= 1

links

object

required

Show child attributes

profile

object

The public Orbit profile. Available fields depend on the profile generation level.

Show child attributes

failure

object

Show child attributes

billing

object

Credits held and spent for this request. Omitted when Orbit served the request from the stored profile. The final consumedCredits is the full charge once status is settled.

Show child attributes

Get Enrichment Status

curl --request GET \
  --url https://api.orbitsearch.com/v3/enrich/requests/{request_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbitsearch.com/v3/enrich/requests/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/enrich/requests/{request_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "request_id": "<string>",
  "profile_id": "<string>",
  "status": "running",
  "operation": "partial",
  "include_profile": true,
  "generation_level": 2,
  "links": {
    "profile": "<string>",
    "status": "<string>"
  },
  "profile": {
    "id": "<string>",
    "generationLevel": 2,
    "avatarUrl": "<string>",
    "verified": true,
    "sections": {},
    "sources": [
      {
        "link": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "caption": "<string>",
        "images": [
          "<string>"
        ],
        "sourceName": "<string>",
        "sourceImage": "<string>",
        "chunks": [
          {
            "text": "<string>"
          }
        ],
        "sources": "<array>"
      }
    ],
    "displayName": "<string>",
    "personName": "<string>",
    "aliases": [
      "<string>"
    ],
    "profileUrl": "<string>",
    "slug": "<string>",
    "category": {
      "id": "<string>",
      "label": "<string>"
    },
    "location": {
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "headline": {
      "jobTitle": "<string>",
      "companyName": "<string>",
      "schoolName": "<string>"
    },
    "emails": [
      "jsmith@example.com"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "addresses": [
      {}
    ]
  },
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

Search

Enrich

Watchers

Webhooks

Keys

Authorizations

Path Parameters

Response