{"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:algolia-composition/custom-get":{"get":{"operationId":"search_tools_algolia_composition_custom_get","summary":"Send requests to the Algolia REST API","description":"GET /{path}","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"path","in":"query","required":true,"description":"Path of the endpoint, for example `1/newFeature`.","schema":{"type":"string","description":"Path of the endpoint, for example `1/newFeature`."}},{"name":"parameters","in":"query","required":false,"description":"Query parameters to apply to the current query.","schema":{"type":"object","description":"Query parameters to apply to the current query."}}],"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-composition/custom-post":{"post":{"operationId":"search_tools_algolia_composition_custom_post","summary":"Send requests to the Algolia REST API","description":"POST /{path}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","path"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"path":{"type":"string","description":"Path of the endpoint, for example `1/newFeature`."},"parameters":{"type":"object","description":"Query parameters to apply to the current query."},"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-composition/custom-put":{"post":{"operationId":"search_tools_algolia_composition_custom_put","summary":"Send requests to the Algolia REST API","description":"PUT /{path}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","path"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"path":{"type":"string","description":"Path of the endpoint, for example `1/newFeature`."},"parameters":{"type":"object","description":"Query parameters to apply to the current query."},"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-composition/custom-delete":{"post":{"operationId":"search_tools_algolia_composition_custom_delete","summary":"Send requests to the Algolia REST API","description":"DELETE /{path}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","path"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"path":{"type":"string","description":"Path of the endpoint, for example `1/newFeature`."},"parameters":{"type":"object","description":"Query parameters to apply to the current query."}}}}}},"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-composition/search":{"post":{"operationId":"search_tools_algolia_composition_search","summary":"Run a Composition","description":"POST /1/compositions/{compositionID}/run","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"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-composition/search-for-facet-values":{"post":{"operationId":"search_tools_algolia_composition_search_for_facet_values","summary":"Search for facet values","description":"POST /1/compositions/{compositionID}/facets/{facetName}/query","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","facetName"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"facetName":{"type":"string","description":"Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the…"},"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-composition/list-compositions":{"get":{"operationId":"search_tools_algolia_composition_list_compositions","summary":"List compositions","description":"GET /1/compositions","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"page","in":"query","required":false,"description":"Requested page of the API response. If `null`, the API response is not paginated.","schema":{"type":"string","description":"Requested page of the API response. If `null`, the API response is not paginated."}},{"name":"hitsPerPage","in":"query","required":false,"description":"Number of hits per page.","schema":{"type":"integer","default":100,"description":"Number of hits 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/search-tools:algolia-composition/get-composition":{"get":{"operationId":"search_tools_algolia_composition_get_composition","summary":"Retrieve a composition","description":"GET /1/compositions/{compositionID}","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"compositionID","in":"query","required":true,"description":"Unique Composition ObjectID.","schema":{"type":"string","description":"Unique Composition ObjectID."}}],"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-composition/put-composition":{"post":{"operationId":"search_tools_algolia_composition_put_composition","summary":"Update and insert (upsert) a composition","description":"PUT /1/compositions/{compositionID}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"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-composition/delete-composition":{"post":{"operationId":"search_tools_algolia_composition_delete_composition","summary":"Delete a composition","description":"DELETE /1/compositions/{compositionID}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."}}}}}},"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-composition/multiple-batch":{"post":{"operationId":"search_tools_algolia_composition_multiple_batch","summary":"Batch action to multiple compositions","description":"POST /1/compositions/*/batch","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"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-composition/update-sorting-strategy-composition":{"post":{"operationId":"search_tools_algolia_composition_update_sorting_strategy_composition","summary":"Set or update the \"sortingStrategy\" configuration for an existing composition","description":"POST /1/compositions/{compositionID}/sortingStrategy","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"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-composition/get-rule":{"get":{"operationId":"search_tools_algolia_composition_get_rule","summary":"Retrieve a rule","description":"GET /1/compositions/{compositionID}/rules/{objectID}","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"compositionID","in":"query","required":true,"description":"Unique Composition ObjectID.","schema":{"type":"string","description":"Unique Composition ObjectID."}},{"name":"objectID","in":"query","required":true,"description":"Unique identifier of a rule object.","schema":{"type":"string","description":"Unique identifier of a rule 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:algolia-composition/put-composition-rule":{"post":{"operationId":"search_tools_algolia_composition_put_composition_rule","summary":"Add or update a composition rule","description":"PUT /1/compositions/{compositionID}/rules/{objectID}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","objectID","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"objectID":{"type":"string","description":"Unique identifier of a rule object."},"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-composition/delete-composition-rule":{"post":{"operationId":"search_tools_algolia_composition_delete_composition_rule","summary":"Delete a Composition Rule","description":"DELETE /1/compositions/{compositionID}/rules/{objectID}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","objectID"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"objectID":{"type":"string","description":"Unique identifier of a rule 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/search-tools:algolia-composition/save-rules":{"post":{"operationId":"search_tools_algolia_composition_save_rules","summary":"Create or update or delete composition rules","description":"POST /1/compositions/{compositionID}/rules/batch","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID","body"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"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-composition/search-composition-rules":{"post":{"operationId":"search_tools_algolia_composition_search_composition_rules","summary":"Search for composition rules","description":"POST /1/compositions/{compositionID}/rules/search","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["algolia_application_id","compositionID"],"properties":{"algolia_application_id":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"},"compositionID":{"type":"string","description":"Unique Composition ObjectID."},"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-composition/get-task":{"get":{"operationId":"search_tools_algolia_composition_get_task","summary":"Check task status","description":"GET /1/compositions/{compositionID}/task/{taskID}","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"compositionID","in":"query","required":true,"description":"Unique Composition ObjectID.","schema":{"type":"string","description":"Unique Composition ObjectID."}},{"name":"taskID","in":"query","required":true,"description":"Unique task identifier.","schema":{"type":"integer","description":"Unique task identifier."}}],"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-composition/set-client-api-key":{"get":{"operationId":"search_tools_algolia_composition_set_client_api_key","summary":"Switch the API key used to authenticate requests","description":"GET /setClientApiKey","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"apiKey","in":"query","required":true,"description":"API key to use for subsequent requests.","schema":{"type":"string","description":"API key to use for subsequent requests."}}],"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-composition/wait-for-composition-task":{"get":{"operationId":"search_tools_algolia_composition_wait_for_composition_task","summary":"Wait for operation to complete","description":"GET /waitForCompositionTask","tags":["search-tools"],"parameters":[{"name":"algolia_application_id","in":"query","required":true,"description":"Part of the server address: https://{algolia_application_id}.algolia.net","schema":{"type":"string","description":"Part of the server address: https://{algolia_application_id}.algolia.net"}},{"name":"compositionID","in":"query","required":true,"description":"The ID of the composition on which the operation was performed.","schema":{"type":"string","description":"The ID of the composition on which the operation was performed."}},{"name":"taskID","in":"query","required":true,"description":"The taskID returned by the operation.","schema":{"type":"integer","description":"The taskID returned by the 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"}}},"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"}}}}}}}