{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/search-tools:firecrawl/scrape-and-extract-from-url":{"post":{"operationId":"search_tools_firecrawl_scrape_and_extract_from_url","summary":"Scrape a single URL and optionally extract information using an LLM","description":"POST /scrape","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/scrape-and-extract-from-urls":{"post":{"operationId":"search_tools_firecrawl_scrape_and_extract_from_urls","summary":"Scrape multiple URLs and optionally extract information using an LLM","description":"POST /batch/scrape","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-batch-scrape-status":{"get":{"operationId":"search_tools_firecrawl_get_batch_scrape_status","summary":"Get the status of a batch scrape job","description":"GET /batch/scrape/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the batch scrape job","schema":{"type":"string","description":"The ID of the batch scrape job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/cancel-batch-scrape":{"post":{"operationId":"search_tools_firecrawl_cancel_batch_scrape","summary":"Cancel a batch scrape job","description":"DELETE /batch/scrape/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the batch scrape job"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-batch-scrape-errors":{"get":{"operationId":"search_tools_firecrawl_get_batch_scrape_errors","summary":"Get the errors of a batch scrape job","description":"GET /batch/scrape/{id}/errors","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the batch scrape job","schema":{"type":"string","description":"The ID of the batch scrape job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-crawl-status":{"get":{"operationId":"search_tools_firecrawl_get_crawl_status","summary":"Get the status of a crawl job","description":"GET /crawl/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the crawl job","schema":{"type":"string","description":"The ID of the crawl job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/cancel-crawl":{"post":{"operationId":"search_tools_firecrawl_cancel_crawl","summary":"Cancel a crawl job","description":"DELETE /crawl/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the crawl job"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-crawl-errors":{"get":{"operationId":"search_tools_firecrawl_get_crawl_errors","summary":"Get the errors of a crawl job","description":"GET /crawl/{id}/errors","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the crawl job","schema":{"type":"string","description":"The ID of the crawl job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/crawl-urls":{"post":{"operationId":"search_tools_firecrawl_crawl_urls","summary":"Crawl multiple URLs based on options","description":"POST /crawl","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/map-urls":{"post":{"operationId":"search_tools_firecrawl_map_urls","summary":"Map multiple URLs based on options","description":"POST /map","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/extract-data":{"post":{"operationId":"search_tools_firecrawl_extract_data","summary":"Extract structured data from pages using LLMs","description":"POST /extract","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-extract-status":{"get":{"operationId":"search_tools_firecrawl_get_extract_status","summary":"Get the status of an extract job","description":"GET /extract/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the extract job","schema":{"type":"string","description":"The ID of the extract job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-active-crawls":{"get":{"operationId":"search_tools_firecrawl_get_active_crawls","summary":"Get all active crawls for the authenticated team","description":"GET /crawl/active","tags":["search-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/start-deep-research":{"post":{"operationId":"search_tools_firecrawl_start_deep_research","summary":"Start a deep research operation on a query","description":"POST /deep-research","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-deep-research-status":{"get":{"operationId":"search_tools_firecrawl_get_deep_research_status","summary":"Get the status and results of a deep research operation","description":"GET /deep-research/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the research job","schema":{"type":"string","description":"The ID of the research job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-credit-usage":{"get":{"operationId":"search_tools_firecrawl_get_credit_usage","summary":"Get remaining credits for the authenticated team","description":"GET /team/credit-usage","tags":["search-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-token-usage":{"get":{"operationId":"search_tools_firecrawl_get_token_usage","summary":"Get remaining tokens for the authenticated team (Extract only)","description":"GET /team/token-usage","tags":["search-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/search-and-scrape":{"post":{"operationId":"search_tools_firecrawl_search_and_scrape","summary":"Search and optionally scrape search results","description":"POST /search","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/generate-llms-txt":{"post":{"operationId":"search_tools_firecrawl_generate_llms_txt","summary":"Generate LLMs.txt for a website","description":"POST /llmstxt","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/search-tools:firecrawl/get-llms-txt-status":{"get":{"operationId":"search_tools_firecrawl_get_llms_txt_status","summary":"Get the status and results of an LLMs.txt generation job","description":"GET /llmstxt/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the LLMs.txt generation job","schema":{"type":"string","description":"The ID of the LLMs.txt generation job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}