Langkau ke kandungan
Rujukan API

CrawlForge MCP Rujukan API

Rujukan lengkap untuk kesemua 31 alat CrawlForge MCP. Bina aplikasi scraping web yang berkuasa dengan API mengutamakan pembangun kami.

Gambaran Keseluruhan API

Base URL

Bash
https://crawlforge.dev/api/v1

Pengesahan

Semua permintaan API memerlukan kunci API yang dihantar dalam pengepala X-API-Key:

Bash
curl -H "X-API-Key: cf_test_YOUR_KEY" \
     https://crawlforge.dev/api/v1/tools/fetch_url

Dapatkan kunci API anda daripada papan pemuka.

Format Permintaan

Semua titik akhir alat menerima JSON dalam badan permintaan:

Json
{
  "url": "https://example.com",
  "timeout": 10000,
  "follow_redirects": true
}

Format Respons

Semua respons mengikut format standard:

Json
{
  "success": true,
  "data": {
    // Tool-specific response data
  },
  "credits_used": 1,
  "credits_remaining": 999,
  "processing_time": 245
}

Respons juga boleh membawa tatasusunan rentetan warnings pilihan di aras atas, bersebelahan data dan credits_used dan bukan di dalam data. Ia hadir hanya apabila sesuatu permintaan menghasilkan amaran: anda mematikan semakan robots.txt dengan respect_robots: false — yang turut direkodkan pada kunci API anda — atau sesuatu alat berbilang URL melangkau satu URL atau tidak mengambil sesuatu sumber. Jika anda tidak pernah mematikan semakan itu dan setiap URL yang anda minta dibenarkan, tiada respons akan membawa medan tersebut; ketiadaannya adalah keadaan biasa, bukan nilai yang hilang.

Kod Status HTTP

KodPenerangan
200OK - Permintaan berjaya
400Bad Request - Parameter tidak sah
401Unauthorized - Kunci API tidak sah atau tiada
402Payment Required - Credits tidak mencukupi
403Forbidden - robots.txt melarang URL itu untuk CrawlForge (atasi dengan respect_robots: false), hos itu berada dalam senarai penarikan diri kekal CrawlForge (tidak boleh diatasi), atau URL itu diselesaikan kepada alamat peribadi atau dalaman. Tiada apa-apa diambil dan tiada credits dicaj
429Too Many Requests - had kadar pelan anda (perlahankan atau naik taraf), atau tapak sasaran meminta CrawlForge menunggu melalui Retry-After pada 429 atau 503-nya sendiri, yang tidak dipengaruhi oleh perubahan pelan dan tidak boleh diatasi oleh respect_robots. Kedua-duanya tidak dicaj
500Internal Server Error

Had Kadar

Free Plan
1 permintaan sesaat
Hobby Plan
2 permintaan sesaat
Professional Plan
4 permintaan sesaat
Business Plan
10 permintaan sesaat

Semua Alat

Alat Asas 1-2 credits

Alat Lanjutan 3-5 credits

Alat Premium 8-10 credits

Monitor terhos

SDK Rasmi

SDK rasmi, crawlforge-sdk di npm dan crawlforge di PyPI, mendedahkan satu kaedah bertaip bagi setiap alat yang menerima parameter yang sama seperti titik akhir REST. Tab TypeScript dan Python pada setiap halaman alat menggunakannya.

Typescript
// npm install crawlforge-sdk
import { CrawlForge } from 'crawlforge-sdk';

const client = new CrawlForge({ apiKey: process.env.CRAWLFORGE_API_KEY });

const result = await client.fetchUrl({ url: 'https://example.com' });
console.log('Credits remaining:', result.creditsRemaining);

Spesifikasi OpenAPI

Keseluruhan API REST diterangkan oleh sebuah dokumen OpenAPI 3.1 di https://www.crawlforge.dev/openapi.json, yang dijana daripada skema yang sama yang mengesahkan setiap permintaan, jadi penjana kod atau klien API boleh dihalakan terus kepadanya.

Bash
curl -s https://www.crawlforge.dev/openapi.json | jq '.paths | keys'

Pengendalian Ralat

Json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input parameters",
    "details": [
      {
        "field": "url",
        "message": "Invalid URL format"
      }
    ]
  }
}

Lihat FAQ untuk senarai lengkap kod ralat dan penyelesaian.

Bersedia untuk mula membina?

Pilih satu alat dan terokai dokumentasinya