{"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/dev-tools:carbone/get-render-render-id":{"get":{"operationId":"dev_tools_carbone_get_render_render_id","summary":"Retreive a generated document from a render ID.","description":"GET /render/{renderId}","tags":["dev-tools"],"parameters":[{"name":"renderId","in":"query","required":true,"description":"Unique identifier of the report","schema":{"type":"string","description":"Unique identifier of the report"}},{"name":"carbone-version","in":"query","required":true,"description":"Carbone version","schema":{"type":"integer","default":4,"description":"Carbone version"}}],"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/dev-tools:carbone/post-render-template-id":{"post":{"operationId":"dev_tools_carbone_post_render_template_id","summary":"Generate a document from a template ID, and a JSON data-set","description":"POST /render/{templateId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId","carbone-version","body"],"properties":{"templateId":{"type":"string","description":"Unique identifier of the template"},"carbone-version":{"type":"integer","default":4,"description":"Carbone version"},"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/dev-tools:carbone/get-status":{"get":{"operationId":"dev_tools_carbone_get_status","summary":"Fetch the API status and version","description":"GET /status","tags":["dev-tools"],"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/dev-tools:carbone/post-template":{"post":{"operationId":"dev_tools_carbone_post_template","summary":"Upload a template.","description":"POST /template","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carbone-version","body"],"properties":{"carbone-version":{"type":"integer","default":4,"description":"Carbone version"},"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/dev-tools:carbone/get-template-template-id":{"get":{"operationId":"dev_tools_carbone_get_template_template_id","summary":"Download a template from a template ID","description":"GET /template/{templateId}","tags":["dev-tools"],"parameters":[{"name":"templateId","in":"query","required":true,"description":"Unique identifier of the template","schema":{"type":"string","description":"Unique identifier of the template"}},{"name":"carbone-version","in":"query","required":true,"description":"Carbone version","schema":{"type":"integer","default":4,"description":"Carbone version"}}],"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/dev-tools:carbone/delete-template-template-id":{"post":{"operationId":"dev_tools_carbone_delete_template_template_id","summary":"Delete a template from a template ID","description":"DELETE /template/{templateId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId","carbone-version"],"properties":{"templateId":{"type":"string","description":"Unique identifier of the template"},"carbone-version":{"type":"integer","default":4,"description":"Carbone version"}}}}}},"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"}}}}}}}