Skip to content

[codex] document Deep Search, Enrich, and Extract pricing #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
yanyuliu01 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[codex] document Deep Search, Enrich, and Extract pricing #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions api-reference/deep-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,14 @@ On success, `success` is `true` and `answer` contains the generated answer. A bu
}
```

## Billing

| Type | Description | Credits deducted |
| --- | --- | ---: |
| Deep Search | Answers an open-ended research question. | 2 credits / successful request |

Requests with `success: false` are not charged.

See [Credits and billing](/guides/billing) for all API rates.

Errors outside the Deep Search workflow use the standard [error envelope](/api-reference/errors).
10 changes: 10 additions & 0 deletions api-reference/enrich.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,14 @@ On success, `answer` tries to match the requested `enrich_fields` schema.
}
```

## Billing

| Type | Description | Credits deducted |
| --- | --- | ---: |
| Enrich | Generates structured fields for an entity. | 2 credits / successful request |

The price does not depend on the number of properties in `enrich_fields`. Requests with `success: false` are not charged.

See [Credits and billing](/guides/billing) for all API rates.

Errors outside the Enrich workflow use the standard [error envelope](/api-reference/errors).
18 changes: 18 additions & 0 deletions api-reference/extract.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,22 @@ The response includes `success`, `data`, and `metadata`. Social, GitHub, and `we
}
```

## Billing

| Type | Description | Credits deducted |
| --- | --- | ---: |
| `x_followers` | Returns the followers of an X account. | 1 credit / 5 results |
| `x_following` | Returns the accounts followed by an X account. | 1 credit / 5 results |
| `github_user_followers` | Returns the followers of a GitHub user. | 1 credit / 5 results |
| `github_user_following` | Returns the accounts followed by a GitHub user. | 1 credit / 5 results |
| `github_repo_stargazers` | Returns the stargazers of a GitHub repository. | 1 credit / 5 results |
| `github_repo_contributors` | Returns the contributors to a GitHub repository. | 1 credit / 5 results |
| `ins_followers` | Returns the followers of an Instagram account. | 1 credit / 5 results |
| `ins_following` | Returns the accounts followed by an Instagram account. | 1 credit / 5 results |
| `tiktok_followers` | Returns the followers of a TikTok account. | 1 credit / 5 results |
| `tiktok_following` | Returns the accounts followed by a TikTok account. | 1 credit / 5 results |
| `web2list` | Extracts a structured list from a web page. | 80 credits / successful request |

Social and GitHub list results are billed in groups of 5. A partial group is charged as a full group, so 1 to 5 results cost 1 credit and 6 to 10 cost 2 credits. Requests with `success: false` are not charged. See [Credits and billing](/guides/billing) for more examples.

Errors outside the Extract workflow use the standard [error envelope](/api-reference/errors).
40 changes: 38 additions & 2 deletions guides/billing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Credits and billing"
description: "Understand Entity Search reservation, terminal settlement, recovery, and Contact Search charging."
description: "Understand credit rates and charging behavior across Lev8 APIs."
---

Entity Search and Contact Search use Lev8 credits. The rates below apply to the currently enabled public rollout.
Lev8 APIs use a shared credit balance. The rates below apply to the currently enabled public rollout.

## Check available credits

Expand Down Expand Up @@ -41,10 +41,46 @@ Set `enable_web_search: true` to use the open web startup rate instead of the st
| No contact found | `result.content` is empty, whitespace, or `null`. | 0 credits |
| Completed request replayed | Replays the same completed request with the same API key, `Idempotency-Key`, and body. | 0 additional credits |

### Deep Search

| Type | Description | Credits deducted |
| --- | --- | ---: |
| Deep Search | Answers an open-ended research question. | 2 credits / successful request |

Requests with `success: false` are not charged.

### Enrich

| Type | Description | Credits deducted |
| --- | --- | ---: |
| Enrich | Generates structured fields for an entity. | 2 credits / successful request |

The price does not depend on the number of properties in `enrich_fields`. Requests with `success: false` are not charged.

### Extract

| Type | Description | Credits deducted |
| --- | --- | ---: |
| `x_followers` | Returns the followers of an X account. | 1 credit / 5 results |
| `x_following` | Returns the accounts followed by an X account. | 1 credit / 5 results |
| `github_user_followers` | Returns the followers of a GitHub user. | 1 credit / 5 results |
| `github_user_following` | Returns the accounts followed by a GitHub user. | 1 credit / 5 results |
| `github_repo_stargazers` | Returns the stargazers of a GitHub repository. | 1 credit / 5 results |
| `github_repo_contributors` | Returns the contributors to a GitHub repository. | 1 credit / 5 results |
| `ins_followers` | Returns the followers of an Instagram account. | 1 credit / 5 results |
| `ins_following` | Returns the accounts followed by an Instagram account. | 1 credit / 5 results |
| `tiktok_followers` | Returns the followers of a TikTok account. | 1 credit / 5 results |
| `tiktok_following` | Returns the accounts followed by a TikTok account. | 1 credit / 5 results |
| `web2list` | Extracts a structured list from a web page. | 80 credits / successful request |

Social and GitHub list results are billed in groups of 5. A partial group is charged as a full group, so 1 to 5 results cost 1 credit, 6 to 10 cost 2 credits, and 100 cost 20 credits. Requests with `success: false` are not charged.

### Example

Finding 10 companies with standard Entity Search costs `5 + (10 × 2) = 25` credits. Finding one email address for each company costs another `10 × 10 = 100` credits, for a total of `125` credits. If fewer than 10 companies are returned, Entity Search charges only for its final `ready_count`.

A successful Deep Search request and a successful Enrich request cost 2 credits each. Extracting 23 social or GitHub list results is billed as five groups and costs 5 credits, while one successful `web2list` request costs 80 credits.

## Entity Search lifecycle

<Steps>
Expand Down