{"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/ai:digitallinguistics/get-languages":{"get":{"operationId":"ai_digitallinguistics_get_languages","summary":"Get all Languages","description":"GET /languages","tags":["ai"],"parameters":[{"name":"continuation","in":"query","required":false,"description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results.","schema":{"type":"string","description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results."}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifModifiedSince","in":"query","required":false,"description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…","schema":{"type":"string","description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…"}},{"name":"maxItemCount","in":"query","required":false,"description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…","schema":{"type":"string","description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…"}},{"name":"public","in":"query","required":false,"description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…","schema":{"type":"string","default":"false","description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…"}}],"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:digitallinguistics/add-language":{"post":{"operationId":"ai_digitallinguistics_add_language","summary":"Add a new Language","description":"POST /languages","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:digitallinguistics/upsert-language":{"post":{"operationId":"ai_digitallinguistics_upsert_language","summary":"Upsert (create or replace) a Language","description":"PUT /languages","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"},"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:digitallinguistics/get-language":{"get":{"operationId":"ai_digitallinguistics_get_language","summary":"Retrieve a Language by ID","description":"GET /languages/{languageID}","tags":["ai"],"parameters":[{"name":"languageID","in":"query","required":true,"description":"The ID of the Language to perform the operation on","schema":{"type":"string","description":"The ID of the Language to perform the operation on"}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifNoneMatch","in":"query","required":false,"description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…","schema":{"type":"string","description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…"}}],"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:digitallinguistics/update-language":{"post":{"operationId":"ai_digitallinguistics_update_language","summary":"Perform a partial update on a Language","description":"PATCH /languages/{languageID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID","body"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"},"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:digitallinguistics/delete-language":{"post":{"operationId":"ai_digitallinguistics_delete_language","summary":"Delete a Language by ID","description":"DELETE /languages/{languageID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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:digitallinguistics/get-lexemes-by-language":{"get":{"operationId":"ai_digitallinguistics_get_lexemes_by_language","summary":"Get all Lexemes for a Language","description":"GET /languages/{languageID}/lexemes","tags":["ai"],"parameters":[{"name":"languageID","in":"query","required":true,"description":"The ID of the Language to perform the operation on","schema":{"type":"string","description":"The ID of the Language to perform the operation on"}},{"name":"continuation","in":"query","required":false,"description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results.","schema":{"type":"string","description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results."}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifModifiedSince","in":"query","required":false,"description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…","schema":{"type":"string","description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…"}},{"name":"maxItemCount","in":"query","required":false,"description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…","schema":{"type":"string","description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…"}},{"name":"public","in":"query","required":false,"description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…","schema":{"type":"string","default":"false","description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…"}}],"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:digitallinguistics/add-lexeme-by-language":{"post":{"operationId":"ai_digitallinguistics_add_lexeme_by_language","summary":"Add a new Lexeme to a Language","description":"POST /languages/{languageID}/lexemes","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"}}}}}},"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:digitallinguistics/upsert-lexeme-by-language":{"post":{"operationId":"ai_digitallinguistics_upsert_lexeme_by_language","summary":"Upsert (add or replace) a Lexeme","description":"PUT /languages/{languageID}/lexemes","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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:digitallinguistics/get-lexeme-by-language":{"get":{"operationId":"ai_digitallinguistics_get_lexeme_by_language","summary":"Get a Lexeme by ID","description":"GET /languages/{languageID}/lexemes/{lexemeID}","tags":["ai"],"parameters":[{"name":"languageID","in":"query","required":true,"description":"The ID of the Language to perform the operation on","schema":{"type":"string","description":"The ID of the Language to perform the operation on"}},{"name":"lexemeID","in":"query","required":true,"description":"The ID of the Lexeme to perform the operation on","schema":{"type":"string","description":"The ID of the Lexeme to perform the operation on"}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifNoneMatch","in":"query","required":false,"description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…","schema":{"type":"string","description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…"}}],"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:digitallinguistics/update-lexeme-by-language":{"post":{"operationId":"ai_digitallinguistics_update_lexeme_by_language","summary":"Perform a partial update on a Lexeme","description":"PATCH /languages/{languageID}/lexemes/{lexemeID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID","lexemeID"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"},"lexemeID":{"type":"string","description":"The ID of the Lexeme to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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:digitallinguistics/delete-lexeme-by-language":{"post":{"operationId":"ai_digitallinguistics_delete_lexeme_by_language","summary":"Delete a Lexeme by ID","description":"DELETE /languages/{languageID}/lexemes/{lexemeID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageID","lexemeID"],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"},"lexemeID":{"type":"string","description":"The ID of the Lexeme to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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:digitallinguistics/get-lexemes":{"get":{"operationId":"ai_digitallinguistics_get_lexemes","summary":"Get all Lexemes","description":"GET /lexemes","tags":["ai"],"parameters":[{"name":"continuation","in":"query","required":false,"description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results.","schema":{"type":"string","description":"The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results."}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifModifiedSince","in":"query","required":false,"description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…","schema":{"type":"string","description":"The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date…"}},{"name":"languageID","in":"query","required":false,"description":"The ID of the Language to perform the operation on","schema":{"type":"string","description":"The ID of the Language to perform the operation on"}},{"name":"maxItemCount","in":"query","required":false,"description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…","schema":{"type":"string","description":"The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be…"}},{"name":"public","in":"query","required":false,"description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…","schema":{"type":"string","default":"false","description":"Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner,…"}}],"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:digitallinguistics/add-lexeme":{"post":{"operationId":"ai_digitallinguistics_add_lexeme","summary":"Add a new Lexeme","description":"POST /lexemes","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"}}}}}},"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:digitallinguistics/upsert-lexeme":{"post":{"operationId":"ai_digitallinguistics_upsert_lexeme","summary":"Upsert (add or replace) a Lexeme","description":"PUT /lexemes","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"},"languageID":{"type":"string","description":"The ID of the Language to perform the operation on"}}}}}},"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:digitallinguistics/get-lexeme":{"get":{"operationId":"ai_digitallinguistics_get_lexeme","summary":"Get a Lexeme by ID","description":"GET /lexemes/{lexemeID}","tags":["ai"],"parameters":[{"name":"lexemeID","in":"query","required":true,"description":"The ID of the Lexeme to perform the operation on","schema":{"type":"string","description":"The ID of the Lexeme to perform the operation on"}},{"name":"deleted","in":"query","required":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…","schema":{"type":"boolean","default":false,"description":"Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database.…"}},{"name":"ifNoneMatch","in":"query","required":false,"description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…","schema":{"type":"string","description":"If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and…"}}],"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:digitallinguistics/update-lexeme":{"post":{"operationId":"ai_digitallinguistics_update_lexeme","summary":"Perform a partial update on a Lexeme","description":"PATCH /lexemes/{lexemeID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lexemeID"],"properties":{"lexemeID":{"type":"string","description":"The ID of the Lexeme to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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:digitallinguistics/delete-lexeme":{"post":{"operationId":"ai_digitallinguistics_delete_lexeme","summary":"Delete a Lexeme by ID","description":"DELETE /lexemes/{lexemeID}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lexemeID"],"properties":{"lexemeID":{"type":"string","description":"The ID of the Lexeme to perform the operation on"},"ifMatch":{"type":"string","description":"The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before…"}}}}}},"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"}}}}}}}