{"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/open-data:quotes-rest/get-qod":{"get":{"operationId":"open_data_quotes_rest_get_qod","summary":"Gets `Quote of the Day` (QOD). Optional `category` param determines the category of returned quote of the day","description":"GET /qod","tags":["open-data"],"parameters":[{"name":"category","in":"query","required":false,"description":"QOD Category (Used in public QOD only)","schema":{"type":"string","description":"QOD Category (Used in public QOD only)"}},{"name":"language","in":"query","required":false,"description":"Language of the QOD. The language must be supported in our QOD system.","schema":{"type":"string","default":"en","description":"Language of the QOD. The language must be supported in our QOD system."}},{"name":"id","in":"query","required":false,"description":"QOD defition id (Used in private QOD only)","schema":{"type":"string","description":"QOD defition id (Used in private QOD only)"}}],"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/open-data:quotes-rest/put-qod":{"post":{"operationId":"open_data_quotes_rest_put_qod","summary":"Create a private `Quote of the Day` service.","description":"PUT /qod","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"repeat_after":{"type":"integer","default":30,"description":"How many days after the quotes can repeat? If you are setting this up from your private collection make sure you have more quotes that…"},"authors":{"type":"string","description":"Comma seperated author names. Quotes will be chosen from one of these authors."},"title":{"type":"string","description":"Title of the Quote of the day category"},"private":{"type":"boolean","default":false,"description":"Should apply the filters to the private collection. Default is public quotes in the platform."},"language":{"type":"string","default":"en","description":"Quotes language."},"sfw":{"type":"boolean","default":false,"description":"Consider only quotes marked as \"sfw\" (Safe for work)."}}}}}},"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/open-data:quotes-rest/patch-qod":{"post":{"operationId":"open_data_quotes_rest_patch_qod","summary":"Update an existing private `Quote of the Day` definition.","description":"PATCH /qod","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"repeat_after":{"type":"integer","default":30,"description":"How many days after the quotes can repeat? If you are setting this up from your private collection make sure you have more quotes that…"},"authors":{"type":"string","description":"Comma seperated author names. Quotes will be chosen from one of these authors."},"title":{"type":"string","description":"Title of the Quote of the day category"},"private":{"type":"boolean","default":false,"description":"Should apply the filters to the private collection. Default is public quotes in the platform."},"language":{"type":"string","default":"en","description":"Quotes language."},"sfw":{"type":"boolean","default":false,"description":"Consider only quotes marked as \"sfw\" (Safe for work)."}}}}}},"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/open-data:quotes-rest/get-qod-categories":{"get":{"operationId":"open_data_quotes_rest_get_qod_categories","summary":"Gets a list of `Quote of the Day` Categories.","description":"GET /qod/categories","tags":["open-data"],"parameters":[{"name":"language","in":"query","required":false,"description":"Language of the QOD category. The language must be supported in our QOD system.","schema":{"type":"string","default":"en","description":"Language of the QOD category. The language must be supported in our QOD system."}},{"name":"detailed","in":"query","required":false,"description":"Return detailed information of the categories. Note the data format changes between the two values of this switch.","schema":{"type":"boolean","default":false,"description":"Return detailed information of the categories. Note the data format changes between the two values of this switch."}}],"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/open-data:quotes-rest/get-qod-languages":{"get":{"operationId":"open_data_quotes_rest_get_qod_languages","summary":"Gets a list of supported languages for `Quote of the Day`.","description":"GET /qod/languages","tags":["open-data"],"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/open-data:quotes-rest/get-qshow":{"get":{"operationId":"open_data_quotes_rest_get_qshow","summary":"Gets a details about a qshow.","description":"GET /qshow","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Qshow ID","schema":{"type":"string","description":"Qshow 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/open-data:quotes-rest/put-qshow":{"post":{"operationId":"open_data_quotes_rest_put_qshow","summary":"Create and add a new qshow to your private collection.","description":"PUT /qshow","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"Qshow title"},"description":{"type":"string","description":"Qshow description"},"tags":{"type":"array","description":"Tags for the qshow"}}}}}},"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/open-data:quotes-rest/patch-qshow":{"post":{"operationId":"open_data_quotes_rest_patch_qshow","summary":"Update an existing qshow.","description":"PATCH /qshow","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Qshow ID"},"title":{"type":"string","description":"Qshow title"},"description":{"type":"string","description":"Qshow description"},"tags":{"type":"array","description":"Tags for the qshow"}}}}}},"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/open-data:quotes-rest/delete-qshow":{"post":{"operationId":"open_data_quotes_rest_delete_qshow","summary":"Delete a qshow.","description":"DELETE /qshow","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Qshow 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/open-data:quotes-rest/get-qshow-list":{"get":{"operationId":"open_data_quotes_rest_get_qshow_list","summary":"Get the list of Qshows in They Said So platform.","description":"GET /qshow/list","tags":["open-data"],"parameters":[{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"public","in":"query","required":false,"description":"Should include public qshows or not in the list","schema":{"type":"boolean","default":false,"description":"Should include public qshows or not in the list"}}],"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/open-data:quotes-rest/get-qshow-quotes":{"get":{"operationId":"open_data_quotes_rest_get_qshow_quotes","summary":"Get the quotes in a given Qshow.","description":"GET /qshow/quotes","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Qshow ID","schema":{"type":"string","description":"Qshow 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/open-data:quotes-rest/post-qshow-quotes-add":{"post":{"operationId":"open_data_quotes_rest_post_qshow_quotes_add","summary":"Add a quote to a given Qshow.","description":"POST /qshow/quotes/add","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","quoteid"],"properties":{"id":{"type":"string","description":"Qshow ID"},"quoteid":{"type":"string","description":"Quote ID to add the qshow collection"}}}}}},"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/open-data:quotes-rest/post-qshow-quotes-remove":{"post":{"operationId":"open_data_quotes_rest_post_qshow_quotes_remove","summary":"Remove a quote to a given Qshow.","description":"POST /qshow/quotes/remove","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","quoteid"],"properties":{"id":{"type":"string","description":"Qshow ID"},"quoteid":{"type":"string","description":"Quote ID to remove from the qshow collection"}}}}}},"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/open-data:quotes-rest/get-quote":{"get":{"operationId":"open_data_quotes_rest_get_quote","summary":"Gets a `Quote` with a given `id`.","description":"GET /quote","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"Quote ID","schema":{"type":"string","description":"Quote 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/open-data:quotes-rest/post-quote":{"post":{"operationId":"open_data_quotes_rest_post_quote","summary":"Add a new quote to your private collection. Same as 'PUT' but added since some clients don't handle PUT well.","description":"POST /quote","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quote"],"properties":{"quote":{"type":"string","description":"Quote"},"author":{"type":"string","description":"Quote Author"},"tags":{"type":"string","description":"Comma Separated tags"},"language":{"type":"string","default":"en","description":"Language. If not supplied an auto detection mechanism will be used to detect a language."}}}}}},"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/open-data:quotes-rest/put-quote":{"post":{"operationId":"open_data_quotes_rest_put_quote","summary":"Add a new quote to your private collection.","description":"PUT /quote","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quote"],"properties":{"quote":{"type":"string","description":"Quote"},"author":{"type":"string","description":"Quote Author"},"tags":{"type":"string","description":"Comma Separated tags"},"language":{"type":"string","default":"en","description":"Language. If not supplied an auto detection mechanism will be used to detect a language."}}}}}},"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/open-data:quotes-rest/patch-quote":{"post":{"operationId":"open_data_quotes_rest_patch_quote","summary":"Update a quote","description":"PATCH /quote","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Quote ID"},"quote":{"type":"string","description":"Quote"},"author":{"type":"string","description":"Quote Author"},"language":{"type":"string","default":"en","description":"Language. If not supplied an auto detection mechanism will be used to detect a language."},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/delete-quote":{"post":{"operationId":"open_data_quotes_rest_delete_quote","summary":"Delete a quote. The user needs to be the owner of the quote to be able to delete it.","description":"DELETE /quote","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Quote 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/open-data:quotes-rest/get-quote-authors-popular":{"get":{"operationId":"open_data_quotes_rest_get_quote_authors_popular","summary":"Gets a list of popular author names in the system.","description":"GET /quote/authors/popular","tags":["open-data"],"parameters":[{"name":"language","in":"query","required":false,"description":"Language. A same author may have quotes in two or more different languages. So for example 'Mahatma Gandhi' may be returned for language…","schema":{"type":"string","default":"en","description":"Language. A same author may have quotes in two or more different languages. So for example 'Mahatma Gandhi' may be returned for language…"}},{"name":"detailed","in":"query","required":false,"description":"Should return detailed author information such as `birthday`, `death date`, `occupation`, `description` etc. Only available at certain…","schema":{"type":"boolean","default":false,"description":"Should return detailed author information such as `birthday`, `death date`, `occupation`, `description` etc. Only available at certain…"}},{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"limit","in":"query","required":false,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level.","schema":{"type":"integer","default":5,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level."}}],"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/open-data:quotes-rest/get-quote-authors-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_authors_search","summary":"Gets a list of author names in the system.","description":"GET /quote/authors/search","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"Text string to search for in author names","schema":{"type":"string","description":"Text string to search for in author names"}},{"name":"language","in":"query","required":false,"description":"Language. A same author may have quotes in two or more different languages. So for example 'Mahatma Gandhi' may be returned for language…","schema":{"type":"string","default":"en","description":"Language. A same author may have quotes in two or more different languages. So for example 'Mahatma Gandhi' may be returned for language…"}},{"name":"detailed","in":"query","required":false,"description":"Should return detailed author information such as `birthday`, `death date`, `occupation`, `description` etc. Only available at certain…","schema":{"type":"boolean","default":false,"description":"Should return detailed author information such as `birthday`, `death date`, `occupation`, `description` etc. Only available at certain…"}},{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"limit","in":"query","required":false,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level.","schema":{"type":"integer","default":1,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level."}}],"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/open-data:quotes-rest/get-quote-bookmark-toggle":{"get":{"operationId":"open_data_quotes_rest_get_quote_bookmark_toggle","summary":"Toggle the user bookmark of the given Quote as a user of the API Key.","description":"GET /quote/bookmark/toggle","tags":["open-data"],"parameters":[{"name":"quote_id","in":"query","required":true,"description":"Quote ID","schema":{"type":"string","description":"Quote 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/open-data:quotes-rest/get-quote-categories-popular":{"get":{"operationId":"open_data_quotes_rest_get_quote_categories_popular","summary":"Gets a list of popular `Quote` Categories.","description":"GET /quote/categories/popular","tags":["open-data"],"parameters":[{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"limit","in":"query","required":false,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level.","schema":{"type":"integer","default":5,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level."}}],"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/open-data:quotes-rest/get-quote-categories-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_categories_search","summary":"Gets a list of `Quote` Categories matching the query string.","description":"GET /quote/categories/search","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"Text string to search for in the categories","schema":{"type":"string","default":0,"description":"Text string to search for in the categories"}},{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"limit","in":"query","required":false,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level.","schema":{"type":"integer","default":2,"description":"Response is paged. This parameter controls how many is returned in the result. The maximum depends on the subscription level."}}],"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/open-data:quotes-rest/get-quote-image":{"get":{"operationId":"open_data_quotes_rest_get_quote_image","summary":"Gets a Quote image for a given id. Response can be an image file as a binary or a base64 encoded contents…","description":"GET /quote/image","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Quote Image id","schema":{"type":"string","description":"Quote Image id"}},{"name":"binary","in":"query","required":false,"description":"Should the response be a direct file download of the image or a base64 encoded image file wrapped in json?","schema":{"type":"boolean","default":true,"description":"Should the response be a direct file download of the image or a base64 encoded image file wrapped in json?"}}],"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/open-data:quotes-rest/put-quote-image":{"post":{"operationId":"open_data_quotes_rest_put_quote_image","summary":"Create a new quote image for a given quote. Choose background colors/images , choose different font styles…","description":"PUT /quote/image","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quote_id"],"properties":{"quote_id":{"type":"string","description":"Quote id"},"bgimage_id":{"type":"string","default":"theysaidso_default_background_image","description":"Background Image id ( Will override bgcolor if supplied)"},"bg_color":{"type":"string","description":"Background Color(if background image id is not supplied)"},"font_id":{"type":"string","default":"theysaidso_default_font","description":"Font id"},"text_color":{"type":"string","description":"Text Color"},"text_size":{"type":"string","description":"Text/font size"},"halign":{"type":"string","default":"center","description":"Horizontal text Alignment Value"},"valign":{"type":"string","default":"center","description":"Vertical text Alignment Value"},"width":{"type":"integer","description":"Image Width(By default this takes the width of the background image)"},"height":{"type":"integer","description":"Image Height(By default this takes the height of the background image)"},"branding":{"type":"boolean","default":false,"description":"Disable They Said So branding (Only available in certain subscription levels. Ignored in other levels)"},"include_transparent_layer":{"type":"boolean","default":true,"description":"Should include a transparent layer between the text and the background image? This helps when the background image is bright and obscures…"}}}}}},"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/open-data:quotes-rest/delete-quote-image":{"post":{"operationId":"open_data_quotes_rest_delete_quote_image","summary":"Delete a quote image. The user needs to be the owner of the quote image to be able to delete it.","description":"DELETE /quote/image","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Quote Image 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/open-data:quotes-rest/post-quote-image-background":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_background","summary":"Add an image for use later as a quote background image.","description":"POST /quote/image/background","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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/open-data:quotes-rest/delete-quote-image-background":{"post":{"operationId":"open_data_quotes_rest_delete_quote_image_background","summary":"Delete a background image file. The user needs to be the owner of the background image to be able to delete…","description":"DELETE /quote/image/background","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Font 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/open-data:quotes-rest/get-quote-image-background-list":{"get":{"operationId":"open_data_quotes_rest_get_quote_image_background_list","summary":"Lists background images in your private collection.","description":"GET /quote/image/background/list","tags":["open-data"],"parameters":[{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter determines where the response should start.","schema":{"type":"integer","description":"Response is paged. This parameter determines where the response should start."}}],"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/open-data:quotes-rest/get-quote-image-background-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_image_background_search","summary":"Searches for a background image with a given tag.","description":"GET /quote/image/background/search","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"Tag string","schema":{"type":"string","description":"Tag string"}}],"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/open-data:quotes-rest/post-quote-image-background-tags-add":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_background_tags_add","summary":"Add a tag to a given Image.","description":"POST /quote/image/background/tags/add","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Image ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/post-quote-image-background-tags-remove":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_background_tags_remove","summary":"Remove a tag from a given Image.","description":"POST /quote/image/background/tags/remove","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Image ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/post-quote-image-font":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_font","summary":"Add a font file for use later in creating a quote image. This is essentially a `PUT` but not many clients…","description":"POST /quote/image/font","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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/open-data:quotes-rest/delete-quote-image-font":{"post":{"operationId":"open_data_quotes_rest_delete_quote_image_font","summary":"Delete a font file. The user needs to be the owner of the font to be able to delete it.","description":"DELETE /quote/image/font","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Font 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/open-data:quotes-rest/get-quote-image-font-list":{"get":{"operationId":"open_data_quotes_rest_get_quote_image_font_list","summary":"Lists background images in your private collection.","description":"GET /quote/image/font/list","tags":["open-data"],"parameters":[{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter determines where the response should start.","schema":{"type":"integer","description":"Response is paged. This parameter determines where the response should start."}}],"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/open-data:quotes-rest/get-quote-image-font-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_image_font_search","summary":"Searches for a font with a given tag.","description":"GET /quote/image/font/search","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"Tag string","schema":{"type":"string","description":"Tag string"}}],"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/open-data:quotes-rest/post-quote-image-font-tags-add":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_font_tags_add","summary":"Add a tag to a given font.","description":"POST /quote/image/font/tags/add","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Font ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/post-quote-image-font-tags-remove":{"post":{"operationId":"open_data_quotes_rest_post_quote_image_font_tags_remove","summary":"Remove a tag from a given Font.","description":"POST /quote/image/font/tags/remove","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Font ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/get-quote-image-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_image_search","summary":"Gets a Random Quote image. Optional `category` param determines the category of quote used in the image.…","description":"GET /quote/image/search","tags":["open-data"],"parameters":[{"name":"category","in":"query","required":false,"description":"Quote Category","schema":{"type":"string","description":"Quote Category"}},{"name":"author","in":"query","required":false,"description":"Quote Author","schema":{"type":"string","description":"Quote Author"}},{"name":"private","in":"query","required":false,"description":"Should search private collection. Default searches public image collection.","schema":{"type":"boolean","default":false,"description":"Should search private collection. Default searches public image collection."}}],"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/open-data:quotes-rest/get-quote-like-toggle":{"get":{"operationId":"open_data_quotes_rest_get_quote_like_toggle","summary":"Toggle the user like of the given Quote as a user of the API Key.","description":"GET /quote/like/toggle","tags":["open-data"],"parameters":[{"name":"quote_id","in":"query","required":true,"description":"Quote ID","schema":{"type":"string","description":"Quote 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/open-data:quotes-rest/get-quote-list":{"get":{"operationId":"open_data_quotes_rest_get_quote_list","summary":"Get the list of quotes in your private collection.","description":"GET /quote/list","tags":["open-data"],"parameters":[{"name":"start","in":"query","required":false,"description":"Response is paged. This parameter controls where response starts the listing at","schema":{"type":"integer","default":0,"description":"Response is paged. This parameter controls where response starts the listing at"}},{"name":"limit","in":"query","required":false,"description":"Response is paged. This parameter controls how many is returned in the result.","schema":{"type":"integer","default":10,"description":"Response is paged. This parameter controls how many is returned in the result."}}],"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/open-data:quotes-rest/get-quote-random":{"get":{"operationId":"open_data_quotes_rest_get_quote_random","summary":"Gets a `Random Quote`. When you are in a hurry this is what you call to get a random famous quote.","description":"GET /quote/random","tags":["open-data"],"parameters":[{"name":"language","in":"query","required":false,"description":"Language of the Quote. The language must be supported in our system.","schema":{"type":"string","default":"en","description":"Language of the Quote. The language must be supported in our system."}},{"name":"limit","in":"query","required":false,"description":"No of quotes to return. The max limit depends on the subscription level.","schema":{"type":"integer","default":1,"description":"No of quotes to return. The max limit depends on the subscription level."}}],"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/open-data:quotes-rest/get-quote-search":{"get":{"operationId":"open_data_quotes_rest_get_quote_search","summary":"Search for a `Quote` in They Said So platform. Optional `category` , `author`, `minlength`, `maxlength`…","description":"GET /quote/search","tags":["open-data"],"parameters":[{"name":"category","in":"query","required":false,"description":"Quote Category","schema":{"type":"string","description":"Quote Category"}},{"name":"author","in":"query","required":false,"description":"Quote Author","schema":{"type":"string","description":"Quote Author"}},{"name":"minlength","in":"query","required":false,"description":"Quote minimum Length","schema":{"type":"integer","default":100,"description":"Quote minimum Length"}},{"name":"maxlength","in":"query","required":false,"description":"Quote maximum Length","schema":{"type":"integer","default":300,"description":"Quote maximum Length"}},{"name":"query","in":"query","required":false,"description":"keyword to search for in the quote","schema":{"type":"string","description":"keyword to search for in the quote"}},{"name":"private","in":"query","required":false,"description":"Should search private collection? Default searches public collection.","schema":{"type":"boolean","default":false,"description":"Should search private collection? Default searches public collection."}},{"name":"language","in":"query","required":false,"description":"Language of the Quote. The language must be supported in our system.","schema":{"type":"string","default":"en","description":"Language of the Quote. The language must be supported in our system."}},{"name":"limit","in":"query","required":false,"description":"No of quotes to return. The max limit depends on the subscription level.","schema":{"type":"integer","default":1,"description":"No of quotes to return. The max limit depends on the subscription level."}},{"name":"sfw","in":"query","required":false,"description":"Should search only SFW (Safe For Work) quotes?","schema":{"type":"boolean","default":false,"description":"Should search only SFW (Safe For Work) quotes?"}}],"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/open-data:quotes-rest/post-quote-tags-add":{"post":{"operationId":"open_data_quotes_rest_post_quote_tags_add","summary":"Add a tag to a given Quote.","description":"POST /quote/tags/add","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Quote ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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/open-data:quotes-rest/post-quote-tags-remove":{"post":{"operationId":"open_data_quotes_rest_post_quote_tags_remove","summary":"Remove a tag from a given quote.","description":"POST /quote/tags/remove","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","tags"],"properties":{"id":{"type":"string","description":"Quote ID"},"tags":{"type":"string","description":"Comma Separated tags"}}}}}},"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"}}}}}}}