Quickstart

This guide takes you from zero to your first result. It uses the YouTube transcripts tool because it needs nothing but a video link.

1. Create an accountCopy Anchor Link

Sign in at /login with your email address. You get a sign-in link by email, no password needed. New accounts start with 2,000 free credits.

2. Get an API keyCopy Anchor Link

API keys start with af_live_ and are shown to you once, right after you create them. We only store a hash of the key, so we cannot show it again; if you lose it, create a new one and revoke the old one.

Keep the key out of your code and your repository. Put it in an environment variable instead:

export PULLWIRE_API_KEY="af_live_..."

3. Make your first callCopy Anchor Link

Start a run of the youtube-transcripts tool. The request body is the tool's input; the tool reference lists every field.

curl -X POST "https://pullwire.dev/api/v1/tools/youtube-transcripts/runs" \
  -H "x-api-key: $PULLWIRE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"videos": ["https://www.youtube.com/watch?v=jNQXAC9IVRw"], "includeSegments": false, "maxResults": 1}'

A run that finishes within 25 seconds answers with the run and its results. The response looks like this:

{
  "run": {
    "id": "6f1c2a9e-0000-4000-8000-000000000000",
    "toolId": "youtube-transcripts",
    "status": "succeeded",
    "source": "api",
    "resultsCount": 1,
    "creditsUsed": 1,
    "error": null
  },
  "results": [
    {
      "videoId": "jNQXAC9IVRw",
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw",
      "title": "Me at the zoo",
      "text": "…"
    }
  ]
}

4. Check your balanceCopy Anchor Link

curl "https://pullwire.dev/api/v1/me" -H "x-api-key: $PULLWIRE_API_KEY"

The answer contains your orgId and your current balance in credits.

Next stepsCopy Anchor Link

• Long runs and background jobs: Runs
• What a run costs: Credits
• What can go wrong and what to do: Errors