Saltar al contenido
ES
Obtener clave API
Explorar documentación

Referencia de la API

Herramientas y esquemas MCP

Busque argumentos de herramienta FlashData MCP, defectos, lecturas de cuenta, estados de trabajo y recuperación de resultados.

En esta página

Versión Markdown

OAuth, Codex, OpenClaw y API-key opciones de acceso

Elija su cliente MCP y conéctese

Transporte y autenticación

El punto final MCP hospedado utiliza Streamable HTTP. Las conexiones API-key envían X-API-Key; el acceso a la herramienta sigue los permisos de la fuente de la clave y los créditos disponibles.

HTTP
URL: https://data.flashdata.dev/mcp
X-API-Key- Te apuntó. API clave

Almacene su real FlashData API clave en la configuración credencial del cliente. No lo ponga en una conversación o argumentos de herramientas. API- conexiones clave; la guía de acceso de agente cubre OAuth inicio de sesión y la prueba Codex y OpenClaw configuraciones. youtube_download soporta descargas de medios asincrónicas con el apropiado API- permiso de llaves.

Gestione las teclas API

Herramientas de consulta

Su cliente descubre las herramientas otorgadas por la clave. Todas las seis herramientas de datos Google y ocho YouTube predeterminadas a tiempo real y también aceptan mode: async. submit_batch admite ambos grupos. youtube_download utiliza la descarga formal API, requiere almacenamiento de clientes, y admite trabajos asinc o submit_batch.

Google

google_search · google_images · google_news · google_shopping · google_videos · google_places

YouTube

youtube_search · youtube_search_extended · youtube_metadata · youtube_transcript · youtube_captions · youtube_trainability · youtube_channel · youtube_suggestions · youtube_download

google_search · argumentos JSON
{
  "query": "MCP protocol",
  "num": 3,
  "gl": "us",
  "hl": "en",
  "mode": "async"
}

Discusiones de herramientas

Poner campos de consulta tales como consulta, num, lenguaje y modo directamente en el objeto de argumentos de la herramienta, sin el REST API’s params wrapper. El nombre de una herramienta de consulta selecciona su fuente; sólo entradas en submit_batch necesita fuente. API llaves y callback_url no son argumentos de herramientas. JSON ejemplos a continuación son objetos de argumento client.callTool({ nombre, argumentos }).

Utilizar booleanos JSON y números enteros, no cadenas. Los campos desconocidos son rechazados. Las herramientas de consulta de datos 14 aceptan mode: realtime o async, predeterminando en tiempo real. Las entradas Batch no aceptan el modo.

HerenciaObligatorioDiscusiones opcionales " predeterminados
youtube_downloadvideo_id, storagemode solo admite async (predeterminado). download_type: audio_video (predeterminado)/video/audio. video_quality: <=720 de forma predeterminada; best/worst o <=, ==, >= con 144/360/480/720/1080/1440/2160/4320. fps: las mismas comparaciones con 1–240. output_format: mp4 (predeterminado)/webm/mkv para vídeo, m4a (predeterminado)/mp3/opus para audio. audio_language: default/original; audio_quality: best/320/256/192/128, solo para audio. yt_dlp_format: hasta 1024 caracteres; sustituye la selección de calidad, fps e idioma. Omita video_quality/fps para audio y audio_language para vídeo sin audio. storage es obligatorio y coincide con params.storage de Download API. start_at/end_at: HH:MM:SS, hasta 12 horas; end_at debe ser posterior a start_at. upload_metadata: booleano, false de forma predeterminada. Cada descarga por lotes necesita storage. No se admiten browser_delivery ni callback_url.
storagestorage_type, storage_urlstorage_url es tu nombre de cubo (Azure: container), no un directorio local. storage_type: s3/s3_compatible/oss/gcs/azure/cos/bos/tos; opcional object_prefix. S3, S3-compatible, OSS, COS, BOS y TOS access_key/secret_key con la región aplicable/endpoint_url. GCS utiliza service_account (project_id, client_email, private_key); Azure utiliza account_name y un contenedor sas_token con permiso de escritura. El punto final debe ser accesible desde el Trabajador. Lea las credenciales de su configuración de almacenamiento; no las pegue en chat o haga clic en ellas.
google_*queryquery: 1–2,000 caracteres. gl: país de dos letras; hl: 1–35 código de lenguaje de carácter; ubicación/tbs: 1–200 caracteres; num/page: enteros 1–100; autocorrecto: booleano. Las opciones omitidas utilizan el comportamiento del proveedor de búsqueda, sin ningún país fijo, idioma o resultado cuentan garantizado.
youtube_searchqueryquery: 1–2,000 personajes. max_results: 1–20, por defecto 20; filtros: objeto filtrante, omitido o nulo sin filtros.
youtube_search_extendedqueryquery: 1–2,000 personajes. max_results: 1–700, por defecto 20; filtros: igual que la búsqueda estándar.
youtube_metadatavideo_idinclude_formats y include_chapters: booleanos, ambos por defecto verdadero.
youtube_transcriptvideo_idOmitir lenguaje para preferir en-orig, luego en, devolver una pista. Con auto=true, cada código prefiere su pista de -orig, luego el código llano; explícita -orig y auto=false mantener exacto. Arrays probar todos 1–10 idiomas solicitados y devoluciones de pistas y errores en orden. auto predeterminado a verdadero para capciones automáticas.
youtube_captionsvideo_idOmitir lenguaje para preferir en-orig, luego en, devolver una pista. Con auto=true, cada código prefiere su pista de -orig, luego el código llano; explícita -orig y auto=false mantener exacto. Arrays probar todos 1–10 idiomas solicitados y devuelve pistas y errores en orden. auto predetermina a falso para subidas proporcionadas por subidor.
youtube_trainabilityvideo_idNo hay argumentos opcionales excepto el modo. Informes Clasificación de licencias Creative Commons; no otorga permiso de entrenamiento.
youtube_channelhandlehandle: 1–100 caracteres; video_limit: 1–100, predeterminado 20.
youtube_suggestionsqueryquery: 1–2,000 caracteres; idioma: default en; region: two-letter country code, default US.

video_id es un 11-Caracter YouTube ID usando letras, números, subrayados o hifénes; suministrar el ID más que el video URL. Cada código de idioma es 1–35 caracteres que utilizan letras, números o hyphens. Para subtítulos, auto=true selecciona las subtítulos automáticos y falsos selecciona las subtítulos proporcionados por subgerentes, sin retroceso automático entre ellos. Para los arrays de idiomas, comprueba errores incluso cuando el trabajo tenga éxito.

Filtros de búsqueda YouTube

filters.type: video/channel/playlist/movie; upload_date: today/last_hour/this_week/this_month/this_year; duration: <4, 4-20 o >20; sort_by: rating/relevance/view_count/upload_date. Los indicadores de características son booleanos; true exige esa característica: 360, 3d, 4k, creative_commons, hd, hdr, live, location, purchased, subtitles, vr180.

youtube_search · argumentos JSON
{
  "query": "renewable energy",
  "max_results": 5,
  "filters": {
    "type": "video",
    "duration": "<4",
    "subtitles": true
  }
}

Información de la cuenta (gratuita)

get_balance lee el saldo de su cuenta compartida; get_pricing calcula los costos de consulta; get_limits lee los límites del plan y los trabajos pendientes actuales; get_usage resume los últimos días 7 por defecto, con una ventana máxima 31-day. El uso incluye todas las claves de cuenta para las fuentes autorizadas por la tecla de llamada y puede ser retrasada.

get_balance y get_limits Toma. get_pricing acepta una fuente opcional; omitirla para todos MCP fuentes de consulta autorizadas por tu llave. request_count es un entero de 1 a 100000, por defecto 1; cada página o artículo de lotes cuenta como una solicitud separada. get_usage acepta una fuente opcional; omitirla para todas las fuentes autorizadas. Incluye el uso de youtube_download. Devuelve los precios de descarga creditsPerTb (1 TB = 10^12 bytes); descargas reserva Créditos y liquida bytes cargados. request_count no se aplica a las descargas y estimatedCredits es null.

get_usage desde/to debe ser UTC ISO timetamps tales como 2026-09- 21T00:00:00Z, opcionalmente con 1–3 segundo dígitos fraccionados. desde es inclusivo, hasta exclusivo, redondeado hasta minutos. La ventana predeterminada es 7 días y el máximo 31 días. Con sólo de, a es siete días después; con sólo a, de es siete días antes. Lea la respuesta de/to para la ventana efectiva.

get_pricing · argumentos JSON
{
  "source": "google_search",
  "request_count": 3
}
get_usage · argumentos JSON
{
  "source": "youtube_metadata",
  "from": "2026-09-21T00:00:00Z",
  "to": "2026-09-22T00:00:00Z"
}

Trabajos y resultados grandes

Una solicitud de asinc devuelve un trabajo id; pasarlo como job_id a get_job para leer job.status. Los trabajos completados incluyen la respuesta original de la consulta en la salida. Para las descargas, la salida es el manifiesto de carga: output.results[0].file_url apunta al almacenamiento del cliente, con file_size, downloaded_bytes y md5. Los archivos privados requieren su autenticación de almacenamiento. Los resultados de JSON se mantienen para las horas de 24; retención de medios y acceso siguen sus políticas de almacenamiento. submit_batch acepta por lo menos una consulta Google o YouTube (incluyendo descargas), con argumentos de origen y planos en cada entrada. Cada entrada es facturada por separado, y se aplican los límites de su plan por lotes y pendientes. Los trabajos de lectura no cobran de nuevo. Bulk basado en archivos no es una herramienta MCP.

¿Procesando un archivo ID? Utilice el Bulk HTTP API

youtube_transcript · argumentos JSON
{
  "video_id": "FUfGcZ092b0",
  "language": "en",
  "auto": true,
  "mode": "async"
}
submit_batch · argumentos JSON
{
  "queries": [
    {
      "source": "google_search",
      "query": "renewable energy",
      "num": 3
    },
    {
      "source": "youtube_metadata",
      "video_id": "FUfGcZ092b0",
      "include_formats": false
    }
  ]
}

Reemplazar el ejemplo job_id, result_id y compensar con los valores de tu respuesta. Lea el siguiente trozo sin volver a enviar la consulta.

get_job · argumentos JSON
{
  "job_id": "job_REPLACE_WITH_RETURNED_ID"
}

Las grandes respuestas incluyen un fragmento de texto JSON, result_id y next_offset. Call get_result con la misma llave y el devuelto result_id. offset is a nonnegative integer, default 0; utilizar el anterior next_offset para continuar. El límite es un entero 1 a 16000, por defecto 16000, medido en UTF-16 unidades de código en lugar de bytes o filas de resultado. Los trozos de concatenado en orden antes de cortar JSON; next_offset=null marca el final. Los resultados están grabados para minutos 10, con al menos cuatro grandes resultados por clave, y puede ser desalojado antes. Leyendo trozos no repite la consulta o cobra Créditos.

get_result · argumentos JSON
{
  "result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
  "offset": 16000,
  "limit": 16000
}

Facturación y errores

Las consultas utilizan los precios de créditos de su plan existente sin cargo adicional MCP. Los errores de la herramienta establecen isError y conservan el estado de HTTP y solicitan ID. Restaurar Créditos para un saldo insuficiente y comprobar permisos clave para errores de acceso.

Una conexión temporal o perdida no significa que la consulta no fue ejecutada. Para query_outcome_unknown, verifique Solicitar historia en la consola antes de decidir someterse de nuevo. No vuelva a enviar automáticamente las presentaciones pagadas; se pueden recortar lecturas de trabajos o trozos existentes. Las respuestas preliminares se limitan a 4 MiB, así que limitar el tamaño de búsqueda; las respuestas sobredimensionadas ya se han cobrado.

Underlying HTTP códigos de estado · Reglas de entrada

Verificar con un cliente JavaScript

Este cliente utiliza las herramientas oficiales verificadas SDK 1.30.0 para conectarse sobre Streamable HTTP y listar sin ejecutar una consulta pagada. Ahorre como mcp-check.mjs, establezca FLASHDATA_API_KEY en su entorno, y luego ejecute el nodo mcp-check.mjs.

npm
npm install @modelcontextprotocol/[email protected]
mcp-check.mjs
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';

const key = process.env.FLASHDATA_API_KEY;
if (!key) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new Client({ name: 'my-app', version: '1.0.0' });
try {
  await client.connect(new StreamableHTTPClientTransport(
    new URL('https://data.flashdata.dev/mcp'),
    { requestInit: { headers: { 'X-API-Key': key } } }
  ));
  console.log((await client.listTools()).tools.map(tool => tool.name));
} finally {
  await client.close();
}