{"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/cloud:azure-cognitiveservices-content-safety/image-operations-analyze-image":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_image_operations_analyze_image","summary":"Analyze Image","description":"POST /image:analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-list-text-blocklists":{"get":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_list_text_blocklists","summary":"Get All Text Blocklists","description":"GET /text/blocklists","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."}}],"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-get-text-blocklist":{"get":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_get_text_blocklist","summary":"Get Text Blocklist By blocklistName","description":"GET /text/blocklists/{blocklistName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."}},{"name":"blocklistName","in":"query","required":true,"description":"Text blocklist name.","schema":{"type":"string","description":"Text blocklist name."}}],"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-create-or-update-text-blocklist":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_create_or_update_text_blocklist","summary":"Create Or Update Text Blocklist","description":"PATCH /text/blocklists/{blocklistName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","blocklistName","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"blocklistName":{"type":"string","description":"Text blocklist name."},"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-delete-text-blocklist":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_delete_text_blocklist","summary":"Delete Text Blocklist By blocklistName","description":"DELETE /text/blocklists/{blocklistName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","blocklistName"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"blocklistName":{"type":"string","description":"Text blocklist name."}}}}}},"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-add-or-update-blocklist-items":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_add_or_update_blocklist_items","summary":"Add or update BlocklistItems To Text Blocklist","description":"POST /text/blocklists/{blocklistName}:addOrUpdateBlocklistItems","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","blocklistName","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"blocklistName":{"type":"string","description":"Text blocklist name."},"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-remove-blocklist-items":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_remove_blocklist_items","summary":"Remove BlocklistItems From Text Blocklist","description":"POST /text/blocklists/{blocklistName}:removeBlocklistItems","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","blocklistName","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"blocklistName":{"type":"string","description":"Text blocklist name."},"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-list-text-blocklist-items":{"get":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_list_text_blocklist_items","summary":"Get All BlocklistItems By blocklistName","description":"GET /text/blocklists/{blocklistName}/blocklistItems","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."}},{"name":"blocklistName","in":"query","required":true,"description":"Text blocklist name.","schema":{"type":"string","description":"Text blocklist name."}},{"name":"top","in":"query","required":false,"description":"The number of result items to return.","schema":{"type":"integer","description":"The number of result items to return."}},{"name":"skip","in":"query","required":false,"description":"The number of result items to skip.","schema":{"type":"integer","default":0,"description":"The number of result items to skip."}},{"name":"maxpagesize","in":"query","required":false,"description":"The maximum number of result items per page.","schema":{"type":"integer","description":"The maximum number of result items per page."}}],"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/cloud:azure-cognitiveservices-content-safety/text-blocklists-get-text-blocklist-item":{"get":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_blocklists_get_text_blocklist_item","summary":"Get BlocklistItem By blocklistName And blocklistItemId","description":"GET /text/blocklists/{blocklistName}/blocklistItems/{blocklistItemId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."}},{"name":"blocklistName","in":"query","required":true,"description":"Text blocklist name.","schema":{"type":"string","description":"Text blocklist name."}},{"name":"blocklistItemId","in":"query","required":true,"description":"The service will generate a BlocklistItemId, which will be a UUID.","schema":{"type":"string","description":"The service will generate a BlocklistItemId, which will be a UUID."}}],"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/cloud:azure-cognitiveservices-content-safety/text-operations-analyze-text":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_operations_analyze_text","summary":"Analyze Text","description":"POST /text:analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"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/cloud:azure-cognitiveservices-content-safety/text-operations-detect-text-protected-material":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_operations_detect_text_protected_material","summary":"Detect Protected Material for Text","description":"POST /text:detectProtectedMaterial","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"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/cloud:azure-cognitiveservices-content-safety/text-operations-shield-prompt":{"post":{"operationId":"cloud_azure_cognitiveservices_content_safety_text_operations_shield_prompt","summary":"Shield Prompt","description":"POST /text:shieldPrompt","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https:// .cognitiveservices.azure.com)."},"api-version":{"type":"string","default":"2024-09-01","description":"The API version to use for this operation."},"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"}}},"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"}}}}}}}