{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/search-tools:algolia-crawler/list-crawlers":{"get":{"operationId":"search_tools_algolia_crawler_list_crawlers","summary":"List crawlers","description":"GET /1/crawlers","tags":["search-tools"],"parameters":[{"name":"itemsPerPage","in":"query","required":false,"description":"Number of items per page to retrieve.","schema":{"type":"integer","default":20,"description":"Number of items per page to retrieve."}},{"name":"page","in":"query","required":false,"description":"Page to retrieve.","schema":{"type":"integer","default":1,"description":"Page to retrieve."}},{"name":"name","in":"query","required":false,"description":"Name of the crawler for filtering the API response.","schema":{"type":"string","description":"Name of the crawler for filtering the API response."}},{"name":"appID","in":"query","required":false,"description":"Algolia application ID for filtering the API response.","schema":{"type":"string","description":"Algolia application ID for filtering the API response."}}],"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:algolia-crawler/create-crawler":{"post":{"operationId":"search_tools_algolia_crawler_create_crawler","summary":"Create a crawler","description":"POST /1/crawlers","tags":["search-tools"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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:algolia-crawler/get-crawler":{"get":{"operationId":"search_tools_algolia_crawler_get_crawler","summary":"Retrieve crawler details","description":"GET /1/crawlers/{id}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"withConfig","in":"query","required":false,"description":"Whether the response should include the crawler's configuration.","schema":{"type":"boolean","description":"Whether the response should include the crawler's configuration."}}],"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:algolia-crawler/patch-crawler":{"post":{"operationId":"search_tools_algolia_crawler_patch_crawler","summary":"Replace crawler configuration","description":"PATCH /1/crawlers/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."},"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:algolia-crawler/delete-crawler":{"post":{"operationId":"search_tools_algolia_crawler_delete_crawler","summary":"Delete a crawler","description":"DELETE /1/crawlers/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."}}}}}},"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:algolia-crawler/run-crawler":{"post":{"operationId":"search_tools_algolia_crawler_run_crawler","summary":"Unpause a crawler","description":"POST /1/crawlers/{id}/run","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."}}}}}},"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:algolia-crawler/pause-crawler":{"post":{"operationId":"search_tools_algolia_crawler_pause_crawler","summary":"Pause a crawler","description":"POST /1/crawlers/{id}/pause","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."}}}}}},"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:algolia-crawler/start-reindex":{"post":{"operationId":"search_tools_algolia_crawler_start_reindex","summary":"Start a crawl","description":"POST /1/crawlers/{id}/reindex","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."}}}}}},"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:algolia-crawler/test-url":{"post":{"operationId":"search_tools_algolia_crawler_test_url","summary":"Test crawl a URL","description":"POST /1/crawlers/{id}/test","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."},"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:algolia-crawler/crawl-urls":{"post":{"operationId":"search_tools_algolia_crawler_crawl_urls","summary":"Crawl URLs","description":"POST /1/crawlers/{id}/urls/crawl","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."},"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:algolia-crawler/get-stats":{"get":{"operationId":"search_tools_algolia_crawler_get_stats","summary":"Retrieve crawler stats","description":"GET /1/crawlers/{id}/stats/urls","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}}],"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:algolia-crawler/list-crawl-runs":{"get":{"operationId":"search_tools_algolia_crawler_list_crawl_runs","summary":"List crawler runs","description":"GET /1/crawlers/{id}/crawl_runs","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"from","in":"query","required":false,"description":"Date 'from' filter.","schema":{"type":"string","description":"Date 'from' filter."}},{"name":"until","in":"query","required":false,"description":"Date 'until' filter.","schema":{"type":"string","description":"Date 'until' filter."}},{"name":"status","in":"query","required":false,"description":"Status to filter 'DONE', 'SKIPPED' or 'FAILED'.","schema":{"type":"string","enum":["DONE","SKIPPED","FAILED"],"description":"Status to filter 'DONE', 'SKIPPED' or 'FAILED'."}},{"name":"limit","in":"query","required":false,"description":"Limit of the query results.","schema":{"type":"integer","default":10,"description":"Limit of the query results."}},{"name":"offset","in":"query","required":false,"description":"Offset of the query results.","schema":{"type":"integer","description":"Offset of the query results."}},{"name":"order","in":"query","required":false,"description":"Order of the query 'ASC' or 'DESC'.","schema":{"type":"string","enum":["ASC","DESC"],"description":"Order of the query 'ASC' or 'DESC'."}}],"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:algolia-crawler/get-crawl-run-file":{"get":{"operationId":"search_tools_algolia_crawler_get_crawl_run_file","summary":"Crawler run file","description":"GET /1/crawlers/{id}/{logId}/download","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"logId","in":"query","required":true,"description":"Crawler log ID.","schema":{"type":"string","description":"Crawler log ID."}}],"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:algolia-crawler/delete-crawl-run":{"post":{"operationId":"search_tools_algolia_crawler_delete_crawl_run","summary":"Crawler run record deletion","description":"POST /1/crawlers/{id}/delete_runs","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."},"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:algolia-crawler/patch-config":{"post":{"operationId":"search_tools_algolia_crawler_patch_config","summary":"Update crawler configuration","description":"PATCH /1/crawlers/{id}/config","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Crawler ID."},"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:algolia-crawler/list-config-versions":{"get":{"operationId":"search_tools_algolia_crawler_list_config_versions","summary":"List configuration versions","description":"GET /1/crawlers/{id}/config/versions","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"itemsPerPage","in":"query","required":false,"description":"Number of items per page to retrieve.","schema":{"type":"integer","default":20,"description":"Number of items per page to retrieve."}},{"name":"page","in":"query","required":false,"description":"Page to retrieve.","schema":{"type":"integer","default":1,"description":"Page to retrieve."}}],"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:algolia-crawler/get-config-version":{"get":{"operationId":"search_tools_algolia_crawler_get_config_version","summary":"Retrieve a configuration version","description":"GET /1/crawlers/{id}/config/versions/{version}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"version","in":"query","required":true,"description":"This crawler's version nmber.","schema":{"type":"integer","description":"This crawler's version nmber."}}],"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:algolia-crawler/get-task-status":{"get":{"operationId":"search_tools_algolia_crawler_get_task_status","summary":"Retrieve task status","description":"GET /1/crawlers/{id}/tasks/{taskID}","tags":["search-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"Crawler ID.","schema":{"type":"string","description":"Crawler ID."}},{"name":"taskID","in":"query","required":true,"description":"Task ID.","schema":{"type":"string","description":"Task ID."}}],"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:algolia-crawler/cancel-blocking-action":{"post":{"operationId":"search_tools_algolia_crawler_cancel_blocking_action","summary":"Cancel a blocking task","description":"POST /1/crawlers/{id}/tasks/{taskID}/cancel","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","taskID"],"properties":{"id":{"type":"string","description":"Crawler ID."},"taskID":{"type":"string","description":"Task ID."}}}}}},"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:algolia-crawler/list-domains":{"get":{"operationId":"search_tools_algolia_crawler_list_domains","summary":"List registered domains","description":"GET /1/domains","tags":["search-tools"],"parameters":[{"name":"itemsPerPage","in":"query","required":false,"description":"Number of items per page to retrieve.","schema":{"type":"integer","default":20,"description":"Number of items per page to retrieve."}},{"name":"page","in":"query","required":false,"description":"Page to retrieve.","schema":{"type":"integer","default":1,"description":"Page to retrieve."}},{"name":"appID","in":"query","required":false,"description":"Algolia application ID for filtering the API response.","schema":{"type":"string","description":"Algolia application ID for filtering the API response."}}],"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"}}}}}}}