Spark
Sign In
Skill

Scrape LinkedIn, GitHub, Twitter & YouTube via DeepAPI

Wraps DeepAPI's scraping, research, email, image, and web-search endpoints in one cost-capped, idempotent request pattern.

Get skill
Works with linkedingithubtwitteryoutubeemail
davidondrej
Maintainer?
91
Spark score
out of 100
Updated 15 days ago
Version 1.0.0
Add to Favorites

Why it matters

Extract structured data from major platforms-LinkedIn profiles and jobs, GitHub repos, Twitter searches and replies, YouTube transcripts-and send or draft emails, all through a unified API with cost controls and automatic polling for long-running scrapes.

Outcomes

What it gets done

01

Scrape LinkedIn profiles, company pages, job listings, and people searches with configurable spend caps

02

Extract GitHub profile data, Twitter user timelines, search results, and reply threads

03

Retrieve YouTube video transcripts, channel metadata, and search results

04

Draft and send emails with idempotency guarantees and automatic retry on transient failures

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/ag-deepapi | bash

Overview

DeepAPI

Wraps DeepAPI's scraping (website, LinkedIn, GitHub, X/Twitter, YouTube), email, deep research, image generation, and web search endpoints in one cost-capped, idempotent request-and-poll pattern. Use it whenever a task needs a supported DeepAPI endpoint with confirmed credentials. Always set an explicit spend cap, keep email as draft unless approved, and never expose the API key.

What it does

Wraps DeepAPI's scraping, research, email, image-generation, and web-search endpoints behind a single consistent request pattern: authenticate with a bearer key, send a unique idempotency key on every POST, set an explicit spend cap on cost-bearing routes, and poll a running job until it succeeds or fails.

When to use - and when NOT to

Use it when the task needs a supported DeepAPI scraping, research, or email endpoint, and the user has already provided or confirmed the required DeepAPI credentials and scope - specifically when the user asks to scrape public web data or draft, read, or send email through DeepAPI. The installed skill is pinned to a specific version; if a request or API response reports a different skillVersion than the one pinned in this file's own frontmatter, the mismatch gets reported and the run stops rather than self-updating the file, since updates only arrive through the reviewed repository release process with explicit user approval. DEEPAPI_API_BASE_URL and DEEPAPI_API_KEY must both already be set in the environment; if either is missing, the correct move is to stop and ask the user for setup rather than guessing, and the key itself must never be committed, printed, logged, pasted, or otherwise exposed.

Inputs and outputs

Every request follows the same shape: a bearer Authorization header carrying the API key, a JSON content-type header when sending a body, and a unique Idempotency-Key on every POST so a retried request never double-charges or double-sends. Scrape and paid-generation routes require an explicit spend cap, either maxCostUsd or maxCostMicrousd, which sets the customer's own spend ceiling for that run - the final debit is capped by that number and reported back as debitMicrousd. The execution loop is uniform across routes: pick the narrowest endpoint that matches the task, build the request body from that endpoint's own schema and example, send it with the required headers, and if the response comes back with status running, wait the response's own afterSecs delay and call its own next method and path repeatedly until the status resolves to succeeded or failed; a retryable error waits its own retryAfterSecs before trying again, and an HTTP 402 with an insufficient-credits error code means stopping and asking the user to top up credits before retrying the exact same request under the exact same idempotency key. Every finished request gets reported back with its requestId, status, debitMicrousd, costFinal, and the useful part of the output, never just a bare success or failure. Deep research is a representative single-shot example:

{
  "query": "What changed in EU AI Act compliance timelines for API startups?",
  "context": "We sell API tooling to EU customers.",
  "maxCostUsd": "0.10"
}

Integrations

Scraping covers a wide surface: a general website crawl returning clean text and markdown per page; LinkedIn profile, company, jobs, posts, and a broader people-search-by-role-location-company-or-school route, which requires a spend cap of at least fifty cents given its higher cost; GitHub profile scraping; X/Twitter search-by-query-or-handle, a single user's profile with optional follower and following lists, and a post's full public reply thread, which requires a spend cap of at least twenty cents; and YouTube transcript extraction, returning both plain text and timed segments with an empty result for videos that have no captions at all, channel stats and recent videos, and keyword search - plus three backward-compatible aliases that map onto the corresponding profile or search route for older callers. Every scrape route shares the same safety posture: never expose the key, always send a fresh idempotency key, always set an explicit spend cap before starting, start with a small result-count cap such as maxItems rather than an unbounded one, and poll the returned path while running rather than blocking synchronously. Email endpoints cover creating a draft or, once explicitly approved, actually sending one; reading messages and listing pending drafts, both free zero-cost reads; and sending a specific already-reviewed draft by its id, which re-checks recipient and content policy against the stored draft at send time so a blocked draft simply stays a draft. Email sending stays in draft mode by default unless the user explicitly approves a real send, never accepts a raw inbox id, only an email-identity id or the workspace default, and blocks attachments, hidden HTML, image-only HTML, URL shorteners, and other high-risk send patterns by policy regardless of approval. Beyond scraping and email, three paid, single-shot routes round out the surface: deep research, which answers a question against current web evidence and should get its actual question in the query field with any relevant background kept separate in a context field; image generation from a text prompt, whose response returns base64 data URLs that should be saved to files rather than printed inline; and web search, which returns ranked title, url, and snippet results with the query capped under 500 characters and each snippet treated as a page summary rather than the full content, opening the actual result URL when more than a summary is needed. A final status-polling route reads or refreshes an in-flight request by its id, restricted to request ids created under the same API key.

Who it's for

Agents and workflows that need to scrape public LinkedIn, GitHub, X/Twitter, YouTube, or general website data, run web search or deep research, generate an image, or draft and send email, all through one consistently-shaped, cost-capped, idempotent API surface rather than a different bespoke integration per data source.

Source README

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 version value 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 this SKILL.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_URL from the environment.
  • Read DEEPAPI_API_KEY from 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_KEY on every request.
  • Send Content-Type: application/json when sending JSON.
  • Send a unique Idempotency-Key for every POST.
  • For scrape work, set explicit maxCostUsd or maxCostMicrousd.
  • Keep email as send: false or mode: draft unless the user explicitly approves sending.
  • Do not pass inbox IDs. Use emailIdentityId or omit it.

Execution Loop

  1. Choose the narrowest endpoint that matches the task.
  2. Build the request from the endpoint schema and examples below.
  3. Run the request with the required headers.
  4. If the response has status: running, wait next.afterSecs and call next.method + next.path until status is succeeded or failed.
  5. If error.retryable is true, wait error.retryAfterSecs before retrying.
  6. 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 same Idempotency-Key.
  7. Report requestId, status, debitMicrousd, costFinal, and the useful part of output.

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 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/channel scrape:youtube Set maxCostUsd: "0.30" 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/search scrape:youtube Set maxCostUsd: "0.10" 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 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 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 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/email/send email:send Uses configured email unit pricing; the route does not accept maxCostUsd. Check debitMicrousd in the response.
GET /v1/email/messages email:read Read route returns debitMicrousd 0.
GET /v1/email/drafts email:read Read route returns debitMicrousd 0.
POST /v1/email/drafts/{draftId}/send email:send Uses configured email unit pricing; the route does not accept maxCostUsd. Check debitMicrousd in the response.
POST /v1/research/deep research:deep Set maxCostUsd: "0.10" unless the user gives a different cap. Defaults to maxCostUsd 0.10. Pass maxCostUsd or maxCostMicrousd to choose a different customer spend cap. The final debit is capped and reported as debitMicrousd.
POST /v1/generate/image generate:image Set maxCostUsd: "0.20" unless the user gives a different cap. Defaults to maxCostUsd 0.20. Pass maxCostUsd or maxCostMicrousd to choose a different customer spend cap. The final debit is capped and reported as debitMicrousd.
POST /v1/search/web search:web Set maxCostUsd: "0.05" unless the user gives a different cap. Defaults to maxCostUsd 0.05. Pass maxCostUsd or maxCostMicrousd to choose a different customer spend cap. The final debit is capped and reported as debitMicrousd.
GET /v1/requests/{requestId} same key Status polling does not create a new debit.

Endpoint Details

Scrape Website

Use POST /v1/scrape/website. Crawl website pages and return clean text and markdown per page.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "1.00",
  "waitForFinishSecs": 60,
  "urls": [
    "https://example.com"
  ],
  "maxPages": 1
}

Scrape LinkedIn Profile

Use POST /v1/scrape/linkedin/profile. Scrape public LinkedIn profile details.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "profiles": [
    "williamhgates"
  ]
}

Scrape GitHub Profile

Use POST /v1/scrape/github/profile. Scrape public GitHub profile details.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.03",
  "waitForFinishSecs": 60,
  "usernames": [
    "octocat"
  ]
}

Search X/Twitter

Use POST /v1/scrape/twitter/search. Scrape X/Twitter posts from a search query or account handles.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.03",
  "waitForFinishSecs": 60,
  "handles": [
    "nasa"
  ],
  "maxItems": 1,
  "sort": "latest"
}

Scrape LinkedIn Jobs

Use POST /v1/scrape/linkedin/jobs. Scrape public LinkedIn job listings for a search query.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "query": "software engineer",
  "location": "United States",
  "maxItems": 5
}

Scrape LinkedIn Company

Use POST /v1/scrape/linkedin/company. Scrape public LinkedIn company pages for firmographic details.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "companies": [
    "microsoft"
  ]
}

Search LinkedIn People

Use POST /v1/scrape/linkedin/people. Search public LinkedIn profiles by role, location, company, or school. Requires maxCostUsd of at least 0.50.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.50",
  "waitForFinishSecs": 60,
  "titles": [
    "Founder"
  ],
  "locations": [
    "San Francisco"
  ],
  "maxItems": 5
}

Scrape LinkedIn Posts

Use POST /v1/scrape/linkedin/posts. Scrape recent public posts from LinkedIn profiles or company pages.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "profiles": [
    "williamhgates"
  ],
  "maxItems": 3
}

Scrape X/Twitter User

Use POST /v1/scrape/twitter/user. Scrape public X/Twitter account profiles, with optional follower and following lists.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "handles": [
    "nasa"
  ]
}

Scrape X/Twitter Replies

Use POST /v1/scrape/twitter/replies. Scrape the public reply thread of an X/Twitter post. Requires maxCostUsd of at least 0.20.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.20",
  "waitForFinishSecs": 60,
  "url": "https://x.com/NASA/status/1234567890123456789",
  "maxItems": 5
}

Scrape YouTube Transcript

Use POST /v1/scrape/youtube/transcript. Scrape the transcript of a YouTube video as plain text plus timed segments. Videos without captions return an empty result.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}

Scrape YouTube Channel

Use POST /v1/scrape/youtube/channel. Scrape a YouTube channel's stats and recent videos. Each video item includes subscriber and channel totals.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.30",
  "waitForFinishSecs": 60,
  "channels": [
    "mkbhd"
  ],
  "maxItems": 3
}

Search YouTube

Use POST /v1/scrape/youtube/search. Search YouTube videos by keyword and return video metadata.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.10",
  "waitForFinishSecs": 60,
  "query": "ai agents",
  "sort": "views",
  "maxItems": 3
}

Scrape LinkedIn

Use POST /v1/scrape/linkedin. Backward-compatible alias for LinkedIn profile scraping.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.05",
  "waitForFinishSecs": 60,
  "profiles": [
    "williamhgates"
  ]
}

Scrape GitHub

Use POST /v1/scrape/github. Backward-compatible alias for GitHub profile scraping.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.03",
  "waitForFinishSecs": 60,
  "usernames": [
    "octocat"
  ]
}

Scrape Twitter

Use POST /v1/scrape/twitter. Backward-compatible alias for X/Twitter search scraping.

Side effects: Starts a scrape run and may debit credits when the run finishes.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Set an explicit customer spend cap with maxCostUsd or maxCostMicrousd before starting a scrape.
  • Start with small result caps such as maxItems or capability-specific limits.
  • Poll next.path while status is running and report the final debitMicrousd.

Example body:

{
  "maxCostUsd": "0.03",
  "waitForFinishSecs": 60,
  "handles": [
    "nasa"
  ],
  "maxItems": 1,
  "sort": "latest"
}

Send Email

Use POST /v1/email/send. Create an email draft from a workspace email identity; set send=true to send it.

Side effects: Creates a draft, or sends an email when direct send is approved.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Keep send=false or mode=draft unless the user explicitly approves sending.
  • Do not pass inboxId or inbox_id; use emailIdentityId or the workspace default.
  • Attachments, hidden HTML, image HTML, URL shorteners, and high-risk direct sends are blocked by policy.

Example body:

{
  "to": "<email-address>",
  "subject": "Quick hello",
  "text": "Hi, this is a draft from my agent.",
  "send": false
}

Receive Email

Use GET /v1/email/messages. Read messages for a workspace email identity.

Side effects: Reads messages only.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Do not pass inboxId or inbox_id; use emailIdentityId or the workspace default.

List Drafts

Use GET /v1/email/drafts. List pending email drafts for a workspace email identity.

Side effects: Reads drafts only.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Do not pass inboxId or inbox_id; use emailIdentityId or the workspace default.

Send Draft

Use POST /v1/email/drafts/{draftId}/send. Approve and send an existing draft by draftId after review.

Side effects: Sends the reviewed draft as a real email when direct send is approved.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Only send a draft after the user explicitly approves that draft.
  • Do not pass inboxId or inbox_id; use emailIdentityId or the workspace default.
  • Sending re-checks recipient and content policy against the stored draft; blocked drafts stay drafts.

Example body:

{}

Deep Research

Use POST /v1/research/deep. Answer a research question with current web evidence.

Side effects: Runs a paid web research request and debits credits when finished.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Use query for the research question and context only for relevant background.
  • Set maxCostUsd when you need a lower or higher spend cap than the default.
  • Report debitMicrousd and summarize the returned sources when sources are present.

Example body:

{
  "query": "What changed in EU AI Act compliance timelines for API startups?",
  "context": "We sell API tooling to EU customers.",
  "maxCostUsd": "0.10"
}

Generate Image

Use POST /v1/generate/image. Generate an image from a text prompt.

Side effects: Runs a paid image generation request and debits credits when finished.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Describe the image you want in prompt, including style and composition.
  • Set maxCostUsd when you need a lower or higher spend cap than the default.
  • output.images contains base64 data URLs; save them to files instead of printing them.

Example body:

{
  "prompt": "A minimal flat illustration of a rocket launching from a laptop screen",
  "maxCostUsd": "0.20"
}

Web Search

Use POST /v1/search/web. Search the web and return ranked results with title, url, and snippet.

Side effects: Runs a paid web search request and debits credits when finished.
Polling: This route returns a terminal envelope directly.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Send a unique Idempotency-Key for every POST.
  • Use query for the search terms only; keep it under 500 characters.
  • Set maxCostUsd when you need a lower or higher spend cap than the default.
  • Treat snippets as page summaries; open a result URL when you need the full content.

Example body:

{
  "query": "latest stable Node.js LTS version",
  "maxResults": 3,
  "maxCostUsd": "0.05"
}

Request Status

Use GET /v1/requests/{requestId}. Poll a running request by requestId.

Side effects: Reads or refreshes request status.
Polling: If status is running, wait next.afterSecs and call next.method next.path until status is succeeded or failed.

Safety:

  • Send Authorization: Bearer $DEEPAPI_API_KEY and never expose the key.
  • Only poll request ids created by the same API key.

Example query: waitForFinishSecs=60

Limitations

  • Adapted from davidondrej/skills; verify local paths, tools, credentials, and agent features before acting.
  • For commands, remote access, scheduling, browser automation, or file-changing workflows, get explicit user approval and confirm the target environment first.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.