Skip to content

docs: make Agent endpoints discoverable #1228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanielleWashington wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make Agent endpoints discoverable #1228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion advanced-scraping-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ Use the `/v2/agent` endpoint for autonomous, multi-page data extraction. The age
| `schema` | `object` | — | JSON schema to structure the extracted data. |
| `maxCredits` | `number` | `2500` | Maximum credits the agent can spend. The dashboard supports up to 2,500; for higher limits, set this via the API (values above 2,500 are always billed as paid requests). |
| `strictConstrainToURLs` | `boolean` | `false` | When `true`, the agent only visits the provided URLs. |
| `model` | `string` | `"spark-1-mini"` | AI model to use. `"spark-1-mini"` (default, 60% cheaper) or `"spark-1-pro"` (higher accuracy). |
| `model` | `string` | `"spark-1-pro"` | AI model to use. `"spark-1-pro"` (default, higher accuracy) or `"spark-1-mini"` (60% cheaper). |

<CodeGroup>

Expand Down
4 changes: 1 addition & 3 deletions api-reference/endpoint/agent-delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: 'Cancel Agent'
openapi: '/api-reference/v2-openapi.json DELETE /agent/{jobId}'
hidden: true
noindex: true

---

> Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions.
> Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions.
4 changes: 1 addition & 3 deletions api-reference/endpoint/agent-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: 'Get Agent Status'
openapi: '/api-reference/v2-openapi.json GET /agent/{jobId}'
hidden: true
noindex: true

---

> Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions.
> Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions.
2 changes: 0 additions & 2 deletions api-reference/endpoint/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: 'Agent'
openapi: '/api-reference/v2-openapi.json POST /agent'
hidden: true
noindex: true

---

Expand Down
4 changes: 2 additions & 2 deletions api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2513,8 +2513,8 @@
"spark-1-mini",
"spark-1-pro"
],
"default": "spark-1-mini",
"description": "The model to use for the agent task. spark-1-mini (default) is 60% cheaper, spark-1-pro offers higher accuracy for complex tasks"
"default": "spark-1-pro",
"description": "The model to use for the agent task. spark-1-pro is the default and offers higher accuracy for complex tasks; spark-1-mini is 60% cheaper"
},
"auditMetadata": {
"$ref": "#/components/schemas/AuditMetadata"
Expand Down
2 changes: 1 addition & 1 deletion developer-guides/usage-guides/choosing-the-data-extractor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The `/agent` endpoint is Firecrawl's most advanced offering—the successor to `
- **Autonomous Navigation**: The agent searches and navigates deep into sites to find your data
- **Deep Web Search**: Autonomously discovers information across multiple domains and pages
- **Parallel Processing**: Processes multiple sources simultaneously for faster results
- **Models Available**: `spark-1-mini` (default, 60% cheaper) and `spark-1-pro` (higher accuracy)
- **Models Available**: `spark-1-pro` (default, higher accuracy) and `spark-1-mini` (60% cheaper)

### Example

Expand Down
8 changes: 1 addition & 7 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,6 @@
},
{
"group": "Agent Endpoints",
"hidden": true,
"pages": [
"api-reference/endpoint/agent",
"api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -1320,7 +1319,6 @@
},
{
"group": "Endpoints de agentes",
"hidden": true,
"pages": [
"es/api-reference/endpoint/agent",
"es/api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -2118,7 +2116,6 @@
},
{
"group": "Points de terminaison Agent",
"hidden": true,
"pages": [
"fr/api-reference/endpoint/agent",
"fr/api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -2916,7 +2913,6 @@
},
{
"group": "エージェントエンドポイント",
"hidden": true,
"pages": [
"ja/api-reference/endpoint/agent",
"ja/api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -3714,7 +3710,6 @@
},
{
"group": "Endpoints de agente",
"hidden": true,
"pages": [
"pt-BR/api-reference/endpoint/agent",
"pt-BR/api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -4512,7 +4507,6 @@
},
{
"group": "代理端点",
"hidden": true,
"pages": [
"zh/api-reference/endpoint/agent",
"zh/api-reference/endpoint/agent-get",
Expand Down Expand Up @@ -5340,4 +5334,4 @@
}
},
"theme": "aspen"
}
}
4 changes: 2 additions & 2 deletions es/advanced-scraping-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ Usa el endpoint `/v2/agent` para la extracción autónoma de datos en múltiples
| `schema` | `object` | — | Esquema JSON para estructurar los datos extraídos. |
| `maxCredits` | `number` | `2500` | Máximo de créditos que el agente puede consumir. El panel de control admite hasta 2.500; para límites superiores, configúrelo mediante la API (los valores por encima de 2.500 siempre se facturan como solicitudes de pago). |
| `strictConstrainToURLs` | `boolean` | `false` | Cuando su valor es `true`, el agente solo visita las URLs proporcionadas. |
| `model` | `string` | `"spark-1-mini"` | Modelo de IA a utilizar: `"spark-1-mini"` (predeterminado, 60% más económico) o `"spark-1-pro"` (mayor precisión). |
| `model` | `string` | `"spark-1-pro"` | Modelo de IA a utilizar: `"spark-1-pro"` (predeterminado, mayor precisión) o `"spark-1-mini"` (60% más económico). |

<CodeGroup>
```python Python
Expand Down Expand Up @@ -717,4 +717,4 @@ Si tu firewall bloquea las solicitudes salientes de tu aplicación hacia servici

- **Dirección IP**: `35.245.250.27`

Agrega esta IP a la lista de permitidos de salida de tu firewall para que tu backend pueda enviar solicitudes de scraping, crawling, mapping y de agentes a Firecrawl.
Agrega esta IP a la lista de permitidos de salida de tu firewall para que tu backend pueda enviar solicitudes de scraping, crawling, mapping y de agentes a Firecrawl.
4 changes: 1 addition & 3 deletions es/api-reference/endpoint/agent-delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: 'Cancelar agente'
openapi: '/es/api-reference/v2-openapi.json DELETE /agent/{jobId}'
hidden: true
noindex: true
---

> ¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automatizada.
> ¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automatizada.
4 changes: 1 addition & 3 deletions es/api-reference/endpoint/agent-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: 'Obtener el estado del agente'
openapi: '/es/api-reference/v2-openapi.json GET /agent/{jobId}'
hidden: true
noindex: true
---

> ¿Eres un agente de IA que necesita una API key de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automática.
> ¿Eres un agente de IA que necesita una API key de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automática.
4 changes: 1 addition & 3 deletions es/api-reference/endpoint/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: 'Agente'
openapi: '/es/api-reference/v2-openapi.json POST /agent'
hidden: true
noindex: true
---

> ¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para ver instrucciones de incorporación automatizada.
> ¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para ver instrucciones de incorporación automatizada.
6 changes: 3 additions & 3 deletions es/api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4128,8 +4128,8 @@
"type": "number"
},
"model": {
"default": "spark-1-mini",
"description": "El modelo que utilizará el agente para la tarea. spark-1-mini (predeterminado) es un 60 % más barato; spark-1-pro ofrece mayor precisión para tareas complejas.",
"default": "spark-1-pro",
"description": "El modelo que utilizará el agente para la tarea. spark-1-pro es el predeterminado y ofrece mayor precisión para tareas complejas; spark-1-mini es un 60 % más barato.",
"enum": [
"spark-1-mini",
"spark-1-pro"
Expand Down Expand Up @@ -9906,4 +9906,4 @@
"url": "https://api.firecrawl.dev/v2"
}
]
}
}
4 changes: 2 additions & 2 deletions es/developer-guides/usage-guides/choosing-the-data-extractor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ El endpoint `/agent` es la funcionalidad más avanzada de Firecrawl, el sucesor
* **Navegación autónoma**: El agente busca y navega en profundidad por sitios web para encontrar tus datos
* **Búsqueda profunda en la web**: Descubre información de forma autónoma en múltiples dominios y páginas
* **Procesamiento en paralelo**: Procesa múltiples fuentes simultáneamente para obtener resultados más rápidos
* **Modelos disponibles**: `spark-1-mini` (predeterminado, 60% más económico) y `spark-1-pro` (mayor precisión)
* **Modelos disponibles**: `spark-1-pro` (predeterminado, mayor precisión) y `spark-1-mini` (60% más económico)

<div id="example">
### Ejemplo
Expand Down Expand Up @@ -272,4 +272,4 @@ La ventaja clave es que, con `/agent`, puedes prescindir por completo de las URL
* [Modelos de Agent](/es/features/models)
* [Documentación del modo JSON](/es/features/llm-extract)
* [Documentación de Extract](/es/features/extract)
* [Rastreo por lotes](/es/features/batch-scrape)
* [Rastreo por lotes](/es/features/batch-scrape)
19 changes: 10 additions & 9 deletions es/features/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ og:title: "Agent | Firecrawl"
og:description: "Recopila datos dondequiera que se encuentren en la web. Describe lo que quieres, /agent se encarga del resto."
sidebarTitle: "Agent"
icon: "magic"
noindex: true

---

Expand Down Expand Up @@ -143,19 +142,19 @@ Puedes compartir ejecuciones del agente directamente desde el Agent Playground.
## Selección de modelo
</div>

Firecrawl Agent ofrece dos modelos. **Spark 1 Mini es un 60% más barato** y es el modelo predeterminado — perfecto para la mayoría de los casos de uso. Pásate a Spark 1 Pro cuando necesites la máxima precisión en tareas complejas.
Firecrawl Agent ofrece dos modelos. `spark-1-pro` es el modelo predeterminado y ofrece la máxima precisión para tareas complejas. `spark-1-mini` cuesta un 60% menos y es una buena opción cuando priorizas la eficiencia de costes.

| Modelo | Coste | Precisión | Ideal para |
|--------|-------|-----------|------------|
| `spark-1-mini` | **60% más barato** | Estándar | La mayoría de las tareas (predeterminado) |
| `spark-1-pro` | Estándar | Mayor | Investigación compleja, extracción crítica |
| `spark-1-mini` | **60% más barato** | Estándar | Tareas con prioridad en el coste |
| `spark-1-pro` | Estándar | Mayor | Investigación compleja, extracción crítica (predeterminado) |

<Tip>
**Empieza con Spark 1 Mini** (predeterminado) — gestiona bien la mayoría de las tareas de extracción con un coste un 60% menor. Cambia a Pro solo para investigación compleja en múltiples dominios o cuando la precisión sea crítica.
Agent usa Spark 1 Pro de forma predeterminada. Elige Spark 1 Mini explícitamente cuando quieras reducir el coste de tareas sencillas.
</Tip>

<div id="spark-1-mini-default">
### Spark 1 Mini (predeterminado)
### Spark 1 Mini
</div>

`spark-1-mini` es nuestro modelo eficiente, ideal para tareas sencillas de extracción de datos.
Expand Down Expand Up @@ -201,7 +200,7 @@ Pasa el parámetro `model` para seleccionar el modelo que quieres usar:
| Parámetro | Tipo | Obligatorio | Descripción |
| ------------ | ------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `prompt` | string | **Sí** | Descripción en lenguaje natural de los datos que deseas extraer (máx. 10.000 caracteres) |
| `model` | string | No | Modelo a utilizar: `spark-1-mini` (predeterminado) o `spark-1-pro` |
| `model` | string | No | Modelo a utilizar: `spark-1-pro` (predeterminado) o `spark-1-mini` |
| `urls` | array | No | Lista opcional de URLs en las que centrar la extracción |
| `schema` | object | No | Esquema JSON opcional para una salida estructurada |
| `maxCredits` | number | No | Número máximo de créditos que se pueden usar en esta tarea del agente. De forma predeterminada es **2,500** si no se especifica. El panel de control admite valores de hasta **2,500**; para límites superiores, configura `maxCredits` mediante la API (los valores por encima de 2,500 siempre se tratan como solicitudes de pago). Si se alcanza el límite, el trabajo falla y **no se devuelve ningún dato**. Las ejecuciones fallidas no se facturan: los créditos usados para el razonamiento de IA nunca se cobran en caso de fallo, cualquier crédito usado para llamadas a herramientas durante la ejecución (`scraping`, `search`, `mapping`, etc.) se reembolsa, y la respuesta informa `creditsUsed: 0`. |
Expand Down Expand Up @@ -256,7 +255,9 @@ Consulta la [documentación de Ask](/es/features/ask) para conocer todos los det
## Referencia de la API
</div>

Consulta la [Agent API Reference](/es/api-reference/endpoint/agent) para más detalles.
- [Iniciar una tarea de Agent](/es/api-reference/endpoint/agent)
- [Obtener el estado de Agent](/es/api-reference/endpoint/agent-get)
- [Cancelar una tarea de Agent](/es/api-reference/endpoint/agent-delete)

¿Tienes comentarios o necesitas ayuda? Escríbenos a [help@firecrawl.com](mailto:help@firecrawl.com).

Expand Down Expand Up @@ -314,4 +315,4 @@ Prueba Agent ahora en [firecrawl.dev/app/agent](https://www.firecrawl.dev/app/ag
Los precios están sujetos a cambios a medida que pasamos de la Research Preview a la disponibilidad general. Los usuarios actuales recibirán aviso previo de cualquier actualización de precios.
</Note>

> ¿Eres un Agent de IA que necesita una API key de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automatizada.
> ¿Eres un Agent de IA que necesita una API key de Firecrawl? Consulta [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obtener instrucciones de incorporación automatizada.
Loading