{"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/open-data:nexmo-account/get-account-balance":{"get":{"operationId":"open_data_nexmo_account_get_account_balance","summary":"Get Account Balance","description":"GET /account/get-balance","tags":["open-data"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)","schema":{"type":"string","description":"Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)"}},{"name":"api_secret","in":"query","required":true,"description":"Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)","schema":{"type":"string","description":"Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)"}}],"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:nexmo-account/register-sender":{"post":{"operationId":"open_data_nexmo_account_register_sender","summary":"Register an email sender","description":"POST /account/register-sender","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","api_secret","body"],"properties":{"api_key":{"type":"string","description":"Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"api_secret":{"type":"string","description":"Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"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/open-data:nexmo-account/change-account-settings":{"post":{"operationId":"open_data_nexmo_account_change_account_settings","summary":"Change Account Settings","description":"POST /account/settings","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","api_secret"],"properties":{"api_key":{"type":"string","description":"Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"api_secret":{"type":"string","description":"Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"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:nexmo-account/top-up-account-balance":{"post":{"operationId":"open_data_nexmo_account_top_up_account_balance","summary":"Top Up Account Balance","description":"POST /account/top-up","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","api_secret","body"],"properties":{"api_key":{"type":"string","description":"Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"api_secret":{"type":"string","description":"Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)"},"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:nexmo-account/retrieve-apisecrets":{"get":{"operationId":"open_data_nexmo_account_retrieve_apisecrets","summary":"Retrieve API Secrets","description":"GET /accounts/{api_key}/secrets","tags":["open-data"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"The API key to manage secrets for","schema":{"type":"string","description":"The API key to manage secrets for"},"example":"abcd1234"}],"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:nexmo-account/create-apisecret":{"post":{"operationId":"open_data_nexmo_account_create_apisecret","summary":"Create API Secret","description":"POST /accounts/{api_key}/secrets","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","body"],"properties":{"api_key":{"type":"string","description":"The API key to manage secrets for"},"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/open-data:nexmo-account/retrieve-apisecret":{"get":{"operationId":"open_data_nexmo_account_retrieve_apisecret","summary":"Retrieve one API Secret","description":"GET /accounts/{api_key}/secrets/{secret_id}","tags":["open-data"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"The API key to manage secrets for","schema":{"type":"string","description":"The API key to manage secrets for"},"example":"abcd1234"},{"name":"secret_id","in":"query","required":true,"description":"ID of the API Secret","schema":{"type":"string","description":"ID of the API Secret"},"example":"01234567-aaaa-bbbb-cccc-defdefdefdef"}],"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:nexmo-account/revoke-apisecret":{"post":{"operationId":"open_data_nexmo_account_revoke_apisecret","summary":"Revoke an API Secret","description":"DELETE /accounts/{api_key}/secrets/{secret_id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","secret_id"],"properties":{"api_key":{"type":"string","description":"The API key to manage secrets for"},"secret_id":{"type":"string","description":"ID of the API Secret"}}}}}},"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"}}}}}}}