{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ai:visiblethread/get-dictionaries":{"get":{"operationId":"ai_visiblethread_get_dictionaries","summary":"Get your list of dictionaries","description":"GET /dictionaries","tags":["ai"],"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/ai:visiblethread/upload-dictionary":{"post":{"operationId":"ai_visiblethread_upload_dictionary","summary":"Upload a dictionary (CSV)","description":"POST /dictionaries","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/ai:visiblethread/get-documents":{"get":{"operationId":"ai_visiblethread_get_documents","summary":"Get your list of documents","description":"GET /documents","tags":["ai"],"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/ai:visiblethread/upload-doc":{"post":{"operationId":"ai_visiblethread_upload_doc","summary":"Upload a document","description":"POST /documents","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/ai:visiblethread/get-doc-by-id":{"get":{"operationId":"ai_visiblethread_get_doc_by_id","summary":"Get data from a previously submitted document","description":"GET /documents/{docId}","tags":["ai"],"parameters":[{"name":"docId","in":"query","required":true,"description":"Id of document to fetch","schema":{"type":"integer","description":"Id of document to fetch"}}],"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/ai:visiblethread/get-searches":{"get":{"operationId":"ai_visiblethread_get_searches","summary":"Get your list of searches","description":"GET /searches","tags":["ai"],"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/ai:visiblethread/run-search":{"post":{"operationId":"ai_visiblethread_run_search","summary":"Run a search","description":"POST /searches","tags":["ai"],"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/ai:visiblethread/get-search-results":{"get":{"operationId":"ai_visiblethread_get_search_results","summary":"Gets search results for a particular document/dictionary","description":"GET /searches/{docId}/{dictionaryId}","tags":["ai"],"parameters":[{"name":"docId","in":"query","required":true,"description":"Id of document","schema":{"type":"integer","description":"Id of document"}},{"name":"dictionaryId","in":"query","required":true,"description":"Id of dictionary","schema":{"type":"integer","description":"Id of dictionary"}},{"name":"matchingOnly","in":"query","required":true,"description":"Only returning paragraphs containing a match","schema":{"type":"boolean","description":"Only returning paragraphs containing a match"}}],"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/ai:visiblethread/get-webscans":{"get":{"operationId":"ai_visiblethread_get_webscans","summary":"Get your list of scans","description":"GET /webscans","tags":["ai"],"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/ai:visiblethread/run-scan":{"post":{"operationId":"ai_visiblethread_run_scan","summary":"Run a new scan","description":"POST /webscans","tags":["ai"],"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/ai:visiblethread/get-scan-by-id":{"get":{"operationId":"ai_visiblethread_get_scan_by_id","summary":"Get data from a previously run scan","description":"GET /webscans/{scanId}","tags":["ai"],"parameters":[{"name":"scanId","in":"query","required":true,"description":"Id of scan to fetch","schema":{"type":"integer","description":"Id of scan to fetch"}}],"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/ai:visiblethread/get-scan-url-by-id":{"get":{"operationId":"ai_visiblethread_get_scan_url_by_id","summary":"Gets data for a particular scan/webUrl","description":"GET /webscans/{scanId}/webUrls/{urlId}","tags":["ai"],"parameters":[{"name":"scanId","in":"query","required":true,"description":"Id of scan","schema":{"type":"integer","description":"Id of scan"}},{"name":"urlId","in":"query","required":true,"description":"Id of url to fetch","schema":{"type":"integer","description":"Id of url to fetch"}}],"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"}}}}}}}