{"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/open-data:nexmo-application/retrieve-applications":{"get":{"operationId":"open_data_nexmo_application_retrieve_applications","summary":"Retrieve all Applications","description":"GET /","tags":["open-data"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"You can find your API key in your [account overview](https://dashboard.nexmo.com/account-overview)","schema":{"type":"string","description":"You can find your API key in your [account overview](https://dashboard.nexmo.com/account-overview)"}},{"name":"api_secret","in":"query","required":true,"description":"You can find your API secret in your [account overview](https://dashboard.nexmo.com/account-overview)","schema":{"type":"string","description":"You can find your API secret in your [account overview](https://dashboard.nexmo.com/account-overview)"}},{"name":"page_size","in":"query","required":false,"description":"Set the number of items returned on each call to this endpoint. The default is 10 records.","schema":{"type":"integer","default":10,"description":"Set the number of items returned on each call to this endpoint. The default is 10 records."},"example":10},{"name":"page_index","in":"query","required":false,"description":"Set the offset from the first page. The default value is `0`.","schema":{"type":"integer","default":0,"description":"Set the offset from the first page. The default value is `0`."},"example":0}],"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/open-data:nexmo-application/create-application":{"post":{"operationId":"open_data_nexmo_application_create_application","summary":"Create Application","description":"POST /","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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":"live"}},"/v1/open-data:nexmo-application/retrieve-application":{"get":{"operationId":"open_data_nexmo_application_retrieve_application","summary":"Retrieve Application","description":"GET /{app_id}","tags":["open-data"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"You can find your API key in your [account overview](https://dashboard.nexmo.com/account-overview)","schema":{"type":"string","description":"You can find your API key in your [account overview](https://dashboard.nexmo.com/account-overview)"}},{"name":"api_secret","in":"query","required":true,"description":"You can find your API secret in your [account overview](https://dashboard.nexmo.com/account-overview)","schema":{"type":"string","description":"You can find your API secret in your [account overview](https://dashboard.nexmo.com/account-overview)"}},{"name":"app_id","in":"query","required":true,"description":"The ID allocated to your application by Nexmo.","schema":{"type":"string","description":"The ID allocated to your application by Nexmo."},"example":"aaaaaaaa-bbbb-cccc-dddd-0123456789ab"}],"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/open-data:nexmo-application/update-application":{"post":{"operationId":"open_data_nexmo_application_update_application","summary":"Update Application","description":"PUT /{app_id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["app_id"],"properties":{"app_id":{"type":"string","description":"The ID allocated to your application by Nexmo."},"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/open-data:nexmo-application/delete-application":{"post":{"operationId":"open_data_nexmo_application_delete_application","summary":"Destroy Application","description":"DELETE /{app_id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["app_id"],"properties":{"app_id":{"type":"string","description":"The ID allocated to your application by Nexmo."}}}}}},"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"}}}}}}}