{"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/cloud:openalpr/get-config":{"get":{"operationId":"cloud_openalpr_get_config","summary":"Get a list of available results for plate and vehicle recognition","description":"GET /config","tags":["cloud"],"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":"live"}},"/v1/cloud:openalpr/recognize-file":{"post":{"operationId":"cloud_openalpr_recognize_file","summary":"Send an image for OpenALPR to analyze and provide metadata back The image is sent as a file using a form…","description":"POST /recognize","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["secret_key","country","body"],"properties":{"secret_key":{"type":"string","description":"The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/"},"recognize_vehicle":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request"},"country":{"type":"string","description":"Defines the training data used by OpenALPR. \"us\" analyzes North-American style plates. \"eu\" analyzes European-style plates. This field is…"},"return_image":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response"},"topn":{"type":"integer","default":10,"description":"The number of results you would like to be returned for plate candidates and vehicle classifications"},"is_cropped":{"type":"integer","enum":[0,1],"default":0,"description":"When providing a plate or vehicle that is already cropped, this performs a recognition against the full crop and does not attempt to…"},"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/cloud:openalpr/recognize-bytes":{"post":{"operationId":"cloud_openalpr_recognize_bytes","summary":"Send an image for OpenALPR to analyze and provide metadata back The image is sent as base64 encoded bytes.","description":"POST /recognize_bytes","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["secret_key","country","body"],"properties":{"secret_key":{"type":"string","description":"The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/"},"recognize_vehicle":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request"},"country":{"type":"string","description":"Defines the training data used by OpenALPR. \"us\" analyzes North-American style plates. \"eu\" analyzes European-style plates. This field is…"},"return_image":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response"},"topn":{"type":"integer","default":10,"description":"The number of results you would like to be returned for plate candidates and vehicle classifications"},"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/cloud:openalpr/recognize-url":{"post":{"operationId":"cloud_openalpr_recognize_url","summary":"Send an image for OpenALPR to analyze and provide metadata back The image is sent as a URL. The OpenALPR…","description":"POST /recognize_url","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["image_url","secret_key","country"],"properties":{"image_url":{"type":"string","description":"A URL to an image that you wish to analyze"},"secret_key":{"type":"string","description":"The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/"},"recognize_vehicle":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request"},"country":{"type":"string","description":"Defines the training data used by OpenALPR. \"us\" analyzes North-American style plates. \"eu\" analyzes European-style plates. This field is…"},"return_image":{"type":"integer","enum":[0,1],"default":0,"description":"If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response"},"topn":{"type":"integer","default":10,"description":"The number of results you would like to be returned for plate candidates and vehicle classifications"}}}}}},"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"}}},"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"}}}}}}}