{"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:browsercat/server-check-health-status":{"get":{"operationId":"open_data_browsercat_server_check_health_status","summary":"Show server health","description":"GET /health","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:browsercat/server-show-metrics":{"get":{"operationId":"open_data_browsercat_server_show_metrics","summary":"Show server metrics","description":"GET /metrics","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:browsercat/open-api-explore-functionality":{"get":{"operationId":"open_data_browsercat_open_api_explore_functionality","summary":"Open OpenAPI docs","description":"GET /openapi","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:browsercat/open-api-get-spec-json":{"get":{"operationId":"open_data_browsercat_open_api_get_spec_json","summary":"Retrieve API spec as JSON","description":"GET /openapi.json","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:browsercat/open-api-get-yaml-spec":{"get":{"operationId":"open_data_browsercat_open_api_get_yaml_spec","summary":"Retrieve API spec as YAML","description":"GET /openapi.yaml","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:browsercat/browsers-establish-connection":{"get":{"operationId":"open_data_browsercat_browsers_establish_connection","summary":"Connect to a browser","description":"GET /connect","tags":["open-data"],"parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string","enum":["ams","iad","atl","bog","bos","otp","maa","ord","dfw","den","eze","fra","gdl","hkg","jnb","lhr","lax","mad","mia","yul","bom","cdg","phx","qro","gig","sjc","scl","gru","sea","ewr","sin","arn","syd","nrt","yyz","waw"]}}],"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:browsercat/api-keys-list-all":{"get":{"operationId":"open_data_browsercat_api_keys_list_all","summary":"List API keys","description":"GET /auth/keys","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:browsercat/api-keys-create-api-key":{"post":{"operationId":"open_data_browsercat_api_keys_create_api_key","summary":"Create an API key","description":"POST /auth/keys","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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":"byok"}},"/v1/open-data:browsercat/api-keys-get-key":{"get":{"operationId":"open_data_browsercat_api_keys_get_key","summary":"Retrieve an API key","description":"GET /auth/keys/{keyId}","tags":["open-data"],"parameters":[{"name":"keyId","in":"query","required":true,"description":"Key ID","schema":{"type":"string","description":"Key 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:browsercat/api-keys-update-api-key":{"post":{"operationId":"open_data_browsercat_api_keys_update_api_key","summary":"Update an API key","description":"PUT /auth/keys/{keyId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyId","body"],"properties":{"keyId":{"type":"string","description":"Key ID"},"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:browsercat/api-keys-update-key":{"post":{"operationId":"open_data_browsercat_api_keys_update_key","summary":"Patch an API key","description":"PATCH /auth/keys/{keyId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyId","body"],"properties":{"keyId":{"type":"string","description":"Key ID"},"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:browsercat/api-keys-revoke-key":{"post":{"operationId":"open_data_browsercat_api_keys_revoke_key","summary":"Revoke an API key","description":"DELETE /auth/keys/{keyId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyId"],"properties":{"keyId":{"type":"string","description":"Key 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:browsercat/usage-list-aggregate-account-usage":{"get":{"operationId":"open_data_browsercat_usage_list_aggregate_account_usage","summary":"List aggregate account usage","description":"GET /usage/buckets","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limit the number of results","schema":{"type":"integer","default":100,"description":"Limit the number of results"}},{"name":"offset","in":"query","required":false,"description":"Offset the returned results by this many","schema":{"type":"string","default":0,"description":"Offset the returned results by this many"}},{"name":"afterDate","in":"query","required":false,"description":"Only return results after this date (inclusive)","schema":{"type":"string","description":"Only return results after this date (inclusive)"}},{"name":"beforeDate","in":"query","required":false,"description":"Only return results before this date (exclusive)","schema":{"type":"string","description":"Only return results before this date (exclusive)"}},{"name":"unit","in":"query","required":false,"schema":{"type":"string","enum":["minute","hour","day","week"]}},{"name":"userId","in":"query","required":false,"schema":{"type":"string"}},{"name":"keyId","in":"query","required":false,"schema":{"type":"string"}},{"name":"method","in":"query","required":false,"schema":{"type":"string","enum":["api","ws"]}},{"name":"endpoint","in":"query","required":false,"schema":{"type":"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:browsercat/usage-get-session-range":{"get":{"operationId":"open_data_browsercat_usage_get_session_range","summary":"List sessions within range","description":"GET /usage/sessions","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limit the number of results","schema":{"type":"integer","default":100,"description":"Limit the number of results"}},{"name":"offset","in":"query","required":false,"description":"Offset the returned results by this many","schema":{"type":"string","default":0,"description":"Offset the returned results by this many"}},{"name":"afterDate","in":"query","required":false,"description":"Only return results after this date (inclusive)","schema":{"type":"string","description":"Only return results after this date (inclusive)"}},{"name":"beforeDate","in":"query","required":false,"description":"Only return results before this date (exclusive)","schema":{"type":"string","description":"Only return results before this date (exclusive)"}}],"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:browsercat/usage-get-request-data":{"get":{"operationId":"open_data_browsercat_usage_get_request_data","summary":"Retrieve data for a request","description":"GET /usage/sessions/{sessionId}","tags":["open-data"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"UsageSession ID","schema":{"type":"string","description":"UsageSession 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:browsercat/usage-list-request-events":{"get":{"operationId":"open_data_browsercat_usage_list_request_events","summary":"List events for a request","description":"GET /usage/sessions/{sessionId}/events","tags":["open-data"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"UsageSession ID","schema":{"type":"string","description":"UsageSession ID"}},{"name":"limit","in":"query","required":false,"description":"Limit the number of results","schema":{"type":"integer","default":100,"description":"Limit the number of results"}},{"name":"offset","in":"query","required":false,"description":"Offset the returned results by this many","schema":{"type":"string","default":0,"description":"Offset the returned results by this many"}},{"name":"afterDate","in":"query","required":false,"description":"Only return results after this date (inclusive)","schema":{"type":"string","description":"Only return results after this date (inclusive)"}},{"name":"beforeDate","in":"query","required":false,"description":"Only return results before this date (exclusive)","schema":{"type":"string","description":"Only return results before this date (exclusive)"}}],"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:browsercat/usage-get-event-data":{"get":{"operationId":"open_data_browsercat_usage_get_event_data","summary":"Retrieve data for an event","description":"GET /usage/sessions/{sessionId}/events/{eventId}","tags":["open-data"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"UsageSession ID","schema":{"type":"string","description":"UsageSession ID"}},{"name":"eventId","in":"query","required":true,"description":"UsageEvent ID","schema":{"type":"string","description":"UsageEvent 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:browsercat/billing-list-subscriptions-within-range":{"get":{"operationId":"open_data_browsercat_billing_list_subscriptions_within_range","summary":"List subscriptions within range","description":"GET /billing/subscriptions","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limit the number of results","schema":{"type":"integer","default":100,"description":"Limit the number of results"}},{"name":"offset","in":"query","required":false,"description":"Offset the returned results by this many","schema":{"type":"string","default":0,"description":"Offset the returned results by this many"}},{"name":"afterDate","in":"query","required":false,"description":"Only return results after this date (inclusive)","schema":{"type":"string","description":"Only return results after this date (inclusive)"}},{"name":"beforeDate","in":"query","required":false,"description":"Only return results before this date (exclusive)","schema":{"type":"string","description":"Only return results before this date (exclusive)"}}],"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:browsercat/billing-get-active-subscription":{"get":{"operationId":"open_data_browsercat_billing_get_active_subscription","summary":"Get active subscription","description":"GET /billing/subscriptions/current","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:browsercat/billing-get-specific-subscription":{"get":{"operationId":"open_data_browsercat_billing_get_specific_subscription","summary":"Get specific subscription","description":"GET /billing/subscriptions/{subId}","tags":["open-data"],"parameters":[{"name":"subId","in":"query","required":true,"description":"Subscription ID","schema":{"type":"string","description":"Subscription 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:browsercat/billing-list-invoices-range":{"get":{"operationId":"open_data_browsercat_billing_list_invoices_range","summary":"List invoices within range","description":"GET /billing/invoices","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limit the number of results","schema":{"type":"integer","default":100,"description":"Limit the number of results"}},{"name":"offset","in":"query","required":false,"description":"Offset the returned results by this many","schema":{"type":"string","default":0,"description":"Offset the returned results by this many"}},{"name":"afterDate","in":"query","required":false,"description":"Only return results after this date (inclusive)","schema":{"type":"string","description":"Only return results after this date (inclusive)"}},{"name":"beforeDate","in":"query","required":false,"description":"Only return results before this date (exclusive)","schema":{"type":"string","description":"Only return results before this date (exclusive)"}}],"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:browsercat/billing-get-specific-invoice":{"get":{"operationId":"open_data_browsercat_billing_get_specific_invoice","summary":"Get specific invoice","description":"GET /billing/invoices/{invId}","tags":["open-data"],"parameters":[{"name":"invId","in":"query","required":true,"description":"Invoice ID","schema":{"type":"string","description":"Invoice 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:browsercat/billing-get-invoice-pdf":{"get":{"operationId":"open_data_browsercat_billing_get_invoice_pdf","summary":"Get PDF receipt for specific invoice","description":"GET /billing/invoices/{invId}.pdf","tags":["open-data"],"parameters":[{"name":"invId","in":"query","required":true,"description":"Invoice ID","schema":{"type":"string","description":"Invoice 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"}}},"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"}}}}}}}