-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathllms-full.txt
More file actions
382 lines (307 loc) · 8.18 KB
/
llms-full.txt
File metadata and controls
382 lines (307 loc) · 8.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
# LeadMagic API - Current Reference Snapshot
> This file is a concise, current LLM-oriented reference aligned to `https://leadmagic.io/docs` during the latest cleanup pass. The public docs remain authoritative.
## Basics
Base URL: `https://api.leadmagic.io`
Auth header: `X-API-Key`
Primary docs:
- `https://leadmagic.io/docs`
- `https://leadmagic.io/docs/llms.txt`
Important: current public docs are not uniform about field naming. Some endpoints still show snake_case while others show mixed or camelCase examples. Check the endpoint-specific docs before hard-coding field assumptions.
## Current MCP Surface
The current LeadMagic MCP docs describe:
- 16 tools
- 1 shared docs resource: `leadmagic://docs`
- 2 built-in prompts
That MCP surface currently covers credits, people enrichment, company research, technographics, competitors, job-change detection, and jobs search.
Important distinction: ad-search endpoints exist in the broader REST API and this OpenAPI snapshot, but they are not part of the current MCP tool surface.
## Error Shape
Public docs describe RFC 9457-style error responses:
```json
{
"success": false,
"errors": [
{
"type": "https://api.leadmagic.io/errors/validation_error",
"title": "Request validation failed. Check your input parameters.",
"status": 400,
"code": "validation_error",
"docs": "https://leadmagic.io/docs/api-reference/errors"
}
],
"meta": {
"request_id": "uuid",
"timestamp": "2024-02-01T12:00:00.000Z"
}
}
```
Common status codes: `200`, `400`, `401`, `402`, `404`, `429`, `500`
## Credit System
These values reflect the current public docs for the core endpoints covered in this repo.
| Route | Cost | Notes |
| --- | --- | --- |
| `GET /v1/credits` | 0 | Free |
| `POST /v1/people/email-validation` | 0.25 | 4 validations per credit |
| `POST /v1/people/email-finder` | 1 | Free if result is null |
| `POST /v1/people/personal-email-finder` | 2 | Free if not found |
| `POST /v1/people/b2b-profile-email` | 5 | Free if not found |
| `POST /v1/people/b2b-profile` | 10 | Free if not found |
| `POST /v1/people/mobile-finder` | 5 | Free if not found |
| `POST /v1/people/profile-search` | 1 | Docs show 100 req/min |
| `POST /v1/people/role-finder` | 2 | Free if not found |
| `POST /v1/people/employee-finder` | 0.05 per employee | 20 employees per credit |
| `POST /v1/companies/company-search` | 1 | Free if not found |
| `POST /v1/companies/company-funding` | 4 | Free if not found |
| `POST /v1/jobs/jobs-finder` | 1 per job | Free if no jobs found |
| `GET /v1/jobs/countries` | 0 | Metadata |
| `GET /v1/jobs/job-types` | 0 | Metadata |
| `POST /v1/ads/google-ads-search` | 0.2 | 5 searches per credit |
| `POST /v1/ads/meta-ads-search` | 0.2 | 5 searches per credit |
| `POST /v1/ads/b2b-ads-search` | 0.2 | 5 searches per credit |
| `POST /v1/ads/b2b-ads-details` | 2 | Free if not found |
## Endpoint Summary
### Credits
#### `GET /v1/credits`
Returns the current credit balance.
Example:
```bash
curl 'https://api.leadmagic.io/v1/credits' \
-H 'X-API-Key: YOUR_API_KEY'
```
Typical response:
```json
{
"credits": 15432.5,
"is_frozen": false,
"credits_frozen": 0,
"credits_liquid": 15432.5,
"credit_freeze_message": null,
"credit_freeze_plan_hint": null
}
```
### People
#### `POST /v1/people/email-validation`
Validate an email and return deliverability plus free company enrichment.
Minimal request:
```json
{ "email": "john@company.com" }
```
Typical fields:
- `email`
- `email_status`
- `credits_consumed`
- `message`
- `mx_record`
- `mx_provider`
- `company_name`
- `company_location`
#### `POST /v1/people/email-finder`
Find a verified work email from person plus company input.
Minimal request:
```json
{
"first_name": "John",
"last_name": "Doe",
"domain": "company.com"
}
```
Typical fields:
- `email`
- `status`
- `credits_consumed`
- `employment_verified`
- company enrichment fields
#### `POST /v1/people/personal-email-finder`
Find personal email data from a professional profile URL.
Minimal request:
```json
{ "profile_url": "https://profiles.example.com/johndoe" }
```
Typical fields in docs:
- `profile_url`
- `personal_email` or `personal_emails`
- `credits_consumed`
- `message`
#### `POST /v1/people/b2b-profile-email`
Convert a professional profile URL into a work email.
Minimal request:
```json
{ "profile_url": "https://profiles.example.com/johndoe" }
```
Typical fields:
- `email`
- `profile_url`
- `credits_consumed`
- `message`
#### `POST /v1/people/b2b-profile`
Convert an email into a professional profile URL.
Minimal request:
```json
{ "work_email": "john@company.com" }
```
Typical fields:
- `profile_url`
- `credits_consumed`
- `message`
#### `POST /v1/people/mobile-finder`
Find a mobile number from `profile_url`, `work_email`, or `personal_email`.
Typical fields:
- `profile_url`
- `email`
- `mobile_number`
- `credits_consumed`
- `message`
#### `POST /v1/people/profile-search`
Return professional profile enrichment data. Current docs show a lower rate limit than older repo docs.
Minimal request:
```json
{ "profile_url": "https://profiles.example.com/johndoe" }
```
Typical fields:
- `profile_url`
- `first_name`
- `last_name`
- `full_name`
- `professional_title`
- `company_name`
- `bio`
- `work_experience`
- `education`
- `credits_consumed`
#### `POST /v1/people/role-finder`
Find a person at a company by job title.
Minimal request:
```json
{
"job_title": "VP of Sales",
"company_domain": "company.com"
}
```
Typical fields:
- `first_name`
- `last_name`
- `full_name`
- `profile_url`
- `job_title`
- `company_name`
- `company_website`
- `credits_consumed`
#### `POST /v1/people/employee-finder`
Return multiple employees for a company.
Minimal request:
```json
{
"company_domain": "company.com",
"limit": 10
}
```
Typical fields:
- `employees` or `data`
- `total_count`
- `credits_consumed`
- `message`
### Companies
#### `POST /v1/companies/company-search`
Enrich a company by domain, name, or profile URL.
Minimal request:
```json
{ "company_domain": "company.com" }
```
Docs currently show example responses with mixed naming, including fields like:
- `companyName`
- `companyId`
- `industry`
- `employeeCount`
- `employeeRange`
- `founded`
- `headquarters`
- `credits_consumed`
#### `POST /v1/companies/company-funding`
Return funding rounds, investors, and leadership details.
Minimal request:
```json
{ "company_domain": "stripe.com" }
```
Typical fields:
- `company_name`
- `total_funding`
- `latest_round`
- `funding_rounds`
- `investors`
- `leadership`
- `credits_consumed`
### Jobs
#### `POST /v1/jobs/jobs-finder`
Search jobs using company, title, location, pagination, and posting-age filters.
Minimal request:
```json
{
"job_title": "Sales Director",
"country_id": "US",
"posted_within": 14
}
```
Typical fields:
- `total_count`
- `page`
- `per_page`
- `results`
- `credits_consumed`
#### `GET /v1/jobs/countries`
Returns country codes for jobs filtering.
#### `GET /v1/jobs/job-types`
Returns job type IDs for jobs filtering.
### Ads
#### `POST /v1/ads/google-ads-search`
Search Google Ads by company domain or name.
Typical ad fields:
- `headline`
- `description`
- `display_url`
- `final_url`
- `ad_type`
#### `POST /v1/ads/meta-ads-search`
Search Meta ads by company domain or name.
Typical ad fields:
- `ad_id`
- `content`
- `image_url`
- `video_url`
- `platform`
- `started_running`
#### `POST /v1/ads/b2b-ads-search`
Search professional-network B2B ads.
Typical ad fields:
- `content`
- `link`
- `image_url`
#### `POST /v1/ads/b2b-ads-details`
Fetch full B2B ad details from an ad library URL or ID.
Minimal request:
```json
{
"ad_url": "https://ads.example.com/library/detail/633872143"
}
```
Typical fields:
- `ad_id`
- `headline`
- `content`
- `advertiser`
- `creative`
- `targeting`
- `started_running`
- `impressions`
- `credits_consumed`
## Docs-Only Endpoints Outside This Snapshot
- Analytics API
- Job Change Detector
- Competitors Search
- Technographics
- Job company types
- Job industries
- Job regions
- Credits refresh and health endpoints
## Guidance For Tools
- Prefer the public docs when there is any mismatch with local files
- Use endpoint-specific docs for field names
- Assume pricing and rate limits can change; verify from docs before hard-coding business rules