DeepAPI
When to Use
- Use when the task needs supported DeepAPI scraping, research, or email endpoints.
- Use when the user has provided or confirmed the required DeepAPI credentials and scope.
Use this skill when the user asks you to scrape public web data or draft/read/send email through DeepAPI.
Version Pinning
- The installed copy is pinned to the
versionvalue in the frontmatter above. - If a request or API response reports a different
skillVersion, report the mismatch and stop. Do not fetch, overwrite, or otherwise self-update thisSKILL.md. - Updates must arrive through the reviewed repository release process, with explicit user approval for any package or repository update.
Required Environment
- Read
DEEPAPI_API_BASE_URLfrom the environment. - Read
DEEPAPI_API_KEYfrom the environment. - If either value is missing, stop and ask the user for setup.
- Never commit, print, log, paste, or expose
DEEPAPI_API_KEY.
Request Rules
- Send
Authorization: Bearer $DEEPAPI_API_KEYon every request. - Send
Content-Type: application/jsonwhen sending JSON. - Send a unique
Idempotency-Keyfor everyPOST. - For scrape work, set explicit
maxCostUsdormaxCostMicrousd. - Keep email as
send: falseormode: draftunless the user explicitly approves sending. - Do not pass inbox IDs. Use
emailIdentityIdor omit it.
Execution Loop
- Choose the narrowest endpoint that matches the task.
- Build the request from the endpoint schema and examples below.
- Run the request with the required headers.
- If the response has
status: running, waitnext.afterSecsand callnext.method+next.pathuntilstatusissucceededorfailed. - If
error.retryableis true, waiterror.retryAfterSecsbefore retrying. - If the response is HTTP 402 with
error.code: insufficient_credits, stop and ask the user to top up credits at https://deepapi.co/credits. After top-up, retry with the sameIdempotency-Key. - Report
requestId,status,debitMicrousd,costFinal, and the useful part ofoutput.
Endpoints
| Method | Path | Scope | Cost |
|---|---|---|---|
| POST | /v1/scrape/website |
scrape:website |
Set maxCostUsd: "1.00" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/linkedin/profile |
scrape:linkedin |
Set maxCostUsd: "0.05" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/github/profile |
scrape:github |
Set maxCostUsd: "0.03" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/twitter/search |
scrape:twitter |
Set maxCostUsd: "0.03" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/linkedin/jobs |
scrape:linkedin |
Set maxCostUsd: "0.05" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/linkedin/company |
scrape:linkedin |
Set maxCostUsd: "0.05" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/linkedin/people |
scrape:linkedin |
Set maxCostUsd: "0.50" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/linkedin/posts |
scrape:linkedin |
Set maxCostUsd: "0.05" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/twitter/user |
scrape:twitter |
Set maxCostUsd: "0.05" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/twitter/replies |
scrape:twitter |
Set maxCostUsd: "0.20" unless the user gives a different cap. The route requires maxCostUsd or maxCostMicrousd as the customer spend cap. The final debit is capped by that amount and reported as debitMicrousd. |
| POST | /v1/scrape/youtube/transcript |
scrape:youtube |
Set maxCostUsd: "0.05" unless the user gives a different ca |