# ایک async کرال جاب جمع کریں۔

**API:** Data API

**Endpoint:** `POST /v1/beta/firecrawl/crawl`

**Tags:** Firecrawl

ایک async ویب سائٹ کرال جمع کریں۔ url اور limit فراہم کریں؛ اختیاری طور پر دستاویزی کرال اور اسکریپ آپشنز۔ Idempotency-Key درکار ہے۔ HTTP 202 ایک جاب واپس کرتا ہے؛ اسے completed، failed یا cancelled ہونے تک متعلقہ Felo پولنگ endpoint کے ساتھ استعمال کریں۔ جاب کی قیمت کے فیلڈز پرووائیڈر کی اجازت اور تصفیے کا میٹا ڈیٹا ہیں، نہ کہ Felo کے بلنگ ریکارڈز۔

### قیمت کا حوالہ

- میٹرنگ: میٹر شدہ نتائج کا حوالہ۔
- حوالہ جاتی درخواست کا تخمینہ دستیاب نہیں۔
- صارف کے فی یونٹ حوالہ جاتی قیمت: USD 0.005۔

صرف حوالہ جاتی میٹا ڈیٹا، نہ کہ اکاؤنٹ کا کوٹ، ضمانت شدہ قیمت یا اخراجات کی حد۔ ریسورس کریڈٹس Felo کریڈٹس نہیں ہیں۔ حتمی چارجز Felo کے بلنگ ریکارڈز کے مطابق ہوں گے۔

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | yes | string | تراشے جانے کے بعد UTF-8 لمبائی 1 سے 191 بائٹس تک ہونی چاہیے۔ |

## Request body

Required: **yes**

### application/json

Schema:

```json
{
  "additionalProperties": false,
  "properties": {
    "allowExternalLinks": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "allowSubdomains": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "crawlEntireDomain": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "delay": {
      "maximum": 30,
      "minimum": 0,
      "type": [
        "number",
        "null"
      ]
    },
    "excludePaths": {
      "items": {
        "description": "تراشے جانے کے بعد غیر خالی؛ CR/LF نہیں؛ UTF-8 بائٹ لمبائی محدود ہے۔ زیادہ سے زیادہ UTF-8 لمبائی: 256 بائٹس۔",
        "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$(?![\\s\\S])",
        "type": "string"
      },
      "maxItems": 20,
      "type": [
        "array",
        "null"
      ]
    },
    "ignoreQueryParameters": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "includePaths": {
      "items": {
        "description": "تراشے جانے کے بعد غیر خالی؛ CR/LF نہیں؛ UTF-8 بائٹ لمبائی محدود ہے۔ زیادہ سے زیادہ UTF-8 لمبائی: 256 بائٹس۔",
        "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$(?![\\s\\S])",
        "type": "string"
      },
      "maxItems": 20,
      "type": [
        "array",
        "null"
      ]
    },
    "limit": {
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    },
    "maxConcurrency": {
      "maximum": 20,
      "minimum": 1,
      "type": [
        "integer",
        "null"
      ]
    },
    "maxDiscoveryDepth": {
      "maximum": 10,
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ]
    },
    "scrapeOptions": {
      "additionalProperties": false,
      "properties": {
        "excludeTags": {
          "items": {
            "description": "تراشے جانے کے بعد غیر خالی؛ CR/LF نہیں؛ UTF-8 بائٹ لمبائی محدود ہے۔ زیادہ سے زیادہ UTF-8 لمبائی: 128 بائٹس۔",
            "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$(?![\\s\\S])",
            "type": "string"
          },
          "maxItems": 50,
          "type": [
            "array",
            "null"
          ]
        },
        "includeTags": {
          "items": {
            "description": "تراشے جانے کے بعد غیر خالی؛ CR/LF نہیں؛ UTF-8 بائٹ لمبائی محدود ہے۔ زیادہ سے زیادہ UTF-8 لمبائی: 128 بائٹس۔",
            "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$(?![\\s\\S])",
            "type": "string"
          },
          "maxItems": 50,
          "type": [
            "array",
            "null"
          ]
        },
        "maxAge": {
          "maximum": 31536000000,
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "minAge": {
          "maximum": 31536000000,
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "onlyMainContent": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "timeout": {
          "maximum": 300000,
          "minimum": 1000,
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": [
        "object",
        "null"
      ]
    },
    "sitemap": {
      "enum": [
        null,
        "skip",
        "include",
        "only"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "url": {
      "description": "ہوسٹ نام والا HTTPS URL، بغیر اسناد یا فراگمنٹ کے۔ .pdf پر ختم ہونے والا تراشے جانے کے بعد کا ان پٹ (بڑے چھوٹے حروف سے قطع نظر) تعاون یافتہ نہیں ہے۔",
      "pattern": "^\\s*[hH][tT][tT][pP][sS]://",
      "type": "string"
    }
  },
  "required": [
    "url",
    "limit"
  ],
  "type": "object"
}
```

Example:

```json
{
  "url": "https://example.com",
  "limit": 1
}
```

## Responses

### 202 — کامیابی

Headers:
- `X-Request-Id` (string) — Felo سپورٹ سے رابطہ کرتے وقت شامل کرنے کے لیے درخواست کا شناخت کنندہ۔

**application/json**

Schema: object

```json
{
  "properties": {
    "completedAt": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "endpoint": {
      "type": [
        "string",
        "null"
      ],
      "description": "پرووائیڈر آپریشن شناخت کنندہ؛ پولنگ کے لیے دستاویز شدہ Felo job path استعمال کریں۔"
    },
    "error": {
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": [
        "object",
        "null"
      ]
    },
    "id": {
      "type": [
        "string",
        "null"
      ]
    },
    "object": {
      "const": "integration_async_job",
      "type": "string"
    },
    "output": {},
    "outputExpired": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "pricing": {
      "properties": {
        "authorizedMicrosUSD": {
          "type": [
            "integer",
            "null"
          ]
        },
        "billingMode": {
          "type": [
            "string",
            "null"
          ]
        },
        "currency": {
          "type": [
            "string",
            "null"
          ]
        },
        "finalMicrosUSD": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": [
        "object",
        "null"
      ],
      "description": "مائیکرو-USD میں پرووائیڈر اجازت اور تصفیہ میٹا ڈیٹا؛ یہ Felo بیلنس، ہولڈ یا بلنگ رسید نہیں ہے۔"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "completed",
        "failed",
        "cancelled"
      ],
      "type": "string"
    }
  },
  "required": [
    "completedAt",
    "createdAt",
    "endpoint",
    "error",
    "id",
    "object",
    "output",
    "pricing",
    "status"
  ],
  "type": "object"
}
```

### 400 — درخواست پر کارروائی نہیں ہو سکی۔ درخواست کے پیرامیٹرز چیک کریں۔

### 401 — درست Felo API کلید درکار ہے۔

### 402 — درخواست آگے نہیں بڑھ سکتی کیونکہ بلنگ کی شرط پوری نہیں ہوئی۔

### 403 — اکاؤنٹ کو یہ آپریشن کرنے کی اجازت نہیں۔

### 429 — درخواست یا اخراجات کی حد پوری ہو گئی ہے۔

### 502 — سروس درخواست مکمل نہیں کر سکی۔

### 503 — API یا بلنگ سروس عارضی طور پر دستیاب نہیں۔

### 504 — درخواست پر کارروائی کے دوران سروس کا وقت ختم ہو گیا۔

### default — آپریشن ناکام رہا۔ Felo سپورٹ سے رابطہ کرتے وقت جواب کا request ID محفوظ رکھیں۔
