{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ai:taggun/post-api-account-v1-feedback":{"post":{"operationId":"ai_taggun_post_api_account_v1_feedback","summary":"Add manually verified receipt data to a given receipt for feedback and training purposes","description":"POST /api/account/v1/feedback","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-account-v1-merchantname-add":{"post":{"operationId":"ai_taggun_post_api_account_v1_merchantname_add","summary":"Add a keyword to your account's model to predict merchant name. Changes in your account's model are updated…","description":"POST /api/account/v1/merchantname/add","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-simple-encoded":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_simple_encoded","summary":"transcribe a receipt using base64 encoded image in json payload","description":"POST /api/receipt/v1/simple/encoded","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-simple-file":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_simple_file","summary":"transcribe a receipt by uploading an image file","description":"POST /api/receipt/v1/simple/file","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-simple-url":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_simple_url","summary":"transcribe a receipt from URL","description":"POST /api/receipt/v1/simple/url","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-verbose-encoded":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_verbose_encoded","summary":"transcribe a receipt using base64 encoded image in json payload and return detailed result","description":"POST /api/receipt/v1/verbose/encoded","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-verbose-file":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_verbose_file","summary":"transcribe a receipt by uploading an image file and return detailed result","description":"POST /api/receipt/v1/verbose/file","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-receipt-v1-verbose-url":{"post":{"operationId":"ai_taggun_post_api_receipt_v1_verbose_url","summary":"transcribe a receipt from URL and return detailed result","description":"POST /api/receipt/v1/verbose/url","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-validation-v1-campaign-file":{"post":{"operationId":"ai_taggun_post_api_validation_v1_campaign_file","summary":"validate and match a receipt against a campaign validation settings by uploading an image file","description":"POST /api/validation/v1/campaign/file","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-validation-v1-campaign-productvalidation-file":{"post":{"operationId":"ai_taggun_post_api_validation_v1_campaign_productvalidation_file","summary":"validate if user-submitted info like serial number are detected an image file","description":"POST /api/validation/v1/campaign/product-validation/file","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"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":"live"}},"/v1/ai:taggun/post-api-validation-v1-campaign-settings-create-campaignid":{"post":{"operationId":"ai_taggun_post_api_validation_v1_campaign_settings_create_campaignid","summary":"create campaign settings for a client","description":"POST /api/validation/v1/campaign/settings/create/{campaignId}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey","campaignId"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"campaignId":{"type":"string","description":"The ID of the campaign to validate the receipt"},"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":"live"}},"/v1/ai:taggun/delete-api-validation-v1-campaign-settings-delete-campaignid":{"post":{"operationId":"ai_taggun_delete_api_validation_v1_campaign_settings_delete_campaignid","summary":"delete campaign settings for a client","description":"DELETE /api/validation/v1/campaign/settings/delete/{campaignId}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey","campaignId"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"campaignId":{"type":"string","description":"Remove campaign settings with a campaign 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":"live"}},"/v1/ai:taggun/get-api-validation-v1-campaign-settings-list":{"get":{"operationId":"ai_taggun_get_api_validation_v1_campaign_settings_list","summary":"list all campaign setting IDs for a client","description":"GET /api/validation/v1/campaign/settings/list","tags":["ai"],"parameters":[{"name":"apikey","in":"query","required":true,"description":"API authentication key.","schema":{"type":"string","description":"API authentication key."}}],"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":"live"}},"/v1/ai:taggun/put-api-validation-v1-campaign-settings-update-campaignid":{"post":{"operationId":"ai_taggun_put_api_validation_v1_campaign_settings_update_campaignid","summary":"update campaign settings for a client","description":"PUT /api/validation/v1/campaign/settings/update/{campaignId}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apikey","campaignId"],"properties":{"apikey":{"type":"string","description":"API authentication key."},"campaignId":{"type":"string","description":"The ID of the campaign to validate the receipt"},"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":"live"}},"/v1/ai:taggun/get-api-validation-v1-campaign-settings-campaignid":{"get":{"operationId":"ai_taggun_get_api_validation_v1_campaign_settings_campaignid","summary":"get campaign settings for a client","description":"GET /api/validation/v1/campaign/settings/{campaignId}","tags":["ai"],"parameters":[{"name":"apikey","in":"query","required":true,"description":"API authentication key.","schema":{"type":"string","description":"API authentication key."}},{"name":"campaignId","in":"query","required":true,"description":"The ID of the campaign to validate the receipt","schema":{"type":"string","description":"The ID of the campaign to validate the receipt"}}],"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":"live"}}},"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"}}}}}}}