{"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:multiwoven/models-list-all-models":{"get":{"operationId":"open_data_multiwoven_models_list_all_models","summary":"Lists all models","description":"GET /api/v1/models","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:multiwoven/models-create-model":{"post":{"operationId":"open_data_multiwoven_models_create_model","summary":"Creates a model","description":"POST /api/v1/models","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":"byok"}},"/v1/open-data:multiwoven/models-get-by-id":{"get":{"operationId":"open_data_multiwoven_models_get_by_id","summary":"Retrieves a model","description":"GET /api/v1/models/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer"}}],"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:multiwoven/models-update-model-by-id":{"post":{"operationId":"open_data_multiwoven_models_update_model_by_id","summary":"Updates a model","description":"PUT /api/v1/models/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer"},"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:multiwoven/models-delete-model":{"post":{"operationId":"open_data_multiwoven_models_delete_model","summary":"Deletes a model","description":"DELETE /api/v1/models/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer"}}}}}},"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:multiwoven/connector-definitions-get-based-on-type":{"get":{"operationId":"open_data_multiwoven_connector_definitions_get_based_on_type","summary":"Retrieve connector definitions based on type","description":"GET /api/v1/connector_definitions","tags":["open-data"],"parameters":[{"name":"type","in":"query","required":true,"description":"Type of the connector (source or destination)","schema":{"type":"string","enum":["source","destination"],"description":"Type of the connector (source or destination)"}}],"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:multiwoven/connector-definitions-get-by-name":{"get":{"operationId":"open_data_multiwoven_connector_definitions_get_by_name","summary":"Retrieve specific connector definition based on its name","description":"GET /api/v1/connector_definitions/{connector_name}","tags":["open-data"],"parameters":[{"name":"connector_name","in":"query","required":true,"description":"Name of the connector","schema":{"type":"string","description":"Name of the connector"}},{"name":"type","in":"query","required":true,"description":"Type of the connector (source or destination)","schema":{"type":"string","enum":["source","destination"],"description":"Type of the connector (source or destination)"}}],"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:multiwoven/connector-definitions-check-connection":{"post":{"operationId":"open_data_multiwoven_connector_definitions_check_connection","summary":"Checks the connection for a specified connector definition","description":"POST /api/v1/connector_definitions/check_connection","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:multiwoven/connectors-list-all":{"get":{"operationId":"open_data_multiwoven_connectors_list_all","summary":"Lists all connectors","description":"GET /api/v1/connectors","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:multiwoven/connectors-create-new-connector":{"post":{"operationId":"open_data_multiwoven_connectors_create_new_connector","summary":"Creates a connector","description":"POST /api/v1/connectors","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:multiwoven/connectors-get-by-id":{"get":{"operationId":"open_data_multiwoven_connectors_get_by_id","summary":"Retrieves a specific connector by ID","description":"GET /api/v1/connectors/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID of the connector","schema":{"type":"string","description":"Unique ID of the connector"}}],"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:multiwoven/connectors-update-by-id":{"post":{"operationId":"open_data_multiwoven_connectors_update_by_id","summary":"Updates a specific connector by ID","description":"PUT /api/v1/connectors/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Unique ID of the connector"},"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:multiwoven/connectors-delete-by-id":{"post":{"operationId":"open_data_multiwoven_connectors_delete_by_id","summary":"Deletes a specific connector by ID","description":"DELETE /api/v1/connectors/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique ID of the connector"}}}}}},"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:multiwoven/connectors-discover-catalog-info":{"get":{"operationId":"open_data_multiwoven_connectors_discover_catalog_info","summary":"Discovers catalog information for a specified connector","description":"GET /api/v1/connectors/{id}/discover","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID of the connector","schema":{"type":"string","description":"Unique ID of the connector"}}],"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:multiwoven/connectors-query-source":{"post":{"operationId":"open_data_multiwoven_connectors_query_source","summary":"Query your source data","description":"POST /api/v1/connectors/{id}/query_source","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The ID of the connector to query"},"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:multiwoven/syncs-list-operations":{"get":{"operationId":"open_data_multiwoven_syncs_list_operations","summary":"List all sync operations","description":"GET /api/v1/syncs","tags":["open-data"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer","description":"Page number for pagination"}},{"name":"page[size]","in":"query","required":false,"description":"Number of items per page for pagination","schema":{"type":"integer","description":"Number of items per page for pagination"}}],"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:multiwoven/syncs-create-new-sync-operation":{"post":{"operationId":"open_data_multiwoven_syncs_create_new_sync_operation","summary":"Create a new sync operation","description":"POST /api/v1/syncs","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:multiwoven/syncs-show-details":{"get":{"operationId":"open_data_multiwoven_syncs_show_details","summary":"Show details of a specific sync operation","description":"GET /api/v1/syncs/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"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:multiwoven/syncs-update-specific-sync":{"post":{"operationId":"open_data_multiwoven_syncs_update_specific_sync","summary":"Update a specific sync operation","description":"PUT /api/v1/syncs/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"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:multiwoven/syncs-delete-sync-operation":{"post":{"operationId":"open_data_multiwoven_syncs_delete_sync_operation","summary":"Delete a specific sync operation","description":"DELETE /api/v1/syncs/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the sync operation to delete"}}}}}},"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:multiwoven/syncs-get-report-data":{"get":{"operationId":"open_data_multiwoven_syncs_get_report_data","summary":"Get report data based on given type","description":"GET /api/v1/syncs/configurations","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:multiwoven/reports-get-data-based-on-type":{"get":{"operationId":"open_data_multiwoven_reports_get_data_based_on_type","summary":"Get report data based on given type","description":"GET /api/v1/reports","tags":["open-data"],"parameters":[{"name":"type","in":"query","required":true,"description":"Type of the report to query.","schema":{"type":"string","enum":["workspace_activity"],"description":"Type of the report to query."}},{"name":"metric","in":"query","required":false,"description":"Specific metric of interest in the report.","schema":{"type":"string","enum":["sync_run_triggered","total_sync_run_rows","all"],"description":"Specific metric of interest in the report."}},{"name":"connector_ids","in":"query","required":false,"description":"IDs of the connectors.","schema":{"type":"array","description":"IDs of the connectors."}},{"name":"time_period","in":"query","required":false,"description":"Time period for the report.","schema":{"type":"string","enum":["one_week","one_day"],"description":"Time period for the report."}}],"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:multiwoven/sync-runs-list-by-sync-id":{"get":{"operationId":"open_data_multiwoven_sync_runs_list_by_sync_id","summary":"List sync runs for a specific sync","description":"GET /api/v1/syncs/{sync_id}/sync_runs","tags":["open-data"],"parameters":[{"name":"sync_id","in":"query","required":true,"description":"The ID of the sync to list runs for.","schema":{"type":"integer","description":"The ID of the sync to list runs for."}},{"name":"status","in":"query","required":false,"description":"Optional status to filter the sync runs by.","schema":{"type":"string","description":"Optional status to filter the sync runs by."}},{"name":"page","in":"query","required":false,"description":"Page number for pagination.","schema":{"type":"integer","description":"Page number for pagination."}}],"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:multiwoven/sync-run-get-details-by-sync-run-id":{"get":{"operationId":"open_data_multiwoven_sync_run_get_details_by_sync_run_id","summary":"Get sync run using sync_run_id for a specific sync","description":"GET /api/v1/syncs/{sync_id}/sync_runs/{sync_run_id}","tags":["open-data"],"parameters":[{"name":"sync_id","in":"query","required":true,"description":"The ID of the sync.","schema":{"type":"integer","description":"The ID of the sync."}},{"name":"sync_run_id","in":"query","required":true,"description":"The ID of the sync_run.","schema":{"type":"integer","description":"The ID of the sync_run."}}],"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:multiwoven/sync-records-list-for-sync-run":{"get":{"operationId":"open_data_multiwoven_sync_records_list_for_sync_run","summary":"List sync records for a specific sync run","description":"GET /api/v1/syncs/{sync_id}/sync_runs/{sync_run_id}/sync_records","tags":["open-data"],"parameters":[{"name":"sync_id","in":"query","required":true,"description":"The ID of the sync to list records for.","schema":{"type":"integer","description":"The ID of the sync to list records for."}},{"name":"sync_run_id","in":"query","required":true,"description":"The ID of the sync run to list records for.","schema":{"type":"integer","description":"The ID of the sync run to list records for."}},{"name":"status","in":"query","required":false,"description":"Optional status to filter the sync records by.","schema":{"type":"string","description":"Optional status to filter the sync records by."}},{"name":"page","in":"query","required":false,"description":"Page number for pagination.","schema":{"type":"integer","description":"Page number for pagination."}}],"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"}}}}}}}